Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

docusign-rooms

docusign839MIT3.0.0

DocuSign Node.js API client.

docusign, signature, esignature, esign, digital, electronic, transaction, document, certificate, DTM, PDF

readme

The Official DocuSign Rooms Node Client

NPM version NPM downloads Build status Coverage Status

NPM module that wraps the DocuSign Rooms API

Documentation about the DocuSign Rooms API

Requirements

Compatibility

  • Node 12+

Note:

This SDK will soon be provided as open-source for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the Developer Center, follow the installation instructions below.

Installation

NPM:

  1. Open your preferred command-line console, then navigate to your project.
  2. In the console, type the following commands:
    npm install docusign-rooms -save

Dependencies

This client has the following external dependencies:

Minimum:

  • axios 1.6.8

Optional:

  • Async v2.6.2
  • Jsonwebtoken v8.2.0
  • Passport-oauth2
  • Path

Code Examples

Launchers

DocuSign provides a sample application referred to as a Launcher. The Launcher contains a set of 6 common use cases and associated source files. These examples use DocuSign's Authorization Code Grant flow.

OAuth Implementations

For details regarding which type of OAuth grant will work best for your DocuSign integration, see the Rooms API Authentication Overview guide located on the DocuSign Developer Center.

For security purposes, DocuSign recommends using the Authorization Code Grant or JWT flow.

There are other use-case scenarios, such as single-page applications (SPA) that use Cross-Origin Resource Sharing (CORS), or where there may not be a user to interact with your Service Account. For these use cases, DocuSign also supports JWT and Implicit grants. For Code eExamples, see the links below:

Support

Log issues against this client through GitHub. We also have an active developer community on Stack Overflow.

License

The DocuSign Rooms Node Client is licensed under the MIT License.

changelog

DocuSign Node Client Changelog

See DocuSign Support Center for Product Release Notes.

[v3.0.0] - Rooms API v2-1.1.1 - 2024-11-20

Breaking Changes

<summary>Click here for change details</summary> **Security Updates** - Updated HTTP Client: Due to identified security vulnerabilities in Superagent proxy version 3.0.0, we have transitioned from using Superagent to the more secure Axios HTTP client. This update helps in safeguarding your interactions by patching potential security gaps.

New Features

  • Proxy Support for HTTP Requests: We've introduced the ability to make HTTP requests through a proxy. This enhancement is particularly useful for users operating within corporate or restricted networks.
  • JWT Token Request Functionality: The new sendJWTTokenRequest method allows you to obtain authentication tokens without exposing your privateKey. This method is designed to enhance security in your authentication processes.

Changes to Existing Features

  • Updated Callback Response Structure: We have made changes to the response structure for callbacks. If you are using callback functions in your integration, please note the updated response object attributes:

    statusCode header body

Migration Guide

  • For those using callback functions, please adjust your implementation to handle the new response structure as detailed above.

[v2.0.0-rc3] - Rooms API v2-1.1.1 - 2024-04-24

Changed

Security Updates

  • Updated HTTP Client: Due to identified security vulnerabilities in Superagent proxy version 3.0.0, we have transitioned from using Superagent to the more secure Axios HTTP client. This update helps in safeguarding your interactions by patching potential security gaps.

New Features

  • Proxy Support for HTTP Requests: We've introduced the ability to make HTTP requests through a proxy. This enhancement is particularly useful for users operating within corporate or restricted networks.
  • JWT Token Request Functionality: The new sendJWTTokenRequest method allows you to obtain authentication tokens without exposing your privateKey. This method is designed to enhance security in your authentication processes.

Changes to Existing Features

  • Updated Callback Response Structure: We have made changes to the response structure for callbacks. If you are using callback functions in your integration, please note the updated response object attributes:

    statusCode header body

Migration Guide

  • For those using callback functions, please adjust your implementation to handle the new response structure as detailed above.

[v2.0.0] - Rooms API v2-1.1.0 - 2023-01-23

Breaking

  • Deprecating Node versions <12

    Security

  • Update jsonwebtoken package to 9.0.0 addressing CVE-2022-23529

Changed

  • Added support for version v2-1.1.0 of the DocuSign Rooms API.
  • Updated the SDK release version.

[v1.2.1-rc1] - Rooms API v2-1.0.9 - 2022-01-10

Changed

  • Added support for version v2-1.0.9 of the DocuSign Rooms API.
  • Updated the SDK release version.

[1.2.0-rc1] - Rooms API v2-1.0.9 - 2021-10-04

Changed

  • Added support for version v2-1.0.9 of the DocuSign Rooms API.
  • Updated the SDK release version.

[v1.0.0-beta] - Rooms API v2-1.0.7

Added

  • Added first beta version of the DocuSign Rooms API.