docusign-click

The Official DocuSign Click Node Client SDK

NPM module

Documentation about the DocuSign Click API

Requirements

• Node 12
• Free Developer Account

Compatibility

• Node 12+

Installation

This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you simply want to use the SDK with any of the examples shown in the Developer Center, you merely need to install it by following the instructions below.

NPM:

• Open your preferred command-line console, then navigate to your project.
• In the console, type the following commands:
  npm install docusign-click -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

DocuSign provides a sample application code referred to as a Launcher. The Launcher includes, besides a full set of eSignature code examples, a set of code examples and associated source files for five common Click use cases. These examples can use either the Authorization Code Grant or JSON Web Token (JWT) Grant authentication flow.

OAuth implementations

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

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

Support

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

License

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

Additional resources

• DocuSign Developer Center
• DocuSign API on Twitter
• DocuSign For Developers on LinkedIn
• DocuSign For Developers on YouTube

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.