Merge pull request #5 from reside-eng/update-version

Update version

.gitignore

@@ -6,3 +6,6 @@ auth-info.json
 config.json
 .idea/
 npm-debug.log
+package-lock.json
+.swagger-codegen/
+test/assert-equals.js

.swagger-codegen-ignore

@@ -30,13 +30,13 @@ git_push.sh
 
 # Project files
 LICENSE
-package.json
 .travis.yml
 mocha.opts
 
 # Specific src and test files
 docs/*.md
 test/*/*.spec.js
+test/assert-equals.js
 src/OAuth.js
 src/RestApi.js
 src/ApiClient.js

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v5.6.0] - eSignature API v2.1-20.2.02.02
+### Changed
+- Added support for version v2.1-20.2.02.02 of the DocuSign eSignature API.
+- Updated the SDK release version.
+
+## [v5.5.0] - eSignature API v2.1-20.2.00
+### Changed
+- Added support for version v2.1-20.2.00 of the DocuSign eSignature API.
+- Updated the SDK release version.
+- Added properties `batchSize`, `queueLimit`, and `totalQueued` to bulk send response.
+
 ## [v5.4.0] - eSignature API v2.1-20.1.02
 ### Changed
 - Added support for version v2.1-20.1.02 of the DocuSign eSignature API.

README.md

@@ -23,8 +23,6 @@
 commented out
 -->
 
-<p><h3>&#x26A0;&#xFE0F; This client library is for the new <code><a href=“https://developers.docusign.com/esign-rest-api“>eSignature API v2.1</a></code>.<p><h3>We will continue to release client libraries for API v2, but please note that the v2 version of our API will be subject to deprecation soon and the published client libraries for it are not actively maintained.</p>
-
 ## Requirements
 - Node 4
 - Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
@@ -66,7 +64,7 @@ This client has the following external dependencies:
 
 ### Launchers
 
