Skip to content

docusign/docusign-iam-typescript-client

BranchesTags

Repository files navigation

@docusign/iam-sdk

Developer-friendly & type-safe TypeScript SDK specifically catered to leverage @docusign/iam-sdk API.


Summary

This SDK enables TypesSript 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:

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.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @docusign/iam-sdk

PNPM

pnpm add @docusign/iam-sdk

Bun

bun add @docusign/iam-sdk

Yarn

yarn add @docusign/iam-sdk zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Note

This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

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:

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:

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

Available methods

auth

connectedFields

connectedFields.tabInfo

maestro

maestro.workflowInstanceManagement

maestro.workflows

navigator

navigator.agreements

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.

Available standalone functions

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:

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:

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 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.

Example

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:

Less common errors (8)

Network errors:

Inherit from IamClientError:

  • ErrorT: Bad Request - The request could not be understood or was missing required parameters. Applicable to 8 of 16 methods.*
  • OAuthErrorResponse: Status code 400. Applicable to 5 of 16 methods.*
  • ResponseValidationError: 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.

* Check the method documentation 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/v1 Demo
prod https://api.docusign.com/v1 Production

Example

import { IamClient } from "@docusign/iam-sdk";

const iamClient = new IamClient({
  server: "prod",
});

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();

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:

import { IamClient } from "@docusign/iam-sdk";

const iamClient = new IamClient({
  serverURL: "https://api-d.docusign.com/v1",
});

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();

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:

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. 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 use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { IamClient } from "@docusign/iam-sdk";
import { HTTPClient } from "@docusign/iam-sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

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 });

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.

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.

About

Docusign IAM TypeScript SDK

Topics

typescript

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages