Merge pull request #61 from docusign/3.0.0

3.0.0

Author: mmallis87

.gitignore

@@ -4,3 +4,5 @@ coverage
 *.DS_Store
 auth-info.json
 config.json
+.idea/
+npm-debug.log

.jsdoc.json

@@ -0,0 +1,33 @@
+{
+  "tags": {
+    "allowUnknownTags": true
+  },
+  "source": {
+    "include": ["src", "package.json"],
+    "includePattern": ".js$",
+    "excludePattern": "(node_modules/|docs)"
+  },
+  "plugins": [
+    "plugins/markdown"
+  ],
+  "markdown": {
+    "parser": "gfm",
+    "hardwrap": true
+  },
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": true,
+    "useLongnameInNav": false
+  },
+  "opts": {
+    "source": "./src/",
+    "destination": "./docs/",
+    "encoding": "utf8",
+    "recurse": true,
+    "template": "./node_modules/docdash"
+  },
+  "docdash": {
+    "static": false,
+    "sort": true
+  }
+}

.travis.yml

@@ -10,10 +10,12 @@ notifications:
     on_failure: change
 
 node_js:
-  - "0.10"
-  - "0.12"
+  - "2.2"
+  - "3"
   - "4"
   - "5"
+  - "6"
+  - "7"
 
 after_script: "npm install coveralls@2 && cat ./coverage/lcov.info | coveralls"
 

CHANGELOG.md

@@ -4,16 +4,32 @@ All notable changes to this project will be documented in this file.
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
 ## [Unreleased]
+More information later on.
+
+## [3.0.0] - 2017-03-10
+### BREAKING
+- The SDK now supports the**Full 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 of**Docusign.XxxApi.doSomethingOptions**). Use javascript plain objects instead.
+
 ### Added
