Skip to content

Commit 2da2c45

Browse files
Merge pull request #9 from docusign/sdk-update-typescript-1.0.0-beta.6
Update typescript SDK
2 parents 7dc9cd7 + 8eb5a52 commit 2da2c45

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+2187
-49
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,11 @@ run();
211211
* [deleteAgreement](docs/sdks/agreements/README.md#deleteagreement) - Delete a specific agreement
212212
* [createAgreementSummary](docs/sdks/agreements/README.md#createagreementsummary) - Create an AI-generated summary of an agreement document
213213

214+
#### [workspaces.workspaceBrands](docs/sdks/workspacebrands/README.md)
215+
216+
* [getWorkspaceBrand](docs/sdks/workspacebrands/README.md#getworkspacebrand) - Returns details about the brand set for a workspace
217+
* [updateWorkspaceBrand](docs/sdks/workspacebrands/README.md#updateworkspacebrand) - Updates brand for an existing workspace
218+
214219
#### [workspaces.workspaceDocuments](docs/sdks/workspacedocuments/README.md)
215220

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

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

485494

486495
**Inherit from [`IamClientError`](./src/models/errors/iamclienterror.ts)**:
487-
* [`ErrorDetails`](./src/models/errors/errordetails.ts): The error response object for the Workspaces API. Applicable to 23 of 41 methods.*
488-
* [`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.*
489-
* [`OAuthErrorResponse`](./src/models/errors/oautherrorresponse.ts): Status code `400`. Applicable to 5 of 41 methods.*
496+
* [`ErrorDetails`](./src/models/errors/errordetails.ts): The error response object for the Workspaces API. Applicable to 26 of 44 methods.*
497+
* [`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.*
498+
* [`OAuthErrorResponse`](./src/models/errors/oautherrorresponse.ts): Status code `400`. Applicable to 5 of 44 methods.*
490499
* [`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.
491500

492501
</details>

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,14 @@ Based on:
6868
### Generated
6969
- [typescript v1.0.0-beta.5] .
7070
### Releases
71-
- [NPM v1.0.0-beta.5] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.5 - .
71+
- [NPM v1.0.0-beta.5] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.5 - .
72+
73+
## 2025-10-17 12:40:15
74+
### Changes
75+
Based on:
76+
- OpenAPI Doc
77+
- Speakeasy CLI 1.637.0 (2.727.4) https://github.com/speakeasy-api/speakeasy
78+
### Generated
79+
- [typescript v1.0.0-beta.6] .
80+
### Releases
81+
- [NPM v1.0.0-beta.6] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.6 - .
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# BrandColor
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { BrandColor } from "@docusign/iam-sdk/models/components";
7+
8+
let value: BrandColor = {};
9+
```
10+
11+
## Fields
12+
13+
| Field | Type | Required | Description |
14+
| ------------------ | ------------------ | ------------------ | ------------------ |
15+
| `name` | *string* | :heavy_minus_sign: | N/A |
16+
| `value` | *string* | :heavy_minus_sign: | N/A |
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# BrandLogos
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { BrandLogos } from "@docusign/iam-sdk/models/components";
7+
8+
let value: BrandLogos = {};
9+
```
10+
11+
## Fields
12+
13+
| Field | Type | Required | Description |
14+
| ------------------ | ------------------ | ------------------ | ------------------ |
15+
| `primary` | *string* | :heavy_minus_sign: | N/A |
16+
| `secondary` | *string* | :heavy_minus_sign: | N/A |
17+
| `email` | *string* | :heavy_minus_sign: | N/A |
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# GetWorkspaceBrandResponse
2+
3+
The details of a single workspace brand
4+
5+
## Example Usage
6+
7+
```typescript
8+
import { GetWorkspaceBrandResponse } from "@docusign/iam-sdk/models/components";
9+
10+
let value: GetWorkspaceBrandResponse = {
11+
colors: [
12+
{},
13+
],
14+
brandLanguages: [
15+
"<value 1>",
16+
],
17+
};
18+
```
19+
20+
## Fields
21+
22+
| Field | Type | Required | Description |
23+
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
24+
| `brandId` | *string* | :heavy_minus_sign: | N/A |
25+
| `brandName` | *string* | :heavy_minus_sign: | N/A |
26+
| `brandCompany` | *string* | :heavy_minus_sign: | N/A |
27+
| `colors` | [components.BrandColor](../../models/components/brandcolor.md)[] | :heavy_check_mark: | N/A |
28+
| `logos` | [components.BrandLogos](../../models/components/brandlogos.md) | :heavy_minus_sign: | N/A |
29+
| `brandLanguages` | *string*[] | :heavy_check_mark: | N/A |
30+
| `defaultBrandLanguage` | *string* | :heavy_minus_sign: | N/A |
31+
| `isSendingDefault` | *boolean* | :heavy_minus_sign: | N/A |
32+
| `isSigningDefault` | *boolean* | :heavy_minus_sign: | N/A |
33+
| `primaryLogoId` | *string* | :heavy_minus_sign: | N/A |
34+
| `secondaryLogoId` | *string* | :heavy_minus_sign: | N/A |
35+
| `emailLogoId` | *string* | :heavy_minus_sign: | N/A |

docs/models/components/getworkspaceuploadrequestresponse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ let value: GetWorkspaceUploadRequestResponse = {
1717
status: "unknown",
1818
documents: [],
1919
assignments: null,
20-
createdDate: new Date("2023-05-03T09:49:49.817Z"),
21-
updatedDate: new Date("2025-01-27T12:20:15.711Z"),
20+
createdDate: new Date("2025-01-27T12:20:15.711Z"),
21+
updatedDate: new Date("2023-03-28T23:33:43.926Z"),
2222
canView: true,
2323
canEdit: true,
2424
canDelete: true,
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# UpdateWorkspaceBody
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { UpdateWorkspaceBody } from "@docusign/iam-sdk/models/components";
7+
8+
let value: UpdateWorkspaceBody = {
9+
name: null,
10+
};
11+
```
12+
13+
## Fields
14+
15+
| Field | Type | Required | Description |
16+
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
17+
| `name` | *string* | :heavy_check_mark: | The updated name of the workspace |
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# UpdateWorkspaceBrandBody
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { UpdateWorkspaceBrandBody } from "@docusign/iam-sdk/models/components";
7+
8+
let value: UpdateWorkspaceBrandBody = {};
9+
```
10+
11+
## Fields
12+
13+
| Field | Type | Required | Description |
14+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15+
| `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> |
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# UpdateWorkspaceBrandResponse
2+
3+
The brand details set for a workspace
4+
5+
## Example Usage
6+
7+
```typescript
8+
import { UpdateWorkspaceBrandResponse } from "@docusign/iam-sdk/models/components";
9+
10+
let value: UpdateWorkspaceBrandResponse = {
11+
colors: [
12+
{},
13+
],
14+
brandLanguages: [
15+
"<value 1>",
16+
"<value 2>",
17+
"<value 3>",
18+
],
19+
};
20+
```
21+
22+
## Fields
23+
24+
| Field | Type | Required | Description |
25+
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
26+
| `brandId` | *string* | :heavy_minus_sign: | N/A |
27+
| `brandName` | *string* | :heavy_minus_sign: | N/A |
28+
| `brandCompany` | *string* | :heavy_minus_sign: | N/A |
29+
| `colors` | [components.BrandColor](../../models/components/brandcolor.md)[] | :heavy_check_mark: | N/A |
30+
| `logos` | [components.BrandLogos](../../models/components/brandlogos.md) | :heavy_minus_sign: | N/A |
31+
| `brandLanguages` | *string*[] | :heavy_check_mark: | N/A |
32+
| `defaultBrandLanguage` | *string* | :heavy_minus_sign: | N/A |
33+
| `isSendingDefault` | *boolean* | :heavy_minus_sign: | N/A |
34+
| `isSigningDefault` | *boolean* | :heavy_minus_sign: | N/A |
35+
| `primaryLogoId` | *string* | :heavy_minus_sign: | N/A |
36+
| `secondaryLogoId` | *string* | :heavy_minus_sign: | N/A |
37+
| `emailLogoId` | *string* | :heavy_minus_sign: | N/A |

0 commit comments

Comments
 (0)