docusign-monitor

The Official DocuSign Monitor Node Client

NPM module that wraps the DocuSign Monitor API

Documentation about the DocuSign Monitor API

Requirements

• Node 12
• Free Developer Account
• DocuSign Monitor account connected to your Developer account. Here is how to create a Monitor developer account

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:

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

Dependencies

This client has the following external dependencies:

Minimum:

• Axios 1.6.8

Optional:

• Async v2.6.2
• Jsonwebtoken v9.0.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 Monitor 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 Monitor Node Client is licensed under the MIT License.

Changelog

[3.0.0] - 2017-03-10

BREAKING

• The SDK now supports theFull and latest DocuSign API support(17.1.00.00). NO MORE OMITTED ENDPOINTS.
• Getter and setter methods of all models' fields were removed. Direct access to models' fields is now required. See the code snippet in README.md and test/SdkUnitTests.js for example.
• Added optional opts to several methods across different APIs. Old client code might need to be updated prior to using 3.0.0 and above.
• Methods that accept optional parameters, defined as opts, now accept plain javascript objects only. For instance AuthenticationApi.login({'api_password': true}) will return a fake password that can be used in subsequent API calls instead of the original password.

Removed

• All Optional data structures that were used as optional parameters for some API methods (in the form ofDocusign.XxxApi.doSomethingOptions). Use javascript plain objects instead.

Added

• Complete and proper SDK Documentation, including detailed information and links about all modules and methods of the SDK.
• New test case: create a DocuSign template.

Fixed

• Issue #52: TypeError: self.envelopeTemplateDefinition.constructFromObject is not a function.

Changed

• Updated the package with the latest API release.