Skip to content

Commit 8bb0f11

Browse files
prudhvik-docusignprudhvik-docusign
authored
Merge pull request #4 from docusign/sdk-update-typescript-1.0.0-beta.4
Update typescript SDK
2 parents 28254cd + cfbcdf6 commit 8bb0f11

File tree

169 files changed

+13689
-52
lines changed

Some content is hidden

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

169 files changed

+13689
-52
lines changed

‎README.md‎

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,42 @@ run();
222222
* [deleteAgreement](docs/sdks/agreements/README.md#deleteagreement) - Delete a specific agreement
223223
* [createAgreementSummary](docs/sdks/agreements/README.md#createagreementsummary) - Create an AI-generated summary of an agreement document
224224

225+
### [workspaces](docs/sdks/workspaces1/README.md)
226+
227+
228+
#### [workspaces.workspaceDocuments](docs/sdks/workspacedocuments/README.md)
229+
230+
* [getWorkspaceDocuments](docs/sdks/workspacedocuments/README.md#getworkspacedocuments) - Get documents in the workspace accessible to the calling user
231+
* [getWorkspaceDocument](docs/sdks/workspacedocuments/README.md#getworkspacedocument) - Get information about the document
232+
* [deleteWorkspaceDocument](docs/sdks/workspacedocuments/README.md#deleteworkspacedocument) - Deletes a document in the workspace
233+
* [getWorkspaceDocumentContents](docs/sdks/workspacedocuments/README.md#getworkspacedocumentcontents) - Get the file contents of the document
234+
235+
#### [workspaces.workspaces](docs/sdks/workspaces2/README.md)
236+
237+
* [getWorkspaces](docs/sdks/workspaces2/README.md#getworkspaces) - Gets workspaces available to the calling user
238+
* [createWorkspace](docs/sdks/workspaces2/README.md#createworkspace) - Creates a new workspace
239+
* [getWorkspace](docs/sdks/workspaces2/README.md#getworkspace) - Returns details about the workspace
240+
* [getWorkspaceAssignableRoles](docs/sdks/workspaces2/README.md#getworkspaceassignableroles) - Returns the roles the caller can assign to workspace users
241+
* [createWorkspaceEnvelope](docs/sdks/workspaces2/README.md#createworkspaceenvelope) - Creates an envelope with the given documents. Returns the ID of the created envelope
242+
* [getWorkspaceEnvelopes](docs/sdks/workspaces2/README.md#getworkspaceenvelopes) - Returns the envelopes associated with the given workspace
243+
244+
#### [workspaces.workspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md)
245+
246+
* [createWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#createworkspaceuploadrequest) - Creates a new upload request within a workspace
247+
* [getWorkspaceUploadRequests](docs/sdks/workspaceuploadrequest/README.md#getworkspaceuploadrequests) - Gets upload requests within a workspace
248+
* [getWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#getworkspaceuploadrequest) - Gets details for a specific upload request
249+
* [updateWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#updateworkspaceuploadrequest) - Updates a specific upload request
250+
* [deleteWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#deleteworkspaceuploadrequest) - Deletes a specific upload request
251+
* [completeWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#completeworkspaceuploadrequest) - Complete an upload request
252+
253+
#### [workspaces.workspaceUsers](docs/sdks/workspaceusers/README.md)
254+
255+
* [getWorkspaceUsers](docs/sdks/workspaceusers/README.md#getworkspaceusers) - Retrieves the list of users in the given workspace
256+
* [addWorkspaceUser](docs/sdks/workspaceusers/README.md#addworkspaceuser) - Adds a user to the workspace by email address
257+
* [updateWorkspaceUser](docs/sdks/workspaceusers/README.md#updateworkspaceuser) - Updates the specified user's role
258+
* [revokeWorkspaceUserAccess](docs/sdks/workspaceusers/README.md#revokeworkspaceuseraccess) - Revokes the specified user's access to the workspace
259+
* [restoreWorkspaceUserAccess](docs/sdks/workspaceusers/README.md#restoreworkspaceuseraccess) - Restores the specified user's access to the workspace
260+
225261
</details>
226262
<!-- End Available Resources and Operations [operations] -->
227263

@@ -258,6 +294,27 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
258294
- [`navigatorAgreementsDeleteAgreement`](docs/sdks/agreements/README.md#deleteagreement) - Delete a specific agreement
259295
- [`navigatorAgreementsGetAgreement`](docs/sdks/agreements/README.md#getagreement) - Retrieve detailed information about a specific agreement
260296
- [`navigatorAgreementsGetAgreementsList`](docs/sdks/agreements/README.md#getagreementslist) - Retrieve a list of agreements
297+
- [`workspacesWorkspaceDocumentsDeleteWorkspaceDocument`](docs/sdks/workspacedocuments/README.md#deleteworkspacedocument) - Deletes a document in the workspace
298+
- [`workspacesWorkspaceDocumentsGetWorkspaceDocument`](docs/sdks/workspacedocuments/README.md#getworkspacedocument) - Get information about the document
299+
- [`workspacesWorkspaceDocumentsGetWorkspaceDocumentContents`](docs/sdks/workspacedocuments/README.md#getworkspacedocumentcontents) - Get the file contents of the document
300+
- [`workspacesWorkspaceDocumentsGetWorkspaceDocuments`](docs/sdks/workspacedocuments/README.md#getworkspacedocuments) - Get documents in the workspace accessible to the calling user
301+
- [`workspacesWorkspacesCreateWorkspace`](docs/sdks/workspaces2/README.md#createworkspace) - Creates a new workspace
302+
- [`workspacesWorkspacesCreateWorkspaceEnvelope`](docs/sdks/workspaces2/README.md#createworkspaceenvelope) - Creates an envelope with the given documents. Returns the ID of the created envelope
303+
- [`workspacesWorkspacesGetWorkspace`](docs/sdks/workspaces2/README.md#getworkspace) - Returns details about the workspace
304+
- [`workspacesWorkspacesGetWorkspaceAssignableRoles`](docs/sdks/workspaces2/README.md#getworkspaceassignableroles) - Returns the roles the caller can assign to workspace users
305+
- [`workspacesWorkspacesGetWorkspaceEnvelopes`](docs/sdks/workspaces2/README.md#getworkspaceenvelopes) - Returns the envelopes associated with the given workspace
306+
- [`workspacesWorkspacesGetWorkspaces`](docs/sdks/workspaces2/README.md#getworkspaces) - Gets workspaces available to the calling user
307+
- [`workspacesWorkspaceUploadRequestCompleteWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#completeworkspaceuploadrequest) - Complete an upload request
308+
- [`workspacesWorkspaceUploadRequestCreateWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#createworkspaceuploadrequest) - Creates a new upload request within a workspace
309+
- [`workspacesWorkspaceUploadRequestDeleteWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#deleteworkspaceuploadrequest) - Deletes a specific upload request
310+
- [`workspacesWorkspaceUploadRequestGetWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#getworkspaceuploadrequest) - Gets details for a specific upload request
311+
- [`workspacesWorkspaceUploadRequestGetWorkspaceUploadRequests`](docs/sdks/workspaceuploadrequest/README.md#getworkspaceuploadrequests) - Gets upload requests within a workspace
312+
- [`workspacesWorkspaceUploadRequestUpdateWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#updateworkspaceuploadrequest) - Updates a specific upload request
313+
- [`workspacesWorkspaceUsersAddWorkspaceUser`](docs/sdks/workspaceusers/README.md#addworkspaceuser) - Adds a user to the workspace by email address
314+
- [`workspacesWorkspaceUsersGetWorkspaceUsers`](docs/sdks/workspaceusers/README.md#getworkspaceusers) - Retrieves the list of users in the given workspace
315+
- [`workspacesWorkspaceUsersRestoreWorkspaceUserAccess`](docs/sdks/workspaceusers/README.md#restoreworkspaceuseraccess) - Restores the specified user's access to the workspace
316+
- [`workspacesWorkspaceUsersRevokeWorkspaceUserAccess`](docs/sdks/workspaceusers/README.md#revokeworkspaceuseraccess) - Revokes the specified user's access to the workspace
317+
- [`workspacesWorkspaceUsersUpdateWorkspaceUser`](docs/sdks/workspaceusers/README.md#updateworkspaceuser) - Updates the specified user's role
261318

262319
</details>
263320
<!-- End Standalone functions [standalone-funcs] -->
@@ -388,7 +445,7 @@ run();
388445
**Primary error:**
389446
* [`IamClientError`](./src/models/errors/iamclienterror.ts): The base class for HTTP error responses.
390447

391-
<details><summary>Less common errors (8)</summary>
448+
<details><summary>Less common errors (9)</summary>
392449

393450
<br />
394451

@@ -401,8 +458,9 @@ run();
401458

402459

403460
**Inherit from [`IamClientError`](./src/models/errors/iamclienterror.ts)**:
404-
* [`ErrorT`](./src/models/errors/errort.ts): Bad Request - The request could not be understood or was missing required parameters. Applicable to 11 of 18 methods.*
405-
* [`OAuthErrorResponse`](./src/models/errors/oautherrorresponse.ts): Status code `400`. Applicable to 5 of 18 methods.*
461+
* [`ErrorDetails`](./src/models/errors/errordetails.ts): The error response object for the Workspaces API. Applicable to 21 of 39 methods.*
462+
* [`ErrorT`](./src/models/errors/errort.ts): Bad Request - The request could not be understood or was missing required parameters. Applicable to 11 of 39 methods.*
463+
* [`OAuthErrorResponse`](./src/models/errors/oautherrorresponse.ts): Status code `400`. Applicable to 5 of 39 methods.*
406464
* [`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.
407465

408466
</details>

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,14 @@ Based on:
4848
### Generated
4949
- [typescript v1.0.0-beta.3] .
5050
### Releases
51-
- [NPM v1.0.0-beta.3] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.3 - .
51+
- [NPM v1.0.0-beta.3] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.3 - .
52+
53+
## 2025-09-03 17:15:21
54+
### Changes
55+
Based on:
56+
- OpenAPI Doc
57+
- Speakeasy CLI 1.609.0 (2.692.0) https://github.com/speakeasy-api/speakeasy
58+
### Generated
59+
- [typescript v1.0.0-beta.4] .
60+
### Releases
61+
- [NPM v1.0.0-beta.4] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.4 - .

‎docs/models/components/createworkspacebody.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# CreateWorkspaceBody
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { CreateWorkspaceBody } from "@docusign/iam-sdk/models/components";
7+
8+
let value: CreateWorkspaceBody = {
9+
name: "<value>",
10+
};
11+
```
12+
13+
## Fields
14+
15+
| Field | Type | Required | Description |
16+
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17+
| `name` | *string* | :heavy_check_mark: | The name of the workspace |
18+
| `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> |

‎docs/models/components/createworkspaceenveloperesponse.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CreateWorkspaceEnvelopeResponse
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { CreateWorkspaceEnvelopeResponse } from "@docusign/iam-sdk/models/components";
7+
8+
let value: CreateWorkspaceEnvelopeResponse = {};
9+
```
10+
11+
## Fields
12+
13+
| Field | Type | Required | Description |
14+
| ------------------ | ------------------ | ------------------ | ------------------ |
15+
| `envelopeId` | *string* | :heavy_minus_sign: | N/A |

‎docs/models/components/createworkspaceresponse.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# CreateWorkspaceResponse
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { CreateWorkspaceResponse } from "@docusign/iam-sdk/models/components";
7+
8+
let value: CreateWorkspaceResponse = {};
9+
```
10+
11+
## Fields
12+
13+
| Field | Type | Required | Description |
14+
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
15+
| `workspaceId` | *string* | :heavy_minus_sign: | The ID of the workspace |
16+
| `name` | *string* | :heavy_minus_sign: | The name of the workspace |
17+
| `createdDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the workspace was created |
18+
| `createdByUserId` | *string* | :heavy_minus_sign: | The ID of the user who created the workspace |
19+
| `workspaceOwnerIds` | *string*[] | :heavy_minus_sign: | The list of user IDs of the workspace owners |

‎docs/models/components/createworkspaceuploadrequestassignment.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# CreateWorkspaceUploadRequestAssignment
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { CreateWorkspaceUploadRequestAssignment } from "@docusign/iam-sdk/models/components";
7+
8+
let value: CreateWorkspaceUploadRequestAssignment = {
9+
uploadRequestResponsibilityTypeId: "watcher",
10+
};
11+
```
12+
13+
## Fields
14+
15+
| Field | Type | Required | Description |
16+
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
17+
| `assigneeUserId` | *string* | :heavy_minus_sign: | The ID of the assigned user |
18+
| `uploadRequestResponsibilityTypeId` | [components.WorkspaceUploadRequestResponsibilityType](../../models/components/workspaceuploadrequestresponsibilitytype.md) | :heavy_check_mark: | Enum representing the responsibility type for a workspace upload request assignment |
19+
| `firstName` | *string* | :heavy_minus_sign: | The first name of the assignee |
20+
| `lastName` | *string* | :heavy_minus_sign: | The last name of the assignee |
21+
| `email` | *string* | :heavy_minus_sign: | The email of the assignee |

0 commit comments

Comments
 (0)