Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,11 @@ run();
* [deleteAgreement](docs/sdks/agreements/README.md#deleteagreement) - Delete a specific agreement
* [createAgreementSummary](docs/sdks/agreements/README.md#createagreementsummary) - Create an AI-generated summary of an agreement document

#### [workspaces.workspaceBrands](docs/sdks/workspacebrands/README.md)

* [getWorkspaceBrand](docs/sdks/workspacebrands/README.md#getworkspacebrand) - Returns details about the brand set for a workspace
* [updateWorkspaceBrand](docs/sdks/workspacebrands/README.md#updateworkspacebrand) - Updates brand for an existing workspace

#### [workspaces.workspaceDocuments](docs/sdks/workspacedocuments/README.md)

* [getWorkspaceDocuments](docs/sdks/workspacedocuments/README.md#getworkspacedocuments) - Get documents in the workspace accessible to the calling user
Expand All @@ -223,6 +228,7 @@ run();

* [getWorkspaces](docs/sdks/workspaces2/README.md#getworkspaces) - Gets workspaces available to the calling user
* [createWorkspace](docs/sdks/workspaces2/README.md#createworkspace) - Creates a new workspace
* [updateWorkspace](docs/sdks/workspaces2/README.md#updateworkspace) - Updates an existing workspace
* [getWorkspace](docs/sdks/workspaces2/README.md#getworkspace) - Returns details about the workspace
* [getWorkspaceAssignableRoles](docs/sdks/workspaces2/README.md#getworkspaceassignableroles) - Returns the roles the caller can assign to workspace users
* [createWorkspaceEnvelope](docs/sdks/workspaces2/README.md#createworkspaceenvelope) - Creates an envelope with the given documents. Returns the ID of the created envelope
Expand Down Expand Up @@ -282,6 +288,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`navigatorAgreementsDeleteAgreement`](docs/sdks/agreements/README.md#deleteagreement) - Delete a specific agreement
- [`navigatorAgreementsGetAgreement`](docs/sdks/agreements/README.md#getagreement) - Retrieve detailed information about a specific agreement
- [`navigatorAgreementsGetAgreementsList`](docs/sdks/agreements/README.md#getagreementslist) - Retrieve a list of agreements
- [`workspacesWorkspaceBrandsGetWorkspaceBrand`](docs/sdks/workspacebrands/README.md#getworkspacebrand) - Returns details about the brand set for a workspace
- [`workspacesWorkspaceBrandsUpdateWorkspaceBrand`](docs/sdks/workspacebrands/README.md#updateworkspacebrand) - Updates brand for an existing workspace
- [`workspacesWorkspaceDocumentsAddWorkspaceDocument`](docs/sdks/workspacedocuments/README.md#addworkspacedocument) - Add a document to a workspace via file contents upload
- [`workspacesWorkspaceDocumentsDeleteWorkspaceDocument`](docs/sdks/workspacedocuments/README.md#deleteworkspacedocument) - Deletes a document in the workspace
- [`workspacesWorkspaceDocumentsGetWorkspaceDocument`](docs/sdks/workspacedocuments/README.md#getworkspacedocument) - Get information about the document
Expand All @@ -293,6 +301,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`workspacesWorkspacesGetWorkspaceAssignableRoles`](docs/sdks/workspaces2/README.md#getworkspaceassignableroles) - Returns the roles the caller can assign to workspace users
- [`workspacesWorkspacesGetWorkspaceEnvelopes`](docs/sdks/workspaces2/README.md#getworkspaceenvelopes) - Returns the envelopes associated with the given workspace
- [`workspacesWorkspacesGetWorkspaces`](docs/sdks/workspaces2/README.md#getworkspaces) - Gets workspaces available to the calling user
- [`workspacesWorkspacesUpdateWorkspace`](docs/sdks/workspaces2/README.md#updateworkspace) - Updates an existing workspace
- [`workspacesWorkspaceUploadRequestAddWorkspaceUploadRequestDocument`](docs/sdks/workspaceuploadrequest/README.md#addworkspaceuploadrequestdocument) - Add a document to an upload request via file upload
- [`workspacesWorkspaceUploadRequestCompleteWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#completeworkspaceuploadrequest) - Complete an upload request
- [`workspacesWorkspaceUploadRequestCreateWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#createworkspaceuploadrequest) - Creates a new upload request within a workspace
Expand Down Expand Up @@ -484,9 +493,9 @@ run();


**Inherit from [`IamClientError`](./src/models/errors/iamclienterror.ts)**:
* [`ErrorDetails`](./src/models/errors/errordetails.ts): The error response object for the Workspaces API. Applicable to 23 of 41 methods.*
* [`ErrorT`](./src/models/errors/errort.ts): Bad Request - The request could not be understood or was missing required parameters. Applicable to 11 of 41 methods.*
* [`OAuthErrorResponse`](./src/models/errors/oautherrorresponse.ts): Status code `400`. Applicable to 5 of 41 methods.*
* [`ErrorDetails`](./src/models/errors/errordetails.ts): The error response object for the Workspaces API. Applicable to 26 of 44 methods.*
* [`ErrorT`](./src/models/errors/errort.ts): Bad Request - The request could not be understood or was missing required parameters. Applicable to 11 of 44 methods.*
* [`OAuthErrorResponse`](./src/models/errors/oautherrorresponse.ts): Status code `400`. Applicable to 5 of 44 methods.*
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.

</details>
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,14 @@ Based on:
### Generated
- [typescript v1.0.0-beta.5] .
### Releases
- [NPM v1.0.0-beta.5] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.5 - .
- [NPM v1.0.0-beta.5] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.5 - .

## 2025-10-17 12:40:15
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.637.0 (2.727.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v1.0.0-beta.6] .
### Releases
- [NPM v1.0.0-beta.6] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.6 - .
16 changes: 16 additions & 0 deletions docs/models/components/brandcolor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# BrandColor

## Example Usage

```typescript
import { BrandColor } from "@docusign/iam-sdk/models/components";

let value: BrandColor = {};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `name` | *string* | :heavy_minus_sign: | N/A |
| `value` | *string* | :heavy_minus_sign: | N/A |
17 changes: 17 additions & 0 deletions docs/models/components/brandlogos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# BrandLogos

## Example Usage

```typescript
import { BrandLogos } from "@docusign/iam-sdk/models/components";

let value: BrandLogos = {};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `primary` | *string* | :heavy_minus_sign: | N/A |
| `secondary` | *string* | :heavy_minus_sign: | N/A |
| `email` | *string* | :heavy_minus_sign: | N/A |
35 changes: 35 additions & 0 deletions docs/models/components/getworkspacebrandresponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# GetWorkspaceBrandResponse

The details of a single workspace brand

## Example Usage

```typescript
import { GetWorkspaceBrandResponse } from "@docusign/iam-sdk/models/components";

let value: GetWorkspaceBrandResponse = {
colors: [
{},
],
brandLanguages: [
"<value 1>",
],
};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `brandId` | *string* | :heavy_minus_sign: | N/A |
| `brandName` | *string* | :heavy_minus_sign: | N/A |
| `brandCompany` | *string* | :heavy_minus_sign: | N/A |
| `colors` | [components.BrandColor](../../models/components/brandcolor.md)[] | :heavy_check_mark: | N/A |
| `logos` | [components.BrandLogos](../../models/components/brandlogos.md) | :heavy_minus_sign: | N/A |
| `brandLanguages` | *string*[] | :heavy_check_mark: | N/A |
| `defaultBrandLanguage` | *string* | :heavy_minus_sign: | N/A |
| `isSendingDefault` | *boolean* | :heavy_minus_sign: | N/A |
| `isSigningDefault` | *boolean* | :heavy_minus_sign: | N/A |
| `primaryLogoId` | *string* | :heavy_minus_sign: | N/A |
| `secondaryLogoId` | *string* | :heavy_minus_sign: | N/A |
| `emailLogoId` | *string* | :heavy_minus_sign: | N/A |
4 changes: 2 additions & 2 deletions docs/models/components/getworkspaceuploadrequestresponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ let value: GetWorkspaceUploadRequestResponse = {
status: "unknown",
documents: [],
assignments: null,
createdDate: new Date("2023-05-03T09:49:49.817Z"),
updatedDate: new Date("2025-01-27T12:20:15.711Z"),
createdDate: new Date("2025-01-27T12:20:15.711Z"),

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why created date is getting updated? and also should not be updated date is the current date ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These examples are part of provided swagger files by api team. They might have just updates the examples during testing

updatedDate: new Date("2023-03-28T23:33:43.926Z"),
canView: true,
canEdit: true,
canDelete: true,
Expand Down
17 changes: 17 additions & 0 deletions docs/models/components/updateworkspacebody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# UpdateWorkspaceBody

## Example Usage

```typescript
import { UpdateWorkspaceBody } from "@docusign/iam-sdk/models/components";

let value: UpdateWorkspaceBody = {
name: null,
};
```

## Fields

| Field | Type | Required | Description |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `name` | *string* | :heavy_check_mark: | The updated name of the workspace |
15 changes: 15 additions & 0 deletions docs/models/components/updateworkspacebrandbody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# UpdateWorkspaceBrandBody

## Example Usage

```typescript
import { UpdateWorkspaceBrandBody } from "@docusign/iam-sdk/models/components";

let value: UpdateWorkspaceBrandBody = {};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `brandId` | *string* | :heavy_minus_sign: | A GUID value that identifies a brand. For more information, see <a href="https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/branding/">Branding</a> |
37 changes: 37 additions & 0 deletions docs/models/components/updateworkspacebrandresponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# UpdateWorkspaceBrandResponse

The brand details set for a workspace

## Example Usage

```typescript
import { UpdateWorkspaceBrandResponse } from "@docusign/iam-sdk/models/components";

let value: UpdateWorkspaceBrandResponse = {
colors: [
{},
],
brandLanguages: [
"<value 1>",
"<value 2>",
"<value 3>",
],
};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `brandId` | *string* | :heavy_minus_sign: | N/A |
| `brandName` | *string* | :heavy_minus_sign: | N/A |
| `brandCompany` | *string* | :heavy_minus_sign: | N/A |
| `colors` | [components.BrandColor](../../models/components/brandcolor.md)[] | :heavy_check_mark: | N/A |
| `logos` | [components.BrandLogos](../../models/components/brandlogos.md) | :heavy_minus_sign: | N/A |
| `brandLanguages` | *string*[] | :heavy_check_mark: | N/A |
| `defaultBrandLanguage` | *string* | :heavy_minus_sign: | N/A |
| `isSendingDefault` | *boolean* | :heavy_minus_sign: | N/A |
| `isSigningDefault` | *boolean* | :heavy_minus_sign: | N/A |
| `primaryLogoId` | *string* | :heavy_minus_sign: | N/A |
| `secondaryLogoId` | *string* | :heavy_minus_sign: | N/A |
| `emailLogoId` | *string* | :heavy_minus_sign: | N/A |
Loading