Version 6.4.0-v2.1-23.3.00.01 release (#334)

Co-authored-by: root <[email protected]>

Author: raileendr

CHANGELOG.md

@@ -2,6 +2,11 @@
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
 
+## [v6.4.0] - eSignature API v2.1-23.3.00.01 - 2023-08-30
+### Changed
+- Added support for version v2.1-23.3.00.01 of the DocuSign ESignature API.
+- Updated the SDK release version.
+
 ## [v6.3.0] - eSignature API v2.1-23.2.00.00 - 2023-05-15
 ### Changed
 - Added support for version v2.1-23.2.00.00 of the DocuSign ESignature API.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusign-esign",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "description": "DocuSign Node.js API client.",
   "license": "MIT",
   "main": "src/index.js",
@@ -55,7 +55,8 @@
     "jsonwebtoken": "^9.0.0",
     "passport-oauth2": "^1.6.1",
     "safe-buffer": "^5.1.2",
-    "superagent": "3.8.2"
+    "superagent": "3.8.2",
+    "superagent-proxy": "^2.0.0"
   },
   "devDependencies": {
     "docdash": "0.4.0",

src/ApiClient.js

@@ -12,17 +12,18 @@
   if (typeof define === 'function' && define.amd) {
     // AMD. Register as an anonymous module.
     define(['superagent'], factory);
+    define(['superagent-proxy'], factory);
   } else if (typeof module === 'object' && module.exports) {
     // CommonJS-like environments that support module.exports, like Node.
-    module.exports = factory(require('superagent'));
+    module.exports = factory(require('superagent'), require('superagent-proxy'));
   } else {
     // Browser globals (root is window)
     if (!root.Docusign) {
       root.Docusign = {};
     }
-    root.Docusign.ApiClient = factory(root.superagent, opts);
+    root.Docusign.ApiClient = factory(root.superagent, root.superagentProxy, opts);
   }
-}(this, function(superagent, opts) {
+}(this, function(superagent, superagentProxy, opts) {
   'use strict';
 
   var SCOPE_SIGNATURE = "signature";
@@ -65,9 +66,14 @@
     return jwt.sign(jwtPayload, privateKey, { algorithm: JWT_SIGNING_ALGO });
   };
 
-  var sendJWTTokenRequest = function (assertion, oAuthBasePath, callback) {
-    var request = superagent.post("https://" + oAuthBasePath + "/oauth/token")
-      .timeout(exports.prototype.timeout)
+  var sendJWTTokenRequest = function (assertion, oAuthBasePath, proxy, callback) {
+    var request = superagentProxy(superagent)
+      .post("https://" + oAuthBasePath + "/oauth/token");
+
+    if (proxy)
+      request.proxy(proxy)
+
+    request.timeout(exports.prototype.timeout)        
       .set('Content-Type', 'application/x-www-form-urlencoded')
       .set('Cache-Control', 'no-store')
       .set('Pragma', 'no-cache')
@@ -128,6 +134,14 @@
     opts = Object.assign({},defaults, opts);
     opts.oAuthBasePath = deriveOAuthBasePathFromRestBasePath(opts.basePath);
 
+    /**
+     * The full URI for the desired proxy.
+     * A complete list of supported proxies can be found here: https://www.npmjs.com/package/proxy-agent.     
+     * @type {String}
+     * @default 
+     */
+    this.proxy = opts.proxy;
+
     /**
      * The base URL against which to resolve every API call's (relative) path.
      * @type {String}
@@ -495,7 +509,13 @@
 
     var _this = this;
     var url = this.buildUrl(path, pathParams);
-    var request = superagent(httpMethod, url);
+    var request = superagentProxy(superagent(httpMethod, url));
+
+    //apply proxy if specified
+    if(this.proxy) {
+      request.proxy(this.proxy);
+    }
+    
     var _formParams = this.normalizeParams(formParams);
     var body = httpMethod.toUpperCase() === 'GET' && !bodyParam ? undefined : bodyParam || {};
 
@@ -799,7 +819,12 @@
       "Pragma": "no-cache"
     }
 
-    var request = superagent.get("https://" + this.getOAuthBasePath() + "/oauth/userinfo").set(headers);
+    var request = superagentProxy(superagent).get("https://" + this.getOAuthBasePath() + "/oauth/userinfo").set(headers);
+
+    if (this.proxy) {
+      request.proxy(this.proxy);
+    }
+    
     var UserInfo = require('./OAuth').UserInfo;
 
 
@@ -916,14 +941,14 @@
     var privateKey = rsaPrivateKey,
       assertion = generateAndSignJWTAssertion(clientId, scopes, privateKey, this.getOAuthBasePath(), expiresIn, userId);
 
-    return sendJWTTokenRequest(assertion, this.oAuthBasePath, callback);
+    return sendJWTTokenRequest(assertion, this.oAuthBasePath, this.proxy, callback);
   };
 
   exports.prototype.requestJWTApplicationToken = function(clientId, scopes, rsaPrivateKey, expiresIn, callback) {
     var privateKey = rsaPrivateKey,
       assertion = generateAndSignJWTAssertion(clientId, scopes, privateKey, this.getOAuthBasePath(), expiresIn);
 
-    return sendJWTTokenRequest(assertion, this.oAuthBasePath, callback);
+    return sendJWTTokenRequest(assertion, this.oAuthBasePath, this.proxy, callback);
   };
 
   exports.prototype.OAuth = require('./OAuth');

src/api/AccountsApi.js

@@ -63,9 +63,18 @@
      * Deletes the specified account.
      * This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
      * @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.redactUserData 
      * @param {module:api/AccountsApi~_deleteCallback} callback The callback function, accepting three arguments: error, data, response
      */
-    this._delete = function(accountId, callback) {
+    this._delete = function(accountId, optsOrCallback, callback) {
+      optsOrCallback = optsOrCallback || {};
+
+      if (typeof optsOrCallback === 'function') {
+        callback = optsOrCallback;
+        optsOrCallback = {};
+      }
+
       var postBody = null;
 
       // verify the required parameter 'accountId' is set
@@ -84,6 +93,7 @@
         'accountId': accountId
       };
       var queryParams = {
+        'redact_user_data': optsOrCallback['redactUserData']
       };
       var headerParams = {
       };
@@ -1285,10 +1295,19 @@ To delete a permission profile, it must not have any users associated with it. W
 
 
      * @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.identityVerificationWorkflowStatus 
      * @param {module:api/AccountsApi~getAccountIdentityVerificationCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/AccountIdentityVerificationResponse}
      */
-    this.getAccountIdentityVerification = function(accountId, callback) {
+    this.getAccountIdentityVerification = function(accountId, optsOrCallback, callback) {
+      optsOrCallback = optsOrCallback || {};
+
+      if (typeof optsOrCallback === 'function') {
+        callback = optsOrCallback;
+        optsOrCallback = {};
+      }
+
       var postBody = null;
 
       // verify the required parameter 'accountId' is set
@@ -1307,6 +1326,7 @@ To delete a permission profile, it must not have any users associated with it. W
         'accountId': accountId
       };
       var queryParams = {
+        'identity_verification_workflow_status': optsOrCallback['identityVerificationWorkflowStatus']
       };
       var headerParams = {
       };
@@ -2196,7 +2216,7 @@ A brand uses a set of brand resource files to control the sending, signing, emai
      * Gets the Electronic Record and Signature Disclosure.
      * Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.  
      * @param {String} accountId The external account number (int) or account ID Guid.
-     * @param {String} langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
+     * @param {String} langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
      * @param {module:api/AccountsApi~getConsumerDisclosureCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/ConsumerDisclosure}
      */
@@ -4156,7 +4176,7 @@ When you update a custom disclosure, you can update all of the properties except
 
 
      * @param {String} accountId The external account number (int) or account ID Guid.
-     * @param {String} langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
+     * @param {String} langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
      * @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.includeMetadata 
      * @param {module:model/ConsumerDisclosure} optsOrCallback.consumerDisclosure 

src/api/EnvelopesApi.js

@@ -3773,7 +3773,7 @@ If the envelope is `In Process`, meaning that it has been sent and has not  been
      * (Optional) Callback function to receive the result of the getAttachment operation. If none specified a Promise will be returned.
      * @callback module:api/EnvelopesApi~getAttachmentCallback
      * @param {String} error Error message, if any.
-     * @param data This operation does not return a value.
+     * @param {Object} 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.
      */
 
@@ -3784,6 +3784,7 @@ If the envelope is `In Process`, meaning that it has been sent and has not  been
      * @param {String} envelopeId The envelopeId Guid of the envelope being accessed.
      * @param {String} attachmentId 
      * @param {module:api/EnvelopesApi~getAttachmentCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Object}
      */
     this.getAttachment = function(accountId, envelopeId, attachmentId, callback) {
       var postBody = null;
@@ -3824,8 +3825,8 @@ If the envelope is `In Process`, meaning that it has been sent and has not  been
 
       var authNames = ['docusignAccessCode'];
       var contentTypes = [];
-      var accepts = ['application/json'];
-      var returnType = null;
+      var accepts = ['application/octet-stream'];
+      var returnType = Object;
 
       return this.apiClient.callApi(
         '/v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId}', 'GET',
@@ -4053,7 +4054,7 @@ stream.
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} envelopeId The envelopeId Guid of the envelope being accessed.
      * @param {String} recipientId The ID of the recipient being accessed.
-     * @param {String} langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
+     * @param {String} langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
      * @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.langCode2 The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
      * @param {module:api/EnvelopesApi~getConsumerDisclosureCallback} callback The callback function, accepting three arguments: error, data, response
@@ -6588,6 +6589,7 @@ Client applications should check that the statuses they are requesting make sens
      * @param {String} optsOrCallback.powerformids 
      * @param {String} optsOrCallback.queryBudget 
      * @param {String} optsOrCallback.requesterDateFormat 
+     * @param {String} optsOrCallback.searchMode 
      * @param {String} optsOrCallback.searchText 
      * @param {String} optsOrCallback.startPosition 
      * @param {String} optsOrCallback.status The list of current statuses to include in the response. By default, all envelopes found are returned. If values are specified, then of the envelopes found, only those with the current status specified are returned in the results.   Possible values are: Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
@@ -6647,6 +6649,7 @@ Client applications should check that the statuses they are requesting make sens
         'powerformids': optsOrCallback['powerformids'],
         'query_budget': optsOrCallback['queryBudget'],
         'requester_date_format': optsOrCallback['requesterDateFormat'],
+        'search_mode': optsOrCallback['searchMode'],
         'search_text': optsOrCallback['searchText'],
         'start_position': optsOrCallback['startPosition'],
         'status': optsOrCallback['status'],