Skip to content

Commit ecd6af4

Browse files
Version 5.9.0-rc2-v2.1-21.1.01 release (#242)
Co-authored-by: DevCenter-DocuSign <[email protected]>
1 parent 0db0227 commit ecd6af4

26 files changed

+1901
-157
lines changed

.travis.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ notifications:
1515
on_failure: change
1616

1717
node_js:
18-
- "4"
19-
- "5"
2018
- "6"
2119
- "7"
2220
- "8"

README.md

Lines changed: 26 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# The Official DocuSign Node Client
1+
# The Official DocuSign eSignature Node Client SDK
22

33
[![NPM version][npm-image]][npm-url]
44
[![NPM downloads][downloads-image]][downloads-url]
@@ -16,70 +16,53 @@ commented out
1616
-->
1717

1818
## Requirements
19-
- Node 4
20-
- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
19+
* Node 4
20+
* Free [developer account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
2121

2222
## Compatibility
23-
24-
- Node 4+
25-
26-
## Note:
27-
28-
This open-source SDK is provided 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](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
23+
* Node 4+
2924

3025
## Installation
26+
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’re working through our [code examples](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [DocuSign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
3127

32-
## NPM:
33-
28+
### NPM:
3429
1. Open your preferred command-line console, then navigate to your project.
35-
2. In the console, type the following commands:
36-
**npm install docusign-esign -save**
37-
30+
2. In the console, type the following commands: \
31+
npm install docusign-esign -save
3832

3933
## Dependencies
40-
4134
This client has the following external dependencies:
4235

43-
### Minimum:
44-
45-
- DocuSign-eSign
46-
- Superagent 3.8.2
47-
48-
### Optional:
36+
**Minimum:**
37+
* DocuSign-eSign
38+
* Superagent 3.8.2
4939

50-
- Async v2.6.2
51-
- Jsonwebtoken v8.2.0
52-
- Passport-oauth2
53-
- Path
40+
**Optional:**
41+
* Async v2.6.2
42+
* Jsonwebtoken v8.2.0
43+
* Passport-oauth2
44+
* Path
5445

55-
## Code Examples
46+
## Code examples
5647

57-
### Launchers
48+
You can find on our GitHub a self-executing package of code examples for the eSignature C# SDK, called a [Launcher](https://github.com/docusign/code-examples-node/blob/master/README.md), that demonstrates common use cases. You can also download a version preconfigured for your DocuSign developer account from [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart/). These examples can use either the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Token (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) authentication workflows.
5849

59-
DocuSign provides a sample application code referred to as a [Launcher](https://github.com/docusign/code-examples-node). The Launcher contains a set of 31 common use cases and associated source files. These examples use either DocuSign&#39;s [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) or [JSON Web Tokens (JWT)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) flows.
60-
61-
### Proof-of-concept applications
62-
63-
If your goal is to create a proof-of-concept application, DocuSign provides a set of [Quick Start](https://developers.docusign.com/esign-rest-api/code-examples/quickstart-overview) examples. The Quick Startexamples are meant to be used with DocuSign&#39;s [OAuth Token Generator](https://developers.docusign.com/oauth-token-generator), which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.
64-
65-
## OAuth Implementations
66-
67-
For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/).
50+
## OAuth implementations
51+
For details regarding which type of OAuth grant will work best for your DocuSign integration, see [Choose OAuth Type](https://developers.docusign.com/platform/auth/choose/) in the [DocuSign Developer Center](https://developers.docusign.com/).
6852

6953
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
7054

71-
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](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) and [Implicit](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-implicit) grants. For Ccode eExamples, see the links below:
72-
73-
- [JWT (JSON Web Token)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken)
74-
- [Implicit Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-implicit)
75-
7655
## Support
77-
7856
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](http://stackoverflow.com/questions/tagged/docusignapi).
7957

8058
## License
59+
The DocuSign eSignature Node Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-node-client/blob/master/LICENSE).
8160

82-
The DocuSign Node Client is licensed under the [MIT License](https://github.com/docusign/docusign-node-client/blob/master/LICENSE).
61+
### Additional resources
62+
* [DocuSign Developer Center](https://developers.docusign.com/)
63+
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
64+
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
65+
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
8366

8467
[npm-image]: https://img.shields.io/npm/v/docusign-esign.svg?style=flat
8568
[npm-url]: https://npmjs.org/package/docusign-esign
@@ -89,9 +72,3 @@ The DocuSign Node Client is licensed under the [MIT License](https://github.com/
8972
[travis-url]: https://travis-ci.org/docusign/docusign-node-client
9073
[coveralls-image]: https://coveralls.io/repos/github/docusign/DocuSign-Node-Client/badge.svg?branch=master
9174
[coveralls-url]: https://coveralls.io/github/docusign/DocuSign-Node-Client?branch=master
92-
93-
### Additional Resources
94-
* [DocuSign Developer Center](https://developers.docusign.com)
95-
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
96-
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
97-
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docusign-esign",
3-
"version": "5.9.0-rc1",
3+
"version": "5.9.0-rc2",
44
"description": "DocuSign Node.js API client.",
55
"license": "MIT",
66
"main": "src/index.js",

0 commit comments

Comments
 (0)