-- More test cases.
+- **Complete and proper SDK [Documentation](http://docusign.github.io/docusign-node-client/module-index.html), including detailed information and links about all modules and methods of the SDK.**
+- New test case: create a DocuSign template.
+
+### Fixed
+- Issue [`#52`](https://github.com/docusign/DocuSign-Node-Client/issues/52): TypeError: self.envelopeTemplateDefinition.constructFromObject is not a function.
 
 ### Changed
 - Updated the package with the latest API release.
 
 ## [2.1.0] - 2017-01-24
 ### Added
 - Documentation about several Authentication methods supported by DocuSign API.
-
+- Changelog to keep track of release highlights.
 ### Changed
 - Support for DocuSign Core release 16.1.00.00.
 - Code snippet to use base URL from the login call. Required for integrations when they go live.

README.md

@@ -6,11 +6,11 @@
 [![bitHound Overall Score][bitHound-image]][bitHound-url]
 [![Dependency Status] [david-image]][david-url]
 
-> [NPM module](https://www.npmjs.com/package/docusign-esign) that wraps the <a href="https://www.docusign.com">DocuSign</a> API
+[NPM module](https://www.npmjs.com/package/docusign-esign) that wraps the <a href="https://www.docusign.com">DocuSign</a> API
 
 [Documentation about the DocuSign API](https://www.docusign.com/developer-center)
 
-[Documentation about this package](http://docusign.github.io/docusign-node-client)
+[Documentation about this package](http://docusign.github.io/docusign-node-client/docusign-esign/3.0.0/module-index.html)
 <!---
 [Changelog](./CHANGELOG.md)
 commented out
@@ -22,7 +22,7 @@ You can sign up for a free [developer sandbox](https://www.docusign.com/develope
 Requirements
 ============
 
-Node 0.10 or later.
+Node 2.2.1 or later.
 
 Installation
 ============
@@ -37,13 +37,122 @@ Alternatively you can just copy the source code directly into your project.
 
 This client has the following external dependencies:
 
-* superagent 1.7.1
+* superagent@1.7.1
 
 Usage
 =====
 
 To initialize the client, make the Login API Call and send a template for signature:
+### SDK version 3.x.x
+```javascript
+var docusign = require('docusign-esign');
+var async = require('async');
+
+var integratorKey = '***';                    // Integrator Key associated with your DocuSign Integration
+var email = 'YOUR_EMAIL';                     // Email for your DocuSign Account
+var password = 'YOUR_PASSWORD';               // Password for your DocuSign Account
+var docusignEnv = 'demo';                     // DocuSign Environment generally demo for testing purposes
+var fullName = 'Joan Jett';                   // Recipient's Full Name
+var recipientEmail = '[email protected]'; // Recipient's Email
+var templateId = '***';                       // ID of the Template you want to create the Envelope with
+var templateRoleName = '***';                 // Role Name of the Template
+
+var baseUrl = 'https://' + docusignEnv + '.docusign.net/restapi';
+
+// initialize the api client
+var apiClient = new docusign.ApiClient();
+apiClient.setBasePath(baseUrl);
+
+// create JSON formatted auth header
+var creds = JSON.stringify({
+  Username: email,
+  Password: password,
+  IntegratorKey: integratorKey
+});
+apiClient.addDefaultHeader('X-DocuSign-Authentication', creds);
+
+// assign api client to the Configuration object
+docusign.Configuration.default.setDefaultApiClient(apiClient);
+
+async.waterfall([
+  function login (next) {
+    // login call available off the AuthenticationApi
+    var authApi = new docusign.AuthenticationApi();
+
+    // login has some optional parameters we can set
+    var loginOps = {};
+    loginOps.apiPassword = 'true';
+    loginOps.includeAccountIdGuid = 'true';
+    authApi.login(loginOps, function (err, loginInfo, response) {
+      if (err) {
+        return next(err);
+      }
+      if (loginInfo) {
+        // list of user account(s)
+        // note that a given user may be a member of multiple accounts
+        var loginAccounts = loginInfo.loginAccounts;
+        console.log('LoginInformation: ' + JSON.stringify(loginAccounts));
+        var loginAccount = loginAccounts[0];
+        var accountId = loginAccount.accountId;
+        var baseUrl = loginAccount.baseUrl;
+        var accountDomain = baseUrl.split("/v2");
+
+        // below code required for production, no effect in demo (same domain)
+        apiClient.setBasePath(accountDomain[0]);
+        docusign.Configuration.default.setDefaultApiClient(apiClient);
+        next(null, loginAccount);
+      }
+    });
+  },
+
+  function sendTemplate (loginAccount, next) {
+    // create a new envelope object that we will manage the signature request through
+    var envDef = new docusign.EnvelopeDefinition();
+    envDef.emailSubject = 'Please sign this document sent from Node SDK';
+    envDef.templateId = templateId;
+
+    // create a template role with a valid templateId and roleName and assign signer info
+    var tRole = new docusign.TemplateRole();
+    tRole.roleName = templateRoleName;
+    tRole.name = fullName;
+    tRole.email = recipientEmail;
+
+    // create a list of template roles and add our newly created role
+    var templateRolesList = [];
+    templateRolesList.push(tRole);
+
+    // assign template role(s) to the envelope
+    envDef.templateRoles = templateRolesList;
+
+    // send the envelope by setting |status| to 'sent'. To save as a draft set to 'created'
+    envDef.status = 'sent';
+
+    // use the |accountId| we retrieved through the Login API to create the Envelope
+    var accountId = loginAccount.accountId;
+
+    // instantiate a new EnvelopesApi object
+    var envelopesApi = new docusign.EnvelopesApi();
 
+    // call the createEnvelope() API
+    envelopesApi.createEnvelope(accountId, {'envelopeDefinition': envDef}, function (err, envelopeSummary, response) {
+      if (err) {
+        return next(err);
+      }
+      console.log('EnvelopeSummary: ' + JSON.stringify(envelopeSummary));
+      next(null);
+    });
+  }
+
+], function end (error) {
+  if (error) {
+    console.log('Error: ', error);
+    process.exit(1);
+  }
+  process.exit();
+});
+```
+
+### SDK version 2.x.x
 ```javascript
 var docusign = require('docusign-esign');
 var async = require('async');
@@ -180,7 +289,12 @@ The url for the Userinfo method is account-d.docusign.com for the demo/developer
 Testing
 =======
 
-Unit tests are available in the [Test](./test) folder.
+Unit tests are available in the [Test](https://github.com/docusign/docusign-node-client/tree/master/test) folder.
+
+Contributing
+============
+
+**This SDK is auto-generated from OpenAPI specification file. For that reason, we actually do NOT accept pull requests. If you find a bug or have an idea that you want to see in the SDK, please open a new [issue](https://github.com/docusign/docusign-node-client/issues/new).**
 
 Support
 =======
@@ -192,10 +306,6 @@ License
 
 The DocuSign Node Client is licensed under the following [License](LICENSE).
 
-Notes
-=======
-
-This version of the client library does not implement all of the DocuSign REST API methods. The current client omits methods in the Accounts, Billing, Cloud Storage, Connect, Groups (Branding), and Templates (Bulk Recipients) categories. The client's methods support the core set of use cases that most integrations will encounter. For a complete list of omitted endpoints, see [Omitted Endpoints](./omitted_endpoints.md).
 
 [npm-image]: https://img.shields.io/npm/v/docusign-esign.svg?style=flat
 [npm-url]: https://npmjs.org/package/docusign-esign