Version 5.19.0-v2.1-22.3.00.00 release (#308)

Co-authored-by: root <root@devcenteradmin.docusigntest.com>

Author: harsharahul

CHANGELOG.md

@@ -2,6 +2,11 @@
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
 
+## [v5.19.0] - eSignature API v2.1-22.3.00.00 - 2022-09-07
+### Changed
+- Added support for version v2.1-22.3.00.00 of the DocuSign ESignature API.
+- Updated the SDK release version.
+
 ## [v5.18.0] - eSignature API v2.1-22.2.00.00 - 2022-06-23
 ### Changed
 - Added support for version v2.1-22.2.00.00 of the DocuSign ESignature API.

package.json

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

src/api/AccountsApi.js

@@ -113,6 +113,7 @@
 
     /**
      * Get metadata for a given credit card.
+     * This method returns information about a credit card associated with an account.
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {module:api/BillingApi~getCreditCardInfoCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CreditCardInformation}
@@ -164,6 +165,7 @@
 
     /**
      * Returns downgrade plan information for the specified account.
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {module:api/BillingApi~getDowngradeRequestBillingInfoCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/DowngradRequestBillingInfoResponse}
@@ -804,6 +806,7 @@ Privileges required: account administrator
 
     /**
      * Queues downgrade billing plan request for an 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 {module:model/DowngradeBillingPlanInformation} optsOrCallback.downgradeBillingPlanInformation 

src/api/BillingApi.js

@@ -61,6 +61,7 @@
 
     /**
      * Uses the specified bulk envelopes list to update the envelopes specified in the payload
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {module:api/BulkProcessDataApi~createBulkProcessRequestCallback} callback The callback function, accepting three arguments: error, data, response
@@ -118,6 +119,7 @@
 
     /**
      * Uses the specified bulk envelopes list to update the envelopes specified in the payload
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {String} bulkProcessListId 
@@ -192,6 +194,7 @@
 
     /**
      * Deletes a specific bulk process list
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {String} bulkProcessListId 
@@ -257,6 +260,7 @@
 
     /**
      * Deletes a specific bulk process list
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
@@ -324,6 +328,7 @@
 
     /**
      * Gets a specific bulk process list
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {String} bulkProcessListId 
@@ -388,6 +393,7 @@
 
     /**
      * Lists top-level details for all bulk process lists visible to the current user
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {module:api/BulkProcessDataApi~getBulkProcessListsCallback} callback The callback function, accepting three arguments: error, data, response
@@ -446,6 +452,7 @@
 
     /**
      * Updates a specific bulk process list
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {String} bulkProcessListId 

src/api/BulkEnvelopesApi.js

@@ -61,6 +61,7 @@
 
     /**
      * Uses the specified bulk envelopes list to update the envelopes specified in the payload
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {String} bulkProcessListId 
@@ -135,6 +136,7 @@
 
     /**
      * Deletes a specific bulk process list
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {String} bulkProcessListId 
@@ -200,6 +202,7 @@
 
     /**
      * Gets a specific bulk process list
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {String} bulkProcessListId 
@@ -264,6 +267,7 @@
 
     /**
      * Updates a specific bulk process list
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} processAction 
      * @param {String} bulkProcessListId 

src/api/BulkProcessDataApi.js

@@ -12,18 +12,18 @@
 (function(root, factory) {
   if (typeof define === 'function' && define.amd) {
     // AMD. Register as an anonymous module.
-	define(['Configuration', 'ApiClient', 'model/ConnectConfigResults', 'model/ConnectCustomConfiguration', 'model/ConnectDeleteFailureResult', 'model/ConnectFailureFilter', 'model/ConnectFailureResults', 'model/ConnectLog', 'model/ConnectLogs', 'model/ErrorDetails', 'model/IntegratedConnectUserInfoList', 'model/IntegratedUserInfoList', 'model/MobileNotifierConfigurationInformation'], factory);
+	define(['Configuration', 'ApiClient', 'model/ConnectConfigResults', 'model/ConnectCustomConfiguration', 'model/ConnectDeleteFailureResult', 'model/ConnectFailureFilter', 'model/ConnectFailureResults', 'model/ConnectLog', 'model/ConnectLogs', 'model/ConnectOAuthConfig', 'model/ErrorDetails', 'model/IntegratedConnectUserInfoList', 'model/IntegratedUserInfoList', 'model/MobileNotifierConfigurationInformation'], 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/ConnectConfigResults'), require('../model/ConnectCustomConfiguration'), require('../model/ConnectDeleteFailureResult'), require('../model/ConnectFailureFilter'), require('../model/ConnectFailureResults'), require('../model/ConnectLog'), require('../model/ConnectLogs'), require('../model/ErrorDetails'), require('../model/IntegratedConnectUserInfoList'), require('../model/IntegratedUserInfoList'), require('../model/MobileNotifierConfigurationInformation'));
+    module.exports = factory(require('../Configuration'), require('../ApiClient'), require('../model/ConnectConfigResults'), require('../model/ConnectCustomConfiguration'), require('../model/ConnectDeleteFailureResult'), require('../model/ConnectFailureFilter'), require('../model/ConnectFailureResults'), require('../model/ConnectLog'), require('../model/ConnectLogs'), require('../model/ConnectOAuthConfig'), require('../model/ErrorDetails'), require('../model/IntegratedConnectUserInfoList'), require('../model/IntegratedUserInfoList'), require('../model/MobileNotifierConfigurationInformation'));
   } else {
     // Browser globals (root is window)
     if (!root.Docusign) {
       root.Docusign = {};
     }
-    root.Docusign.ConnectApi = factory(root.Docusign.Configuration, root.Docusign.ApiClient, root.Docusign.ConnectConfigResults, root.Docusign.ConnectCustomConfiguration, root.Docusign.ConnectDeleteFailureResult, root.Docusign.ConnectFailureFilter, root.Docusign.ConnectFailureResults, root.Docusign.ConnectLog, root.Docusign.ConnectLogs, root.Docusign.ErrorDetails, root.Docusign.IntegratedConnectUserInfoList, root.Docusign.IntegratedUserInfoList, root.Docusign.MobileNotifierConfigurationInformation);
+    root.Docusign.ConnectApi = factory(root.Docusign.Configuration, root.Docusign.ApiClient, root.Docusign.ConnectConfigResults, root.Docusign.ConnectCustomConfiguration, root.Docusign.ConnectDeleteFailureResult, root.Docusign.ConnectFailureFilter, root.Docusign.ConnectFailureResults, root.Docusign.ConnectLog, root.Docusign.ConnectLogs, root.Docusign.ConnectOAuthConfig, root.Docusign.ErrorDetails, root.Docusign.IntegratedConnectUserInfoList, root.Docusign.IntegratedUserInfoList, root.Docusign.MobileNotifierConfigurationInformation);
   }
-}(this, function(Configuration, ApiClient, ConnectConfigResults, ConnectCustomConfiguration, ConnectDeleteFailureResult, ConnectFailureFilter, ConnectFailureResults, ConnectLog, ConnectLogs, ErrorDetails, IntegratedConnectUserInfoList, IntegratedUserInfoList, MobileNotifierConfigurationInformation) {
+}(this, function(Configuration, ApiClient, ConnectConfigResults, ConnectCustomConfiguration, ConnectDeleteFailureResult, ConnectFailureFilter, ConnectFailureResults, ConnectLog, ConnectLogs, ConnectOAuthConfig, ErrorDetails, IntegratedConnectUserInfoList, IntegratedUserInfoList, MobileNotifierConfigurationInformation) {
   'use strict';
 
   /**
@@ -114,6 +114,66 @@
       );
     };
 
+    /**
+     * (Optional) Callback function to receive the result of the createConnectOAuthConfig operation. If none specified a Promise will be returned.
+     * @callback module:api/ConnectApi~createConnectOAuthConfigCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ConnectOAuthConfig} 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.
+     */
+
+    /**
+     * Sets the Connect OAuth Config for the 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 {module:model/ConnectOAuthConfig} optsOrCallback.connectOAuthConfig 
+     * @param {module:api/ConnectApi~createConnectOAuthConfigCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ConnectOAuthConfig}
+     */
+    this.createConnectOAuthConfig = function(accountId, optsOrCallback, callback) {
+      optsOrCallback = optsOrCallback || {};
+
+      if (typeof optsOrCallback === 'function') {
+        callback = optsOrCallback;
+        optsOrCallback = {};
+      }
+
+      var postBody = optsOrCallback['connectOAuthConfig'];
+
+      // verify the required parameter 'accountId' is set
+      if (accountId === undefined || accountId === null) {
+        throw new Error("Missing the required parameter 'accountId' when calling createConnectOAuthConfig");
+      }
+
+      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 = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['docusignAccessCode'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = ConnectOAuthConfig;
+
+      return this.apiClient.callApi(
+        '/v2.1/accounts/{accountId}/connect/oauth', 'POST',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    };
+
     /**
      * (Optional) Callback function to receive the result of the deleteConfiguration operation. If none specified a Promise will be returned.
      * @callback module:api/ConnectApi~deleteConfigurationCallback
@@ -177,6 +237,56 @@
       );
     };
 
+    /**
+     * (Optional) Callback function to receive the result of the deleteConnectOAuthConfig operation. If none specified a Promise will be returned.
+     * @callback module:api/ConnectApi~deleteConnectOAuthConfigCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} If a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.
+     */
+
+    /**
+     * Sets the Connect OAuth Config for the account.
+     * @param {String} accountId The external account number (int) or account ID Guid.
+     * @param {module:api/ConnectApi~deleteConnectOAuthConfigCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    this.deleteConnectOAuthConfig = function(accountId, 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 deleteConnectOAuthConfig");
+      }
+
+      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 = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['docusignAccessCode'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = null;
+
+      return this.apiClient.callApi(
+        '/v2.1/accounts/{accountId}/connect/oauth', 'DELETE',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    };
+
     /**
      * (Optional) Callback function to receive the result of the deleteEventFailureLog operation. If none specified a Promise will be returned.
      * @callback module:api/ConnectApi~deleteEventFailureLogCallback
@@ -481,6 +591,7 @@
 
     /**
      * Returns all users from the configured Connect service.
+     * 
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} connectId The ID of the custom Connect configuration being accessed.
      * @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
@@ -549,6 +660,57 @@
       );
     };
 
+    /**
+     * (Optional) Callback function to receive the result of the getConnectOAuthConfig operation. If none specified a Promise will be returned.
+     * @callback module:api/ConnectApi~getConnectOAuthConfigCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ConnectOAuthConfig} 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.
+     */
+
+    /**
+     * Sets the Connect OAuth Config for the account.
+     * @param {String} accountId The external account number (int) or account ID Guid.
+     * @param {module:api/ConnectApi~getConnectOAuthConfigCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ConnectOAuthConfig}
+     */
+    this.getConnectOAuthConfig = function(accountId, 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 getConnectOAuthConfig");
+      }
+
+      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 = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = ['docusignAccessCode'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = ConnectOAuthConfig;
+
+      return this.apiClient.callApi(
+        '/v2.1/accounts/{accountId}/connect/oauth', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, callback
+      );
+    };
+
     /**
      * (Optional) Callback function to receive the result of the getEventLog operation. If none specified a Promise will be returned.
      * @callback module:api/ConnectApi~getEventLogCallback

src/api/BulkProcessDataSendApi.js

@@ -61,6 +61,12 @@
 
     /**
      * Creates a blind carbon copy email archive entry
+     * This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates).
+
+The only property that you must set in the request body is the BCC email address that you want to use.
+
+**Note:** An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.
+
      * @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 {module:model/BccEmailArchive} optsOrCallback.bccEmailArchive 
@@ -121,6 +127,10 @@
 
     /**
      * Delete a blind carbon copy email archive for an account.
+     * This method deletes a BCC email archive configuration from an account.
+
+When you use this method, the status of the BCC email archive configuration switches to `closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.
+
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} bccEmailArchiveId 
      * @param {module:api/EmailArchiveApi~deleteBCCEmailArchiveCallback} callback The callback function, accepting three arguments: error, data, response
@@ -178,6 +188,7 @@
 
     /**
      * Get the blind carbon copy email archive history entries for the specified archive
+     * This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.
      * @param {String} accountId The external account number (int) or account ID Guid.
      * @param {String} bccEmailArchiveId 
      * @param {Object} optsOrCallback Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.
@@ -248,6 +259,7 @@
 
     /**
      * Get the blind carbon copy email archive entries owned by the specified account
+     * This method retrieves all of the BCC email archive configurations associated with an 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.count