Version 5.8.1-v2.1-20.3.01 release (#229)

Co-authored-by: DevCenter-DocuSign <[email protected]>

Author: dbbrahmbhatt

CHANGELOG.md

@@ -1,6 +1,14 @@
 # DocuSign Node Client Changelog
 
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
+## [v5.8.1] - eSignature API v2.1-20.3.01
+### Changed
+- Added support for version v2.1-20.3.01 of the DocuSign eSignature API.
+- Updated the SDK release version.
+### Fixed 
+- DCM-3866, Added support for updateBrandResourcesByContentType function to take in file to upload.
+- DCM-3369, Updated ApiClient to use an empty JSON object if the body is null.
+- DCM-4614, Fixed out of memory issue when deserializing large files.
 
 ## [v5.7.0] - eSignature API v2.1-20.3.00
 ### Changed

package.json

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

src/ApiClient.js

@@ -445,13 +445,22 @@
     // Rely on SuperAgent for parsing response body.
     // See http://visionmedia.github.io/superagent/#parsing-response-bodies
     var data = response.body || (response.res && response.res.data);
-    if (data == null || !Object.keys(data).length) {
+    if (data == null || (typeof data === 'object' && typeof data.length === 'undefined' && !Object.keys(data).length)) {
       // SuperAgent does not always produce a body; use the unparsed response as a fallback
       data = response.text;
     }
     return exports.convertToType(data, returnType);
   };
 
+  exports.prototype.hasBufferFormParam = function(formParams) {
+    if (!formParams) {
+      return false;
+    }
+    return Object.keys(formParams).some(function(key) {
+      return formParams[key] instanceof Buffer;
+    });
+  };
+
   /**
    * (Optional)Callback function to receive the result of the <operationId> operation. If none specified a Promise will be returned.
    * @callback module:ApiClient~callApiCallback
@@ -484,6 +493,8 @@
     var _this = this;
     var url = this.buildUrl(path, pathParams);
     var request = superagent(httpMethod, url);
+    var _formParams = this.normalizeParams(formParams);
+    var body = bodyParam || {};
 
     // apply authentications
     this.applyAuthToRequest(request, authNames);
@@ -513,19 +524,32 @@
     if (contentType === 'application/x-www-form-urlencoded') {
       request.send(this.normalizeParams(formParams));
     } else if (contentType == 'multipart/form-data') {
-      var _formParams = this.normalizeParams(formParams);
-      for (var key in _formParams) {
-        if (_formParams.hasOwnProperty(key)) {
-          if (this.isFileParam(_formParams[key])) {
-            // file field
-            request.attach(key, _formParams[key]);
-          } else {
-            request.field(key, _formParams[key]);
+      if (this.hasBufferFormParam(_formParams)) {
+        request.set({
+          'Content-Disposition': 'form-data; name="file"; filename="file.xml"'
+        });
+        request.set({
+          'Content-Type': 'application/octet-stream'
+        });
+        var formAttachmentKey = Object.keys(formParams).find(function(key) {
+          return _this.isFileParam(_formParams[key]);
+        });
+        request.send(removeNulls(formParams[formAttachmentKey]));
+      } else {
+        var _formParams = this.normalizeParams(formParams);
+        for (var key in _formParams) {
+          if (_formParams.hasOwnProperty(key)) {
+            if (this.isFileParam(_formParams[key])) {
+              // file field
+              request.attach(key, _formParams[key]);
+            } else {
+              request.field(key, _formParams[key]);
+            }
           }
         }
       }
-    } else if (bodyParam) {
-      request.send(removeNulls(bodyParam));
+    } else if (body) {
+      request.send(removeNulls(body));
     }
 
     var accept = this.jsonPreferredMime(accepts);
@@ -556,7 +580,6 @@
       })
     }
 
-
     var data = null;
     if (!callback) {
       return new Promise(function(resolve, reject){
@@ -791,7 +814,6 @@
           });
         });
       } catch (err) {
-        console.log(err)
         throw(err)
       }
     } else {
@@ -911,4 +933,4 @@
 }));
 
 module.exports.OAuth = require('./OAuth');
-module.exports.RestApi = require('./RestApi');
+module.exports.RestApi = require('./RestApi');

src/api/AccountsApi.js

@@ -244,7 +244,7 @@ A 201 code is returned if the call succeeded.  While the call may have succeed,
 An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version.
 
 When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
-     * @param {String} accountId The external account number (int) or account ID Guid.
+     * @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/Brand} optsOrCallback.brand 
      * @param {module:api/AccountsApi~createBrandCallback} callback The callback function, accepting three arguments: error, data, response
@@ -3654,13 +3654,19 @@ Users with account administration privileges can retrieve shared access informat
 
     /**
      * Uploads a branding resource file.
-     * @param {String} accountId The external account number (int) or account ID Guid.
-     * @param {String} brandId The unique identifier of a brand.
-     * @param {String} resourceContentType 
+     * @param {String} accountId The external account number (int) or account ID GUID.
+     * @param {String} brandId The id of the brand.
+     * @param {String} resourceContentType The type of brand resource file that you are updating. Valid values are:
+
+- `sending`
+- `signing`
+- `email`
+- `signing_captive`
+     * @param {Object} fileXml Brand resource XML file.
      * @param {module:api/AccountsApi~updateBrandResourcesByContentTypeCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/BrandResources}
      */
-    this.updateBrandResourcesByContentType = function(accountId, brandId, resourceContentType, callback) {
+    this.updateBrandResourcesByContentType = function(accountId, brandId, resourceContentType, fileXml, callback) {
       var postBody = null;
 
       // verify the required parameter 'accountId' is set
@@ -3678,6 +3684,11 @@ Users with account administration privileges can retrieve shared access informat
         throw new Error("Missing the required parameter 'resourceContentType' when calling updateBrandResourcesByContentType");
       }
 
+      // verify the required parameter 'fileXml' is set
+      if (fileXml === undefined || fileXml === null) {
+        throw new Error("Missing the required parameter 'fileXml' when calling updateBrandResourcesByContentType");
+      }
+
       if (typeof callback !== 'function' &&  arguments.length && typeof arguments[arguments.length-1] === 'function'){
         if (typeof optsOrCallback !== 'undefined') {
           optsOrCallback = callback;
@@ -3695,10 +3706,11 @@ Users with account administration privileges can retrieve shared access informat
       var headerParams = {
       };
       var formParams = {
+        'file.xml': fileXml
       };
 
       var authNames = ['docusignAccessCode'];
-      var contentTypes = [];
+      var contentTypes = ['multipart/form-data'];
       var accepts = ['application/json'];
       var returnType = BrandResources;
 

test/SdkUnitTests.js

@@ -28,7 +28,9 @@ var basePath = restApi.BasePath.DEMO;
 var oAuthBasePath = oAuth.BasePath.DEMO;
 
 var SignTest1File = 'docs/SignTest1.pdf';
+var LargeTestDocument1 = 'docs/LargeTestDocument1.pdf';
 var brandLogoPath = 'img/docusign-lgo.png';
+var brandXmlPath = 'docs/brand.xml';
 var accountId = '';
 var envelopeId = '';
 var userId = config.userId;
@@ -427,14 +429,11 @@ describe('SDK Unit Tests:', function (done) {
         if (envelopeSummary) {
           console.log('EnvelopeSummary: ' + JSON.stringify(envelopeSummary));
           envelopeId = envelopeSummary.envelopeId;
-          console.log('starwars');
           console.log(bulkRecipients);
           csvStringify(bulkRecipients, { header: true }, function (err, bulkRecipientsRequest) {
             if (err) {
               return done(err);
             }
-            console.log('starwars2');
-
             console.log(bulkRecipientsRequest);
             var byteArray = Buffer.from(bulkRecipientsRequest);
             console.log(byteArray);
@@ -671,7 +670,7 @@ describe('SDK Unit Tests:', function (done) {
     try {
       var fs = require('fs');
       // read file from a local directory
-      fileBytes = fs.readFileSync(path.resolve(__dirname, SignTest1File));
+      fileBytes = fs.readFileSync(path.resolve(__dirname, LargeTestDocument1));
     } catch (ex) {
       // handle error
       console.log('Exception: ' + ex);
@@ -823,6 +822,38 @@ describe('SDK Unit Tests:', function (done) {
         return done(error);
       });
   });
+
+  // it('listStatusChangesOptions 70 envelopeIds', function (done) {
+  //   console.log('starwars')
+  //
+  //   var envelopesApi = new docusign.EnvelopesApi(apiClient);
+  //   var THIRTY_DAYS_AGO = new Date(new Date().setDate(new Date().getDate()-30));
+  //
+  //   var options = {
+  //     count: "70", fromDate: THIRTY_DAYS_AGO
+  //   };
+  //   envelopesApi.listStatusChanges(accountId, options)
+  //     .then(function (data) {
+  //       var envelopIds = data.envelopes.reduce( function( acc, envelope ) {
+  //         if (!acc.length) return envelope.envelopeId;
+  //         return acc + ', ' + envelope.envelopeId;
+  //       }, '');
+  //       console.log(envelopIds);
+  //       envelopesApi.listStatusChanges(accountId, {envelopeIds: envelopIds})
+  //         .then( function(data) {
+  //           assert.notEqual(data.envelopes, undefined);
+  //           assert.notEqual(data.envelopes[0].attachmentsUri, undefined);
+  //           assert.notEqual(data.envelopes[0].statusChangedDateTime, undefined);
+  //           done();
+  //         }).catch(function (error, resp) {
+  //         return done(error);
+  //       });;
+  //     })
+  //     .catch(function (error) {
+  //       return done(error);
+  //     });
+  // });
+
   it('getDiagnosticLogs', function (done) {
     var fileBytes = null;
     try {
@@ -1024,6 +1055,30 @@ describe('SDK Unit Tests:', function (done) {
           });
       });
   });
+
+  it('it updateBrandResourcesByContentType', function (done) {
+    var accountsApi = new docusign.AccountsApi(apiClient);
+    accountsApi.listBrands(accountId, { includeLogos: true })
+      .then(function (brandsData) {
+        var currentBrand = brandsData.brands[0];
+        var brandXmlBuffer = fs.readFileSync(path.resolve(__dirname, brandXmlPath));
+        accountsApi.updateBrandResourcesByContentType(accountId, currentBrand.brandId, 'email', brandXmlBuffer)
+          .then(function (data) {
+            assert.notEqual(data.createdByUserInfo, undefined);
+            assert.notEqual(data.resourcesContentUri, undefined);
+            return done();
+          })
+          .catch(function (error) {
+            // console.log(error)
+            return done(error);
+          });
+      })
+      .catch(function (error) {
+        // console.log(error)
+        return done(error);
+      });
+  });
+
   it('create template with date and number tabs', function (done) {
     var fileBytes = null;
     try {
@@ -1119,4 +1174,92 @@ describe('SDK Unit Tests:', function (done) {
         }
       });
   });
+
+  it('resend envelope with envelope update', function (done) {
+    var fileBytes = null;
+    try {
+      var fs = require('fs');
+      // read file from a local directory
+      fileBytes = fs.readFileSync(path.resolve(__dirname, SignTest1File));
+    } catch (ex) {
+      // handle error
+      console.log('Exception: ' + ex);
+    }
+
+    // create an envelope to be signed
+    var envDef = new docusign.EnvelopeDefinition();
+    envDef.emailSubject = 'Please Sign my Node SDK Envelope';
+    envDef.emailBlurb = 'Hello, Please sign my Node SDK Envelope.';
+
+    // add a document to the envelope
+    var doc = new docusign.Document();
+    var base64Doc = Buffer.from(fileBytes).toString('base64');
+    doc.documentBase64 = base64Doc;
+    doc.name = 'TestFile.pdf';
+    doc.documentId = '1';
+
+    var docs = [];
+    docs.push(doc);
+    envDef.documents = docs;
+
+    // Add a recipient to sign the document
+    var signer = new docusign.Signer();
+    signer.email = userName;
+    var name = 'Pat Developer';
+    signer.name = name;
+    signer.recipientId = '1';
+
+    // this value represents the client's unique identifier for the signer
+    var clientUserId = '2939';
+    signer.clientUserId = clientUserId;
+
+    // create a signHere tab somewhere on the document for the signer to sign
+    // default unit of measurement is pixels, can be mms, cms, inches also
+    var signHere = new docusign.SignHere();
+    signHere.documentId = '1';
+    signHere.pageNumber = '1';
+    signHere.recipientId = '1';
+    signHere.xPosition = '100';
+    signHere.yPosition = '100';
+
+    // can have multiple tabs, so need to add to envelope as a single element list
+    var signHereTabs = [];
+    signHereTabs.push(signHere);
+    var tabs = new docusign.Tabs();
+    tabs.signHereTabs = signHereTabs;
+    signer.tabs = tabs;
+
+    // Above causes issue
+    envDef.recipients = new docusign.Recipients();
+    envDef.recipients.signers = [];
+    envDef.recipients.signers.push(signer);
+
+    // send the envelope (otherwise it will be "created" in the Draft folder
+    envDef.status = 'sent';
+
+    var envelopesApi = new docusign.EnvelopesApi(apiClient);
+
+    envelopesApi.createEnvelope(accountId, { envelopeDefinition: envDef })
+      .then(function (envelopeSummary) {
+        if (envelopeSummary) {
+          envelopesApi.update(accountId, envelopeSummary.envelopeId, { resendEnvelope: true })
+            .then(function (envelopeUpdateSummary) {
+              if (envelopeUpdateSummary) {
+                console.log('envelopeUpdateSummary: ' + JSON.stringify(envelopeUpdateSummary));
+                done();
+              }
+            })
+            .catch(function (error) {
+              if (error) {
+                return done(error);
+              }
+            });
+        }
+      })
+      .catch(function (error) {
+        if (error) {
+          return done(error);
+        }
+      });
+  });
 });