@docusign/iam-sdk

# @docusign/iam-sdk Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API. <div align="left"> <a href="https://opensource.org/licenses/MIT"> <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" /> </a> </div> <br /> ## Summary This SDK enables Typescript and Node.js developers to abstract and simplify the use of the Docusign IAM APIs. By installing this nuget package, developers can then use TypeScript objects and methods to interact with the following Docusign APIs: * [Maestro API](https://developers.docusign.com/docs/maestro-api/) * [Navigator API](https://developers.docusign.com/docs/navigator-api/) * [Connected Fields API](https://developers.docusign.com/docs/connected-fields-api/) * [Workspaces API](https://developers.docusign.com/docs/workspaces-api/) This repo contains the source-code for this SDK. You only need to use the code in this repo if you want to customize the SDK for your own needs. To use the SDK you just need to install the npm package and do not need to use this repo. You can also find code examples and documentation for this SDK in the [Docusign Developer Center](https://developers.docusign.com/).   ## Table of Contents  * [@docusign/iam-sdk](#docusigniam-sdk) * [SDK Installation](#sdk-installation) * [Requirements](#requirements) * [SDK Example Usage](#sdk-example-usage) * [Authentication](#authentication) * [Available Resources and Operations](#available-resources-and-operations) * [Standalone functions](#standalone-functions) * [File uploads](#file-uploads) * [Retries](#retries) * [Error Handling](#error-handling) * [Server Selection](#server-selection) * [Custom HTTP Client](#custom-http-client) * [Debugging](#debugging) * [Development](#development) * [Maturity](#maturity) * [Contributions](#contributions)   ## SDK Installation The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers. ### NPM ```bash npm add @docusign/iam-sdk ``` ### PNPM ```bash pnpm add @docusign/iam-sdk ``` ### Bun ```bash bun add @docusign/iam-sdk ``` ### Yarn ```bash yarn add @docusign/iam-sdk ``` > [!NOTE] > This package is published with CommonJS and ES Modules (ESM) support.   ## Requirements For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).   ## SDK Example Usage ### Example ```typescript import { IamClient } from "@docusign/iam-sdk"; const iamClient = new IamClient({ accessToken: process.env["DOCUSIGN_IAM_CLIENT_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await iamClient.auth.getUserInfo(); console.log(result); } run(); ```   ## Authentication ### Per-Client Security Schemes This SDK supports the following security scheme globally: | Name | Type | Scheme | Environment Variable | | ------------- | ------ | ------------ | ---------------------------------- | | `accessToken` | oauth2 | OAuth2 token | `DOCUSIGN_IAM_CLIENT_ACCESS_TOKEN` | To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example: ```typescript import { IamClient } from "@docusign/iam-sdk"; const iamClient = new IamClient({ accessToken: process.env["DOCUSIGN_IAM_CLIENT_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await iamClient.auth.getTokenFromPublicAuthCode({ clientId: "2da1cb14-xxxx-xxxx-xxxx-5b7b40829e79", code: "eyJ0eXAi.....QFsje43QVZ_gw", codeVerifier: "R8zFoqs0yey29G71QITZs3dK1YsdIvFNBfO4D1bukBw", }); console.log(result); } run(); ``` ### Per-Operation Security Schemes Some operations in this SDK require the security scheme to be specified at the request level. For example: ```typescript import { IamClient } from "@docusign/iam-sdk"; const iamClient = new IamClient(); async function run() { const result = await iamClient.auth.getTokenFromConfidentialAuthCode({ clientId: "2da1cb14-xxxx-xxxx-xxxx-5b7b40829e79", secretKey: "MTIzNDU2Nzxxxxxxxxxxxxxxxxxxxxx0NTY3ODkwMTI", }, { code: "eyJ0eXAi.....QFsje43QVZ_gw", }); console.log(result); } run(); ```   ## Available Resources and Operations <details open> <summary>Available methods</summary> ### [AgreementManager.Agreements](docs/sdks/agreements/README.md) * [getAgreementsList](docs/sdks/agreements/README.md#getagreementslist) - Retrieve a list of agreements * [patchAgreementByDocumentId](docs/sdks/agreements/README.md#patchagreementbydocumentid) - Update an agreement by locating it via document ID * [getAgreementTypes](docs/sdks/agreements/README.md#getagreementtypes) - List configured agreement types for the account. * [getAgreement](docs/sdks/agreements/README.md#getagreement) - Retrieve detailed information about a specific agreement * [deleteAgreement](docs/sdks/agreements/README.md#deleteagreement) - Delete a specific agreement * [patchAgreement](docs/sdks/agreements/README.md#patchagreement) - Update specific fields of an agreement * [changeAgreementType](docs/sdks/agreements/README.md#changeagreementtype) - Change the type of an agreement ### [AgreementManager.BulkJob](docs/sdks/bulkjob/README.md) * [createBulkUploadJob](docs/sdks/bulkjob/README.md#createbulkuploadjob) - Create new bulk job with presigned URLs direct to Azure Blob Store * [getBulkJobStatus](docs/sdks/bulkjob/README.md#getbulkjobstatus) - Get bulk job status * [uploadCompleteBulkJob](docs/sdks/bulkjob/README.md#uploadcompletebulkjob) - Mark bulk job upload as complete ### [Auth](docs/sdks/auth/README.md) * [getTokenFromConfidentialAuthCode](docs/sdks/auth/README.md#gettokenfromconfidentialauthcode) - Obtains an access token from the Docusign API using an authorization code. * [getTokenFromPublicAuthCode](docs/sdks/auth/README.md#gettokenfrompublicauthcode) - Obtains an access token from the Docusign API using an authorization code. * [getTokenFromJwtGrant](docs/sdks/auth/README.md#gettokenfromjwtgrant) - Obtains an access token from the Docusign API using a JWT grant. * [getTokenFromRefreshToken](docs/sdks/auth/README.md#gettokenfromrefreshtoken) - Obtains an access token from the Docusign API using an authorization code. * [getUserInfo](docs/sdks/auth/README.md#getuserinfo) - Get user information ### [ConnectedFields.TabInfo](docs/sdks/tabinfo/README.md) * [getConnectedFieldsTabGroups](docs/sdks/tabinfo/README.md#getconnectedfieldstabgroups) - Returns all tabs associated with the given account ### [WorkflowBuilder.WorkflowInstanceManagement](docs/sdks/workflowinstancemanagement/README.md) * [getWorkflowInstancesList](docs/sdks/workflowinstancemanagement/README.md#getworkflowinstanceslist) - Retrieve All Workflow Instances * [getWorkflowInstance](docs/sdks/workflowinstancemanagement/README.md#getworkflowinstance) - Retrieve a Workflow Instance * [cancelWorkflowInstance](docs/sdks/workflowinstancemanagement/README.md#cancelworkflowinstance) - Cancel a Running Workflow Instance ### [WorkflowBuilder.Workflows](docs/sdks/workflows/README.md) * [getWorkflowsList](docs/sdks/workflows/README.md#getworkflowslist) - Retrieve a list of available Workflow Builder workflows * [getWorkflowTriggerRequirements](docs/sdks/workflows/README.md#getworkflowtriggerrequirements) - Retrieve trigger requirements for a specific Workflow Builder workflow * [triggerWorkflow](docs/sdks/workflows/README.md#triggerworkflow) - Trigger a new instance of a Workflow Builder workflow * [pauseNewWorkflowInstances](docs/sdks/workflows/README.md#pausenewworkflowinstances) - Pause an Active Workflow * [resumePausedWorkflow](docs/sdks/workflows/README.md#resumepausedworkflow) - Resume a Paused Workflow ### [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 * [addWorkspaceDocument](docs/sdks/workspacedocuments/README.md#addworkspacedocument) - Add a document to a workspace via file contents upload * [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 * [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 * [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 * [addWorkspaceUploadRequestDocument](docs/sdks/workspaceuploadrequest/README.md#addworkspaceuploadrequestdocument) - Add a document to an upload request via file upload * [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>   ## Standalone functions All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away. To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). <details> <summary>Available standalone functions</summary> - [`agreementManagerAgreementsChangeAgreementType`](docs/sdks/agreements/README.md#changeagreementtype) - Change the type of an agreement - [`agreementManagerAgreementsDeleteAgreement`](docs/sdks/agreements/README.md#deleteagreement) - Delete a specific agreement - [`agreementManagerAgreementsGetAgreement`](docs/sdks/agreements/README.md#getagreement) - Retrieve detailed information about a specific agreement - [`agreementManagerAgreementsGetAgreementsList`](docs/sdks/agreements/README.md#getagreementslist) - Retrieve a list of agreements - [`agreementManagerAgreementsGetAgreementTypes`](docs/sdks/agreements/README.md#getagreementtypes) - List configured agreement types for the account. - [`agreementManagerAgreementsPatchAgreement`](docs/sdks/agreements/README.md#patchagreement) - Update specific fields of an agreement - [`agreementManagerAgreementsPatchAgreementByDocumentId`](docs/sdks/agreements/README.md#patchagreementbydocumentid) - Update an agreement by locating it via document ID - [`agreementManagerBulkJobCreateBulkUploadJob`](docs/sdks/bulkjob/README.md#createbulkuploadjob) - Create new bulk job with presigned URLs direct to Azure Blob Store - [`agreementManagerBulkJobGetBulkJobStatus`](docs/sdks/bulkjob/README.md#getbulkjobstatus) - Get bulk job status - [`agreementManagerBulkJobUploadCompleteBulkJob`](docs/sdks/bulkjob/README.md#uploadcompletebulkjob) - Mark bulk job upload as complete - [`authGetTokenFromConfidentialAuthCode`](docs/sdks/auth/README.md#gettokenfromconfidentialauthcode) - Obtains an access token from the Docusign API using an authorization code. - [`authGetTokenFromJwtGrant`](docs/sdks/auth/README.md#gettokenfromjwtgrant) - Obtains an access token from the Docusign API using a JWT grant. - [`authGetTokenFromPublicAuthCode`](docs/sdks/auth/README.md#gettokenfrompublicauthcode) - Obtains an access token from the Docusign API using an authorization code. - [`authGetTokenFromRefreshToken`](docs/sdks/auth/README.md#gettokenfromrefreshtoken) - Obtains an access token from the Docusign API using an authorization code. - [`authGetUserInfo`](docs/sdks/auth/README.md#getuserinfo) - Get user information - [`connectedFieldsTabInfoGetConnectedFieldsTabGroups`](docs/sdks/tabinfo/README.md#getconnectedfieldstabgroups) - Returns all tabs associated with the given account - [`workflowBuilderWorkflowInstanceManagementCancelWorkflowInstance`](docs/sdks/workflowinstancemanagement/README.md#cancelworkflowinstance) - Cancel a Running Workflow Instance - [`workflowBuilderWorkflowInstanceManagementGetWorkflowInstance`](docs/sdks/workflowinstancemanagement/README.md#getworkflowinstance) - Retrieve a Workflow Instance - [`workflowBuilderWorkflowInstanceManagementGetWorkflowInstancesList`](docs/sdks/workflowinstancemanagement/README.md#getworkflowinstanceslist) - Retrieve All Workflow Instances - [`workflowBuilderWorkflowsGetWorkflowsList`](docs/sdks/workflows/README.md#getworkflowslist) - Retrieve a list of available Workflow Builder workflows - [`workflowBuilderWorkflowsGetWorkflowTriggerRequirements`](docs/sdks/workflows/README.md#getworkflowtriggerrequirements) - Retrieve trigger requirements for a specific Workflow Builder workflow - [`workflowBuilderWorkflowsPauseNewWorkflowInstances`](docs/sdks/workflows/README.md#pausenewworkflowinstances) - Pause an Active Workflow - [`workflowBuilderWorkflowsResumePausedWorkflow`](docs/sdks/workflows/README.md#resumepausedworkflow) - Resume a Paused Workflow - [`workflowBuilderWorkflowsTriggerWorkflow`](docs/sdks/workflows/README.md#triggerworkflow) - Trigger a new instance of a Workflow Builder workflow - [`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 - [`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 - [`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 - [`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>   ## File uploads Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request. > [!TIP] > > Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory: > > - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options). > - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads. > - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element. > - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob). ```typescript import { IamClient } from "@docusign/iam-sdk"; const iamClient = new IamClient({ accessToken: process.env["DOCUSIGN_IAM_CLIENT_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await iamClient.workspaces.workspaceDocuments .addWorkspaceDocument({ accountId: "5eddb8e1-d00e-47c4-9ed6-3b1c8915ae0d", workspaceId: "7f9e0991-b6d1-4de8-bfa5-7724e59a3087", }); console.log(result); } run(); ```   ## Retries Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: ```typescript import { IamClient } from "@docusign/iam-sdk"; const iamClient = new IamClient(); async function run() { const result = await iamClient.auth.getTokenFromConfidentialAuthCode({ clientId: "2da1cb14-xxxx-xxxx-xxxx-5b7b40829e79", secretKey: "MTIzNDU2Nzxxxxxxxxxxxxxxxxxxxxx0NTY3ODkwMTI", }, { code: "eyJ0eXAi.....QFsje43QVZ_gw", }, { retries: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, }); console.log(result); } run(); ``` If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: ```typescript import { IamClient } from "@docusign/iam-sdk"; const iamClient = new IamClient({ retryConfig: { strategy: "backoff", backoff: { initialInterval: 1, maxInterval: 50, exponent: 1.1, maxElapsedTime: 100, }, retryConnectionErrors: false, }, }); async function run() { const result = await iamClient.auth.getTokenFromConfidentialAuthCode({ clientId: "2da1cb14-xxxx-xxxx-xxxx-5b7b40829e79", secretKey: "MTIzNDU2Nzxxxxxxxxxxxxxxxxxxxxx0NTY3ODkwMTI", }, { code: "eyJ0eXAi.....QFsje43QVZ_gw", }); console.log(result); } run(); ```   ## Error Handling [`IamClientError`](./src/models/errors/iamclienterror.ts) is the base class for all HTTP error responses. It has the following properties: | Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | `error.message` | `string` | Error message | | `error.statusCode` | `number` | HTTP response status code eg `404` | | `error.headers` | `Headers` | HTTP response headers | | `error.body` | `string` | HTTP body. Can be empty string if no body is returned. | | `error.rawResponse` | `Response` | Raw HTTP response | | `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). | ### Example ```typescript import { IamClient } from "@docusign/iam-sdk"; import * as errors from "@docusign/iam-sdk/models/errors"; const iamClient = new IamClient(); async function run() { try { const result = await iamClient.auth.getTokenFromConfidentialAuthCode({ clientId: "2da1cb14-xxxx-xxxx-xxxx-5b7b40829e79", secretKey: "MTIzNDU2Nzxxxxxxxxxxxxxxxxxxxxx0NTY3ODkwMTI", }, { code: "eyJ0eXAi.....QFsje43QVZ_gw", }); console.log(result); } catch (error) { // The base class for HTTP error responses if (error instanceof errors.IamClientError) { console.log(error.message); console.log(error.statusCode); console.log(error.body); console.log(error.headers); // Depending on the method different errors may be thrown if (error instanceof errors.OAuthErrorResponse) { console.log(error.data$.error); // string console.log(error.data$.errorDescription); // string } } } } run(); ``` ### Error Classes **Primary error:** * [`IamClientError`](./src/models/errors/iamclienterror.ts): The base class for HTTP error responses. <details><summary>Less common errors (9)</summary> <br /> **Network errors:** * [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server. * [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal. * [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client. * [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid. * [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error. **Inherit from [`IamClientError`](./src/models/errors/iamclienterror.ts)**: * [`ErrorDetails`](./src/models/errors/errordetails.ts): The error response object for the Workspaces API. Applicable to 26 of 50 methods.* * [`ErrDetails`](./src/models/errors/errdetails.ts): Error response conforming to RFC 9457 (Problem Details for HTTP APIs). See: https://www.rfc-editor.org/rfc/rfc9457.html. Applicable to 17 of 50 methods.* * [`OAuthErrorResponse`](./src/models/errors/oautherrorresponse.ts): Status code `400`. Applicable to 5 of 50 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> \* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.   ## Server Selection ### Select Server by Name You can override the default server globally by passing a server name to the `server: keyof typeof ServerList` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers: | Name | Server | Description | | ------ | ---------------------------- | ----------- | | `demo` | `https://api-d.docusign.com` | Demo | | `prod` | `https://api.docusign.com` | Production | #### Example ```typescript import { IamClient } from "@docusign/iam-sdk"; const iamClient = new IamClient({ server: "demo", accessToken: process.env["DOCUSIGN_IAM_CLIENT_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await iamClient.workflowBuilder.workflows.getWorkflowsList({ accountId: "ae232f1f-8efc-4b8c-bb08-626847fad8bb", status: "active", }); console.log(result); } run(); ``` ### Override Server URL Per-Client The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example: ```typescript import { IamClient } from "@docusign/iam-sdk"; const iamClient = new IamClient({ serverURL: "https://api-d.docusign.com", accessToken: process.env["DOCUSIGN_IAM_CLIENT_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await iamClient.workflowBuilder.workflows.getWorkflowsList({ accountId: "ae232f1f-8efc-4b8c-bb08-626847fad8bb", status: "active", }); console.log(result); } run(); ``` ### Override Server URL Per-Operation The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example: ```typescript import { IamClient } from "@docusign/iam-sdk"; const iamClient = new IamClient(); async function run() { const result = await iamClient.auth.getTokenFromConfidentialAuthCode({ clientId: "2da1cb14-xxxx-xxxx-xxxx-5b7b40829e79", secretKey: "MTIzNDU2Nzxxxxxxxxxxxxxxxxxxxxx0NTY3ODkwMTI", }, { code: "eyJ0eXAi.....QFsje43QVZ_gw", }, { serverURL: "https://account.docusign.com", }); console.log(result); } run(); ```   ## Custom HTTP Client The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This client is a thin wrapper around `fetch` and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response. The `HTTPClient` constructor takes an optional `fetcher` argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures. The following example shows how to: - route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent - use the `"beforeRequest"` hook to add a custom header and a timeout to requests - use the `"requestError"` hook to log errors ```typescript import { IamClient } from "@docusign/iam-sdk"; import { ProxyAgent } from "undici"; import { HTTPClient } from "@docusign/iam-sdk/lib/http"; const dispatcher = new ProxyAgent("http://proxy.example.com:8080"); const httpClient = new HTTPClient({ // 'fetcher' takes a function that has the same signature as native 'fetch'. fetcher: (input, init) => // 'dispatcher' is specific to undici and not part of the standard Fetch API. fetch(input, { ...init, dispatcher } as RequestInit), }); httpClient.addHook("beforeRequest", (request) => { const nextRequest = new Request(request, { signal: request.signal || AbortSignal.timeout(5000) }); nextRequest.headers.set("x-custom-header", "custom value"); return nextRequest; }); httpClient.addHook("requestError", (error, request) => { console.group("Request Error"); console.log("Reason:", `${error}`); console.log("Endpoint:", `${request.method} ${request.url}`); console.groupEnd(); }); const sdk = new IamClient({ httpClient: httpClient }); ```   ## Debugging You can setup your SDK to emit debug logs for SDK requests and responses. You can pass a logger that matches `console`'s interface as an SDK option. > [!WARNING] > Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production. ```typescript import { IamClient } from "@docusign/iam-sdk"; const sdk = new IamClient({ debugLogger: console }); ``` You can also enable a default debug logger by setting an environment variable `DOCUSIGN_IAM_CLIENT_DEBUG` to true.   # Development ## Maturity This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version. ## Contributions While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.