Merge branch 'SN-3452' into SN-2955

Author: Ruslan Tereshchenko

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Implemented *View Template Routing Details* feature. See how to apply it in [Documentation](https://signnow.github.io/SignNowNodeSDK/class/lib/template/index.js~Template.html#static-method-getRoutingDetails), [Short example](https://github.com/signnow/SignNowNodeSDK/blob/master/README.md#routing-details), [Full example](https://github.com/signnow/SignNowNodeSDK/blob/master/samples/snippets/getRoutingDetails.js), [CLI applet](https://github.com/signnow/SignNowNodeSDK/blob/master/bin/routing-details.js).
+- Implemented *Update Template Routing Details* feature. See how to apply it in [Documentation](https://signnow.github.io/SignNowNodeSDK/class/lib/template/index.js~Template.html#static-method-updateRoutingDetails), [Short example](https://github.com/signnow/SignNowNodeSDK/blob/master/README.md#update-routing-details), [Full example](https://github.com/signnow/SignNowNodeSDK/blob/master/samples/snippets/updateTemplateRoutingDetails.js), [CLI applet](https://github.com/signnow/SignNowNodeSDK/blob/master/bin/update-routing-details.js).
 
 ### Changed
 

README.md

@@ -50,6 +50,7 @@ SignNow Node.js REST API Wrapper
       * [Create Invite to Sign a Template](#template-field-invite)
       * [Create Free Form Invite from Template](#template-freeform-invite)
       * [Remove Template](#remove-template)
+      * [Update Routing Details](#update-routing-details)
     * [Folder](#folder)
       * [Returns a list of folders](#list-folders)
       * [Returns a list of documents inside a folder](#list-documents-in-folder)
@@ -602,6 +603,57 @@ api.template.getRoutingDetails({
 
 More: [Full example](https://github.com/signnow/SignNowNodeSDK/blob/master/samples/snippets/getRoutingDetails.js), [CLI applet](https://github.com/signnow/SignNowNodeSDK/blob/master/bin/routing-details.js)
 
+#### <a name="update-routing-details"></a>Update Routing Details
+
+```javascript
+const routingDetails = {
+  template_data: [
+    {
+      default_email: '',
+      inviter_role: false,
+      name: 'Signer 1',
+      role_id: 'SIGNER 1 ROLE ID',
+      signing_order: 1,
+      decline_by_signature: true,
+    },
+    {
+      default_email: 'signer2@mail.com',
+      inviter_role: false,
+      name: 'Signer 2',
+      role_id: 'SIGNER 2 ROLE ID',
+      signing_order: 2,
+    },
+  ],
+  cc: [
+    'cc1@mail.com',
+    'cc2@mail.com',
+  ],
+  cc_step: [
+    {
+      email: 'cc1@mail.com',
+      step: 1,
+      name: 'CC 1',
+    },
+    {
+      email: 'cc2@mail.com',
+      step: 2,
+      name: 'CC 2',
+    },
+  ],
+  invite_link_instructions: 'Invite link signing instruction',
+};
+
+api.template.updateRoutingDetails({
+  data: routingDetails,
+  token: 'your auth token',
+  id: 'template id',
+}, (err, res) => {
+  // handle error or process response data
+});
+```
+
+More: [Full example](https://github.com/signnow/SignNowNodeSDK/blob/master/samples/snippets/updateTemplateRoutingDetails.js), [CLI applet](https://github.com/signnow/SignNowNodeSDK/blob/master/bin/update-routing-details.js)
+
 ### <a name="folder"></a>Folder
 
 #### <a name="list-folders"></a>Returns a list of folders

bin/update-routing-details.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+
+/**
+ * to run update-routing-details applet from the project root folder type in your console:
+ * > node bin/update-routing-details <client_id> <client_secret> <username> <password> <template_id> '<routing_details>'
+ * <client_id>, <client_secret>, <username>, <password>, <template_id>, <routing_details> - are required params
+ */
+
+'use strict';
+
+const [
+  clientId,
+  clientSecret,
+  username,
+  password,
+  templateId,
+  routingDetailsStringified,
+] = process.argv.slice(2);
+
+const { promisify } = require('../utils');
+const api = require('../lib')({
+  credentials: Buffer.from(`${clientId}:${clientSecret}`).toString('base64'),
+  production: false,
+});
+
+const {
+  oauth2: { requestToken: getAccessToken },
+  template: { updateRoutingDetails },
+} = api;
+
+const getAccessToken$ = promisify(getAccessToken);
+const updateRoutingDetails$ = promisify(updateRoutingDetails);
+
+getAccessToken$({
+  username,
+  password,
+})
+  .then(({ access_token: token }) => {
+    const routingDetails = JSON.parse(routingDetailsStringified);
+
+    return {
+      token,
+      routingDetails,
+    };
+  })
+  .then(({ token, routingDetails }) => updateRoutingDetails$({
+    data: routingDetails,
+    id: templateId,
+    token,
+  }))
+  .then(res => console.log(res))
+  .catch(err => console.error(err));

lib/template/index.js

@@ -10,6 +10,7 @@ const {
   invite,
   view,
 } = require('../document');
+const { promisify } = require('../../utils');
 
 /**
  * @type {function}
@@ -32,6 +33,52 @@ const sendDocumentInvite = invite;
  */
 const getDocumentDetails = view;
 
+/**
+ * Update Signing Role payload
+ * @typedef {Object} TemplateUpdateSigningRoleParams
+ * @property {string} id - an ID of Actor (role)
+ * @property {string} token - your auth token
+ * @property {number} signing_order - signing order number
+ */
+
+/**
+ * Update Signing Role response data
+ * @typedef {Object} TemplateUpdateSigningRoleResponse
+ * @property {string} id - unique ID of Actor
+ * @property {string} document_id - unique ID of Template
+ * @property {number} signing_order - signing order number
+ */
+
+/**
+ * Updates Signing Role with order of actor
+ * @param {TemplateUpdateSigningRoleParams} data - update signing role payload
+ * @param {function(err: ApiErrorResponse, res: TemplateUpdateSigningRoleResponse)} [callback] - error first node.js callback
+ */
+const updateSigningRole = ({
+  id,
+  token,
+  signing_order,
+}, callback) => {
+  const JSONData = JSON.stringify({ signing_order });
+  const req = https
+    .request(buildRequestOptions({
+      method: 'PUT',
+      path: `/role/${id}`,
+      authorization: {
+        type: 'Bearer',
+        token,
+      },
+      headers: {
+        'Content-Type': 'application/json',
+        'Content-Length': Buffer.byteLength(JSONData),
+      },
+    }), responseHandler(callback))
+    .on('error', errorHandler(callback));
+
+  req.write(JSONData);
+  req.end();
+};
+
 /**
  * Template methods
  */
@@ -326,6 +373,114 @@ class Template {
       .end();
   }
 
+  /**
+   * Template Update Routing Details item data
+   * @typedef {Object} TemplateUpdateRoutingDetailsItem
+   * @property {string} default_email - default email for routing detail
+   * @property {boolean} inviter_role - always `false`
+   * @property {string} name - signer role (actor) name
+   * @property {string} role_id - signer role (actor) unique ID
+   * @property {number} signing_order - order number of signing step
+   * @property {boolean} decline_by_signature - decline by signature flag
+   */
+
+  /**
+   * Update Template Routing Details payload
+   * @typedef {Object} TemplateUpdateRoutingDetailsParams
+   * @property {TemplateUpdateRoutingDetailsItem[]} template_data - array with routing details
+   * @property {string[]} cc - CC emails
+   * @property {TemplateRoutingDetailsCCStep[]} cc_step - array of CC steps
+   * @property {string} [invite_link_instructions] - invite signing instructions
+   */
+
+  /**
+   * Update Template Routing Details response data
+   * @typedef {Object} TemplateUpdateRoutingDetailsResponse
+   * @property {string} id - unique ID of template routing details
+   * @property {string} document_id - unique ID of Template
+   * @property {TemplateUpdateRoutingDetailsItem[]} data - array with routing details
+   * @property {string[]} cc - CC emails
+   * @property {TemplateRoutingDetailsCCStep[]} cc_step - array of CC steps
+   * @property {string} invite_link_instructions - invite signing instructions
+   */
+
+  /**
+   * Updates Routing Details of specified template
+   * @param {TemplateUpdateRoutingDetailsParams} data - update Template Routing Details payload
+   * @param {function(err: ApiErrorResponse, res: TemplateUpdateRoutingDetailsResponse)} [callback] - error first node.js callback
+   */
+  static updateRoutingDetails ({
+    id,
+    token,
+    data,
+  }, callback) {
+    const {
+      template_data,
+      cc,
+      cc_step,
+      invite_link_instructions,
+    } = data;
+    const JSONData = JSON.stringify({
+      template_data,
+      cc,
+      cc_step,
+      invite_link_instructions,
+    });
+
+    const updateCallback = (err, res) => {
+      if (err) {
+        callback(err);
+        return;
+      } else {
+        const { data: routingDetails } = res;
+        const rolesUpdated = routingDetails
+          .map(route => {
+            const { role_id, signing_order } = route;
+            return promisify(updateSigningRole)({
+              id: role_id,
+              signing_order,
+              token,
+            });
+          });
+
+        Promise.all(rolesUpdated)
+          .then(roleUpdatesRes => {
+            return roleUpdatesRes.reduce((generalStatus, roleUpdateRes) => (generalStatus && !!roleUpdateRes.id), true);
+          })
+          .then(allRolesUpdated => {
+            if (allRolesUpdated) {
+              callback(null, res);
+              return;
+            } else {
+              throw new Error('Some roles (actors) where not updated');
+            }
+          })
+          .catch(roleUpdatesErr => {
+            callback(roleUpdatesErr);
+            return;
+          });
+      }
+    };
+
+    const req = https
+      .request(buildRequestOptions({
+        method: 'PUT',
+        path: `/document/${id}/template/routing/detail`,
+        authorization: {
+          type: 'Bearer',
+          token,
+        },
+        headers: {
+          'Content-Type': 'application/json',
+          'Content-Length': Buffer.byteLength(JSONData),
+        },
+      }), responseHandler(updateCallback))
+      .on('error', errorHandler(callback));
+
+    req.write(JSONData);
+    req.end();
+  }
+
 }
 
 module.exports = Template;

package.json

@@ -76,7 +76,8 @@
     "sn:view-document-group": "./bin/view-document-group.js",
     "sn:view-document": "./bin/view-document.js",
     "sn:view-documentgroup-template": "./bin/view-documentgroup-template.js",
-    "sn:routing-details": "./bin/routing-details.js"
+    "sn:routing-details": "./bin/routing-details.js",
+    "sn:update-routing-details": "./bin/update-routing-details.js"
   },
   "license": "MIT"
 }