Skip to content

Update typescript SDK #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 9, 2025
Merged

Update typescript SDK #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
64 changes: 61 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,42 @@ 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](docs/sdks/workspaces1/README.md)


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

* [getWorkspaceDocuments](docs/sdks/workspacedocuments/README.md#getworkspacedocuments) - Get documents in the workspace accessible to the calling user
* [getWorkspaceDocument](docs/sdks/workspacedocuments/README.md#getworkspacedocument) - Get information about the document
* [deleteWorkspaceDocument](docs/sdks/workspacedocuments/README.md#deleteworkspacedocument) - Deletes a document in the workspace
* [getWorkspaceDocumentContents](docs/sdks/workspacedocuments/README.md#getworkspacedocumentcontents) - Get the file contents of the document

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

* [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
* [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
* [getWorkspaceEnvelopes](docs/sdks/workspaces2/README.md#getworkspaceenvelopes) - Returns the envelopes associated with the given workspace

#### [workspaces.workspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md)

* [createWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#createworkspaceuploadrequest) - Creates a new upload request within a workspace
* [getWorkspaceUploadRequests](docs/sdks/workspaceuploadrequest/README.md#getworkspaceuploadrequests) - Gets upload requests within a workspace
* [getWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#getworkspaceuploadrequest) - Gets details for a specific upload request
* [updateWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#updateworkspaceuploadrequest) - Updates a specific upload request
* [deleteWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#deleteworkspaceuploadrequest) - Deletes a specific upload request
* [completeWorkspaceUploadRequest](docs/sdks/workspaceuploadrequest/README.md#completeworkspaceuploadrequest) - Complete an upload request

#### [workspaces.workspaceUsers](docs/sdks/workspaceusers/README.md)

* [getWorkspaceUsers](docs/sdks/workspaceusers/README.md#getworkspaceusers) - Retrieves the list of users in the given workspace
* [addWorkspaceUser](docs/sdks/workspaceusers/README.md#addworkspaceuser) - Adds a user to the workspace by email address
* [updateWorkspaceUser](docs/sdks/workspaceusers/README.md#updateworkspaceuser) - Updates the specified user's role
* [revokeWorkspaceUserAccess](docs/sdks/workspaceusers/README.md#revokeworkspaceuseraccess) - Revokes the specified user's access to the workspace
* [restoreWorkspaceUserAccess](docs/sdks/workspaceusers/README.md#restoreworkspaceuseraccess) - Restores the specified user's access to the workspace

</details>
<!-- End Available Resources and Operations [operations] -->

Expand Down Expand Up @@ -258,6 +294,27 @@ 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
- [`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
- [`workspacesWorkspaceDocumentsGetWorkspaceDocumentContents`](docs/sdks/workspacedocuments/README.md#getworkspacedocumentcontents) - Get the file contents of the document
- [`workspacesWorkspaceDocumentsGetWorkspaceDocuments`](docs/sdks/workspacedocuments/README.md#getworkspacedocuments) - Get documents in the workspace accessible to the calling user
- [`workspacesWorkspacesCreateWorkspace`](docs/sdks/workspaces2/README.md#createworkspace) - Creates a new workspace
- [`workspacesWorkspacesCreateWorkspaceEnvelope`](docs/sdks/workspaces2/README.md#createworkspaceenvelope) - Creates an envelope with the given documents. Returns the ID of the created envelope
- [`workspacesWorkspacesGetWorkspace`](docs/sdks/workspaces2/README.md#getworkspace) - Returns details about the workspace
- [`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
- [`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
- [`workspacesWorkspaceUploadRequestDeleteWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#deleteworkspaceuploadrequest) - Deletes a specific upload request
- [`workspacesWorkspaceUploadRequestGetWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#getworkspaceuploadrequest) - Gets details for a specific upload request
- [`workspacesWorkspaceUploadRequestGetWorkspaceUploadRequests`](docs/sdks/workspaceuploadrequest/README.md#getworkspaceuploadrequests) - Gets upload requests within a workspace
- [`workspacesWorkspaceUploadRequestUpdateWorkspaceUploadRequest`](docs/sdks/workspaceuploadrequest/README.md#updateworkspaceuploadrequest) - Updates a specific upload request
- [`workspacesWorkspaceUsersAddWorkspaceUser`](docs/sdks/workspaceusers/README.md#addworkspaceuser) - Adds a user to the workspace by email address
- [`workspacesWorkspaceUsersGetWorkspaceUsers`](docs/sdks/workspaceusers/README.md#getworkspaceusers) - Retrieves the list of users in the given workspace
- [`workspacesWorkspaceUsersRestoreWorkspaceUserAccess`](docs/sdks/workspaceusers/README.md#restoreworkspaceuseraccess) - Restores the specified user's access to the workspace
- [`workspacesWorkspaceUsersRevokeWorkspaceUserAccess`](docs/sdks/workspaceusers/README.md#revokeworkspaceuseraccess) - Revokes the specified user's access to the workspace
- [`workspacesWorkspaceUsersUpdateWorkspaceUser`](docs/sdks/workspaceusers/README.md#updateworkspaceuser) - Updates the specified user's role

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

<details><summary>Less common errors (8)</summary>
<details><summary>Less common errors (9)</summary>

<br />

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


**Inherit from [`IamClientError`](./src/models/errors/iamclienterror.ts)**:
* [`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.*
* [`OAuthErrorResponse`](./src/models/errors/oautherrorresponse.ts): Status code `400`. Applicable to 5 of 18 methods.*
* [`ErrorDetails`](./src/models/errors/errordetails.ts): The error response object for the Workspaces API. Applicable to 21 of 39 methods.*
* [`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.*
* [`OAuthErrorResponse`](./src/models/errors/oautherrorresponse.ts): Status code `400`. Applicable to 5 of 39 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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,14 @@ Based on:
### Generated
- [typescript v1.0.0-beta.3] .
### Releases
- [NPM v1.0.0-beta.3] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.3 - .
- [NPM v1.0.0-beta.3] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.3 - .

## 2025-09-03 17:15:21
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.609.0 (2.692.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v1.0.0-beta.4] .
### Releases
- [NPM v1.0.0-beta.4] https://www.npmjs.com/package/@docusign/iam-sdk/v/1.0.0-beta.4 - .
18 changes: 18 additions & 0 deletions docs/models/components/createworkspacebody.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CreateWorkspaceBody

## Example Usage

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

let value: CreateWorkspaceBody = {
name: "<value>",
};
```

## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | *string* | :heavy_check_mark: | The name of the workspace |
| `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> |
15 changes: 15 additions & 0 deletions docs/models/components/createworkspaceenveloperesponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CreateWorkspaceEnvelopeResponse

## Example Usage

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

let value: CreateWorkspaceEnvelopeResponse = {};
```

## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `envelopeId` | *string* | :heavy_minus_sign: | N/A |
19 changes: 19 additions & 0 deletions docs/models/components/createworkspaceresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# CreateWorkspaceResponse

## Example Usage

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

let value: CreateWorkspaceResponse = {};
```

## Fields

| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `workspaceId` | *string* | :heavy_minus_sign: | The ID of the workspace |
| `name` | *string* | :heavy_minus_sign: | The name of the workspace |
| `createdDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date the workspace was created |
| `createdByUserId` | *string* | :heavy_minus_sign: | The ID of the user who created the workspace |
| `workspaceOwnerIds` | *string*[] | :heavy_minus_sign: | The list of user IDs of the workspace owners |
21 changes: 21 additions & 0 deletions docs/models/components/createworkspaceuploadrequestassignment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# CreateWorkspaceUploadRequestAssignment

## Example Usage

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

let value: CreateWorkspaceUploadRequestAssignment = {
uploadRequestResponsibilityTypeId: "watcher",
};
```

## Fields

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `assigneeUserId` | *string* | :heavy_minus_sign: | The ID of the assigned user |
| `uploadRequestResponsibilityTypeId` | [components.WorkspaceUploadRequestResponsibilityType](../../models/components/workspaceuploadrequestresponsibilitytype.md) | :heavy_check_mark: | Enum representing the responsibility type for a workspace upload request assignment |
| `firstName` | *string* | :heavy_minus_sign: | The first name of the assignee |
| `lastName` | *string* | :heavy_minus_sign: | The last name of the assignee |
| `email` | *string* | :heavy_minus_sign: | The email of the assignee |
Loading