Merge branch 'master' of https://github.com/docusign/code-examples-node-private

Author: karissarjacobsen

lib/eSignature/controllers/eg044FocusedView.js

@@ -45,6 +45,8 @@ eg044FocusedView.createController = async (req, res) => {
   const envelopeArgs = {
     signerEmail: validator.escape(body.signerEmail),
     signerName: validator.escape(body.signerName),
+    phoneNumber: body.phoneNumber ? validator.escape(body.phoneNumber) : null,
+    countryCode: body.countryCode ? validator.escape(body.countryCode) : null,
     signerClientId: signerClientId,
     dsReturnUrl: dsReturnUrl,
     dsPingUrl: dsPingUrl,

lib/eSignature/examples/focusedView.js

@@ -25,6 +25,40 @@ const sendEnvelope = async (args) => {
   let envelopesApi = new docusign.EnvelopesApi(dsApiClient);
   let results = null;
 
+  // If phone authentication is needed, get the workflow ID
+  if (args.envelopeArgs.phoneNumber) {
+    let accountsApi = new docusign.AccountsApi(dsApiClient);
+    let workflowId = null;
+
+    results = await accountsApi.getAccountIdentityVerification(
+      args.accountId, (error, data, response) => {
+        const headers = response?.headers;
+
+        const remaining = headers?.['x-ratelimit-remaining'];
+        const reset = headers?.['x-ratelimit-reset'];
+
+        if (remaining && reset) {
+          const resetInstant = new Date(Number(reset) * 1000);
+
+          console.log(`API calls remaining: ${remaining}`);
+          console.log(`Next Reset: ${resetInstant.toISOString()}`);
+        }
+    });
+
+    // Find the workflow ID corresponding to the name "Phone Authentication"
+    results.data.identityVerification.forEach(workflow => {
+      if (workflow.defaultName === 'Phone Authentication') {
+        workflowId = workflow.workflowId;
+      }
+    });
+
+    if (workflowId === null) {
+      throw new Error('IDENTITY_WORKFLOW_INVALID_ID');
+    }
+
+    args.envelopeArgs.workflowId = workflowId;
+  }
+
   // Make the envelope request body
   let envelope = makeEnvelope(args.envelopeArgs);
 
@@ -88,7 +122,10 @@ function makeEnvelope(args) {
   // args.signerEmail
   // args.signerName
   // args.signerClientId
-  // docFile
+  // args.workflowId (optional, when phone auth is used)
+  // args.phoneNumber (optional)
+  // args.countryCode (optional0)
+  // args.docFile
 
   // document 1 (pdf) has tag /sn1/
   //
@@ -125,22 +162,22 @@ function makeEnvelope(args) {
     recipientId: 1,
   });
 
-  // Create signHere fields (also known as tabs) on the documents,
-  // We're using anchor (autoPlace) positioning
-  //
-  // The DocuSign platform seaches throughout your envelope's
-  // documents for matching anchor strings.
-  let signHere1 = docusign.SignHere.constructFromObject({
-    anchorString: '/sn1/',
-    anchorYOffset: '10',
-    anchorUnits: 'pixels',
-    anchorXOffset: '20',
-  });
-  // Tabs are set per recipient / signer
-  let signer1Tabs = docusign.Tabs.constructFromObject({
-    signHereTabs: [signHere1],
-  });
-  signer1.tabs = signer1Tabs;
+  // Add phone authentication if phone number is provided
+  if (args.phoneNumber) {
+    signer1.identityVerification = {
+      workflowId: args.workflowId,
+      steps: null,
+      inputOptions: [{
+        name: 'phone_number_list',
+        valueType: 'PhoneNumberList',
+        phoneNumberList: [{
+          countryCode: args.countryCode,
+          number: args.phoneNumber
+        }]
+      }],
+      idCheckConfigurationName: ''
+    };
+  }
 
   // Add the recipient to the envelope object
   let recipients = docusign.Recipients.constructFromObject({

views/pages/examples/eg044Embed.ejs

@@ -32,8 +32,6 @@
 </body>
 </html>
 
-<p><a href="/">Continue</a></p>
-
 <script src='https://js.docusign.com/bundle.js'></script>
 <script>
     window.DocuSign.loadDocuSign('<%= integrationKey %>')
@@ -46,7 +44,7 @@
                     branding: {
                         primaryButton: {
                             /** Background color of primary button */
-                            backgroundColor: '#333',
+                            backgroundColor: '#50C878',
                             /** Text color of primary button */
                             color: '#fff',
                         }
@@ -55,8 +53,28 @@
                     /** High-level components we allow specific overrides for */
                     signingNavigationButton: {
                         finishText: 'You have finished the document! Hooray!',
-                        position: 'bottom-center'
-                    }
+                        position: 'bottom-center',
+                        shape: 'pill',
+                    },
+
+                    signingAgreeButton: {
+                        finishText: 'I Agree',
+                    },
+
+                    signingDeclineButton: {
+                        show: true,
+                        finishText: 'Decline',
+                        backgroundColor: '#ff0000',
+                        color: '#ffffff',
+                    },
+
+                    downloadModal: {
+                        show: true,
+                    },
+
+                    declineModal: {
+                        show: true,
+                    },
                 }
             });
 
@@ -67,6 +85,7 @@
             signing.on('sessionEnd', (event) => {
                 /** The event here denotes what caused the sessionEnd to trigger, such as signing_complete, ttl_expired etc../ **/
                 console.log('sessionend', event);
+                window.location.href = '/'
             });
 
             signing.mount('#agreement');

views/pages/examples/eg044FocusedView.ejs

@@ -20,6 +20,24 @@
           value="<%= locals.dsConfig.signerName %>" required>
   </div>
 
+  <br/>
+  <% if(example.Forms && example.Forms[1].FormName) { %>
+    <%- example.Forms[1].FormName %>
+  <% } %>
+
+  <div class="form-group">
+    <label for="countryCode"><%= example.Forms[1].Inputs[0].InputName %></label>
+    <input type="text" class="form-control" id="countryCode" name="countryCode"
+          placeholder="<%= example.Forms[1].Inputs[0].InputPlaceholder %>">
+  </div>
+
+  <div class="form-group">
+    <label for="phoneNumber"><%= example.Forms[1].Inputs[1].InputName %></label>
+    <input type="text" class="form-control" id="phoneNumber" name="phoneNumber"
+          aria-describedby="phoneHelp" placeholder="<%= example.Forms[1].Inputs[1].InputPlaceholder %>">
+    <small id="phoneHelp" class="form-text text-muted">Provide a phone number to enable phone authentication for the signer</small>
+  </div>
+
   <input type="hidden" name="_csrf" value="<%- csrfToken %>">
   <%- include("../../partials/submitButton") %>
 </form>