-DocuSign provides a sample application referred to as a [Launcher](https://github.com/docusign/eg-03-node-auth-code-grant). The Launcher contains a set of 18 common use cases and associated source files. These examples use DocuSign&#39;s [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
+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.
 
 ### Proof-of-concept applications
 
@@ -80,8 +78,8 @@ For security purposes, DocuSign recommends using the [Authorization Code Grant](
 
 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:
 
-- [JWT (JSON Web Token)](https://github.com/docusign/eg-01-node-jwt)
-- Implicit Grant (coming soon)
+- [JWT (JSON Web Token)](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken)
+- [Implicit Grant] (https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-implicit)
 
 ## Support
 
@@ -99,3 +97,9 @@ The DocuSign Node Client is licensed under the [MIT License](https://github.com/
 [travis-url]: https://travis-ci.org/docusign/docusign-node-client
 [coveralls-image]: https://coveralls.io/repos/github/docusign/DocuSign-Node-Client/badge.svg?branch=master
 [coveralls-url]: https://coveralls.io/github/docusign/DocuSign-Node-Client?branch=master
+
+### Additional Resources
+* [DocuSign Developer Center](https://developers.docusign.com)
+* [DocuSign API on Twitter](https://twitter.com/docusignapi)
+* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
+* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@side/docusign-esign",
-  "version": "5.4.1",
+  "version": "5.6.1",
   "description": "DocuSign Node.js API client.",
   "license": "MIT",
   "main": "src/index.js",

src/api/BulkEnvelopesApi.js

@@ -12,18 +12,18 @@
 (function(root, factory) {
   if (typeof define === 'function' && define.amd) {
     // AMD. Register as an anonymous module.
-	define(['Configuration', 'ApiClient', 'model/BulkEnvelopeStatus', 'model/BulkEnvelopesResponse', 'model/BulkRecipientsResponse', 'model/BulkRecipientsSummaryResponse', 'model/BulkRecipientsUpdateResponse', 'model/BulkSendRequest', 'model/BulkSendResponse', 'model/BulkSendTestResponse', 'model/BulkSendingList', 'model/BulkSendingListSummaries', 'model/ErrorDetails'], factory);
+	define(['Configuration', 'ApiClient', 'model/BulkEnvelopeStatus', 'model/BulkEnvelopesResponse', 'model/BulkRecipientsResponse', 'model/BulkRecipientsSummaryResponse', 'model/BulkRecipientsUpdateResponse', 'model/BulkSendBatchStatus', 'model/BulkSendBatchSummaries', 'model/BulkSendRequest', 'model/BulkSendResponse', 'model/BulkSendTestResponse', 'model/BulkSendingList', 'model/BulkSendingListSummaries', 'model/ErrorDetails'], factory);
   } else if (typeof module === 'object' && module.exports) {
     // CommonJS-like environments that support module.exports, like Node.
-    module.exports = factory(require('../Configuration'), require('../ApiClient'), require('../model/BulkEnvelopeStatus'), require('../model/BulkEnvelopesResponse'), require('../model/BulkRecipientsResponse'), require('../model/BulkRecipientsSummaryResponse'), require('../model/BulkRecipientsUpdateResponse'), require('../model/BulkSendRequest'), require('../model/BulkSendResponse'), require('../model/BulkSendTestResponse'), require('../model/BulkSendingList'), require('../model/BulkSendingListSummaries'), require('../model/ErrorDetails'));
+    module.exports = factory(require('../Configuration'), require('../ApiClient'), require('../model/BulkEnvelopeStatus'), require('../model/BulkEnvelopesResponse'), require('../model/BulkRecipientsResponse'), require('../model/BulkRecipientsSummaryResponse'), require('../model/BulkRecipientsUpdateResponse'), require('../model/BulkSendBatchStatus'), require('../model/BulkSendBatchSummaries'), require('../model/BulkSendRequest'), require('../model/BulkSendResponse'), require('../model/BulkSendTestResponse'), require('../model/BulkSendingList'), require('../model/BulkSendingListSummaries'), require('../model/ErrorDetails'));
   } else {
     // Browser globals (root is window)
     if (!root.Docusign) {
       root.Docusign = {};
     }
-    root.Docusign.BulkEnvelopesApi = factory(root.Docusign.Configuration, root.Docusign.ApiClient, root.Docusign.BulkEnvelopeStatus, root.Docusign.BulkEnvelopesResponse, root.Docusign.BulkRecipientsResponse, root.Docusign.BulkRecipientsSummaryResponse, root.Docusign.BulkRecipientsUpdateResponse, root.Docusign.BulkSendRequest, root.Docusign.BulkSendResponse, root.Docusign.BulkSendTestResponse, root.Docusign.BulkSendingList, root.Docusign.BulkSendingListSummaries, root.Docusign.ErrorDetails);
+    root.Docusign.BulkEnvelopesApi = factory(root.Docusign.Configuration, root.Docusign.ApiClient, root.Docusign.BulkEnvelopeStatus, root.Docusign.BulkEnvelopesResponse, root.Docusign.BulkRecipientsResponse, root.Docusign.BulkRecipientsSummaryResponse, root.Docusign.BulkRecipientsUpdateResponse, root.Docusign.BulkSendBatchStatus, root.Docusign.BulkSendBatchSummaries, root.Docusign.BulkSendRequest, root.Docusign.BulkSendResponse, root.Docusign.BulkSendTestResponse, root.Docusign.BulkSendingList, root.Docusign.BulkSendingListSummaries, root.Docusign.ErrorDetails);
   }
-}(this, function(Configuration, ApiClient, BulkEnvelopeStatus, BulkEnvelopesResponse, BulkRecipientsResponse, BulkRecipientsSummaryResponse, BulkRecipientsUpdateResponse, BulkSendRequest, BulkSendResponse, BulkSendTestResponse, BulkSendingList, BulkSendingListSummaries, ErrorDetails) {
+}(this, function(Configuration, ApiClient, BulkEnvelopeStatus, BulkEnvelopesResponse, BulkRecipientsResponse, BulkRecipientsSummaryResponse, BulkRecipientsUpdateResponse, BulkSendBatchStatus, BulkSendBatchSummaries, BulkSendRequest, BulkSendResponse, BulkSendTestResponse, BulkSendingList, BulkSendingListSummaries, ErrorDetails) {
   'use strict';
 
   /**
@@ -444,6 +444,131 @@ After using this, the `bulkRecipientsUri` property is not returned in subsequent
       );
     };
 
+    /**
+     * (Optional) Callback function to receive the result of the getBulkSendBatchStatus operation. If none specified a Promise will be returned.
+     * @callback module:api/BulkEnvelopesApi~getBulkSendBatchStatusCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/BulkSendBatchStatus} data The data returned by the service call.
+     * @param {String} If a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.
+     */
+
+    /**
+     * Gets a specific bulk send batch status
+     * @param {String} accountId The external account number (int) or account ID Guid.
+     * @param {String} bulkSendBatchId 
+     * @param {module:api/BulkEnvelopesApi~getBulkSendBatchStatusCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/BulkSendBatchStatus}
+     */
+    this.getBulkSendBatchStatus = function(accountId, bulkSendBatchId, callback) {
+      var postBody = null;
+
+      // verify the required parameter 'accountId' is set
+      if (accountId === undefined || accountId === null) {
+        throw new Error("Missing the required parameter 'accountId' when calling getBulkSendBatchStatus");
+      }
+
+      // verify the required parameter 'bulkSendBatchId' is set
+      if (bulkSendBatchId === undefined || bulkSendBatchId === null) {
+        throw new Error("Missing the required parameter 'bulkSendBatchId' when calling getBulkSendBatchStatus");
+      }
+
+      if (typeof callback !== 'function' &&  arguments.length && typeof arguments[arguments.length-1] === 'function'){
+        if (typeof optsOrCallback !== 'undefined') {
+          optsOrCallback = callback;
+        }
+        callback = arguments[arguments.length-1];
+      }
+
+      var pathParams = {
+        'accountId': accountId,
+        'bulkSendBatchId': bulkSendBatchId
+      };
+      var queryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['docusignAccessCode'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = BulkSendBatchStatus;
+
+      return this.apiClient.callApi(
+        '/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    };
+
+    /**
+     * (Optional) Callback function to receive the result of the getBulkSendBatches operation. If none specified a Promise will be returned.
+     * @callback module:api/BulkEnvelopesApi~getBulkSendBatchesCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/BulkSendBatchSummaries} data The data returned by the service call.
+     * @param {String} If a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.
+     */
+
+    /**
+     * Returns a list of bulk send batch satuses initiated by account.
+     * @param {String} accountId The external account number (int) or account ID Guid.
+     * @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
+     * @param {String} optsOrCallback.batchIds 
+     * @param {String} optsOrCallback.count 
+     * @param {String} optsOrCallback.startPosition 
+     * @param {String} optsOrCallback.status 
+     * @param {module:api/BulkEnvelopesApi~getBulkSendBatchesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/BulkSendBatchSummaries}
+     */
+    this.getBulkSendBatches = function(accountId, optsOrCallback, callback) {
+      optsOrCallback = optsOrCallback || {};
+
+      if (typeof optsOrCallback === 'function') {
+        callback = optsOrCallback;
+        optsOrCallback = {};
+      }
+
+      var postBody = null;
+
+      // verify the required parameter 'accountId' is set
+      if (accountId === undefined || accountId === null) {
+        throw new Error("Missing the required parameter 'accountId' when calling getBulkSendBatches");
+      }
+
+      if (typeof callback !== 'function' &&  arguments.length && typeof arguments[arguments.length-1] === 'function'){
+        if (typeof optsOrCallback !== 'undefined') {
+          optsOrCallback = callback;
+        }
+        callback = arguments[arguments.length-1];
+      }
+
+      var pathParams = {
+        'accountId': accountId
+      };
+      var queryParams = {
+        'batch_ids': optsOrCallback['batchIds'],
+        'count': optsOrCallback['count'],
+        'start_position': optsOrCallback['startPosition'],
+        'status': optsOrCallback['status']
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['docusignAccessCode'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = BulkSendBatchSummaries;
+
+      return this.apiClient.callApi(
+        '/v2.1/accounts/{accountId}/bulk_send_batch', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    };
+
     /**
      * (Optional) Callback function to receive the result of the getBulkSendList operation. If none specified a Promise will be returned.
      * @callback module:api/BulkEnvelopesApi~getBulkSendListCallback
@@ -647,7 +772,6 @@ The response returns information about the envelopes sent with bulk recipient ba
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
      * @param {String} optsOrCallback.count The number of results to return. This can be 1 to 20.
-     * @param {String} optsOrCallback.include 
      * @param {String} optsOrCallback.startPosition The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0.
      * @param {module:api/BulkEnvelopesApi~listCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/BulkEnvelopesResponse}
@@ -679,7 +803,6 @@ The response returns information about the envelopes sent with bulk recipient ba
       };
       var queryParams = {
         'count': optsOrCallback['count'],
-        'include': optsOrCallback['include'],
         'start_position': optsOrCallback['startPosition']
       };
       var headerParams = {
@@ -783,6 +906,7 @@ The REST API does not support modifying individual rows or values in the bulk re
      * @param {String} envelopeId The envelope's GUID. 
 
 Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`
+
      * @param {String} recipientId A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.
      * @param {Blob} bulkRecipientsRequest 
      * @param {module:api/BulkEnvelopesApi~updateRecipientsCallback} callback The callback function, accepting three arguments: error, data, response