combining phone auth and cleaning up old examples

Author: paigesrossi

config/documentNames.json

@@ -19,8 +19,7 @@
       "eg017": "eg017SetTemplateTabValues.js",
       "eg018": "eg018EnvelopeCustomFieldData.js",
       "eg019": "eg019AccessCodeAuthentication.js",
-      "eg020": "eg020SmsAuthentication.js",
-      "eg021": "eg021PhoneAuthentication.js",
+      "eg020": "eg020PhoneAuthentication.js",
       "eg022": "eg022KbaAuthentication.js",
       "eg023": "eg023IdvAuthentication.js",
       "eg024": "eg024CreateBrand.js",

index.js

@@ -24,7 +24,7 @@ const eg001 = require('./eg001EmbeddedSigning');
 const { 
   eg002, eg003, eg004, eg005, eg006, eg007, eg008, 
   eg009, eg010, eg011, eg012, eg013, eg014, eg015,
-  eg016, eg017, eg018, eg019, eg020, eg021, eg022,
+  eg016, eg017, eg018, eg019, eg020, eg022,
   eg023, eg024, eg025, eg026, eg027, eg028, eg029,
   eg030, eg031, eg032, eg033, eg034, eg035,
 } = require("./lib/eSignature/controllers");
@@ -186,8 +186,6 @@ if (dsConfig.examplesApi.isRoomsApi) {
     .post('/eg019', eg019.createController)
     .get('/eg020', eg020.getController)
     .post('/eg020', eg020.createController)
-    .get('/eg021', eg021.getController)
-    .post('/eg021', eg021.createController)
     .get('/eg022', eg022.getController)
     .post('/eg022', eg022.createController)
     .get('/eg023', eg023.getController)

…/controllers/eg021PhoneAuthentication.js …/controllers/eg020PhoneAuthentication.jslib/eSignature/controllers/eg021PhoneAuthentication.js renamed to lib/eSignature/controllers/eg020PhoneAuthentication.js lib/eSignature/controllers/eg021PhoneAuthentication.js renamed to lib/eSignature/controllers/eg020PhoneAuthentication.js

@@ -1,6 +1,6 @@
 /**
  * @file
- * Example 021: Phone-based recipient authentication
+ * Example 020: Phone authentication
  * @author DocuSign
  */
 
@@ -9,8 +9,8 @@ const { phoneAuthentication } = require('../examples/phoneAuthentication');
 const validator = require('validator');
 const dsConfig = require('../../../config/index.js').config;
 
-const eg021PhoneAuthentication = exports;
-const eg = 'eg021'; // This example reference.
+const eg020PhoneAuthentication = exports;
+const eg = 'eg020'; // This example reference.
 const mustAuthenticate = '/ds/mustAuthenticate';
 const minimumBufferMin = 3;
 
@@ -19,7 +19,7 @@ const minimumBufferMin = 3;
  * @param {object} req Request obj
  * @param {object} res Response obj
  */
-eg021PhoneAuthentication.createController = async (req, res) => {
+eg020PhoneAuthentication.createController = async (req, res) => {
     // Step 1: Obtain your OAuth token
     // At this point we should have a good token. But we
     // double-check here to enable a better UX to the user.
@@ -36,7 +36,8 @@ eg021PhoneAuthentication.createController = async (req, res) => {
     const envelopeArgs  = {
         signerEmail: validator.escape(body.signerEmail), // represents your {SIGNER_EMAIL}
         signerName: validator.escape(body.signerName),    // represents your {SIGNER_NAME}
-        phoneNumber: validator.escape(body.phoneNumber)
+        phoneNumber: validator.escape(body.phoneNumber),   // represents your phone number
+        countryCode: validator.escape(body.countryCode)   // represents your country code
     };
     const args = {
         accessToken: req.user.accessToken,  // represents your {ACCESS_TOKEN}
@@ -47,9 +48,10 @@ eg021PhoneAuthentication.createController = async (req, res) => {
     let results = null;
 
     try {
-	    // Step 2: Send the envelope
+        // Step 2: Call the api method
         results = await phoneAuthentication(args);
-	}
+        console.log("WorkflowId: " + results.workflowId);
+    }
     catch (error) {
         const errorBody = error && error.response && error.response.body;
         // we can pull the DocuSign error code and message from the response body
@@ -59,9 +61,10 @@ eg021PhoneAuthentication.createController = async (req, res) => {
         // remediation advice to the user.
         res.render('pages/error', {err: error, errorCode, errorMessage});
     }
+	
     if (results) {
         req.session.envelopeId = results.envelopeId; 	// Save for use by other examples
-														// which need an envelopeId
+	    												// which need an envelopeId
         res.render('pages/example_done', {
             title: "Envelope sent",
             h1: "Envelope sent",
@@ -70,18 +73,20 @@ eg021PhoneAuthentication.createController = async (req, res) => {
     }
 }
 
+
+
 // ***DS.snippet.0.end
 
 /**
  * Form page for this application
  */
-eg021PhoneAuthentication.getController = (req, res) => {
+eg020PhoneAuthentication.getController = (req, res) => {
     // Check that the authentication token is ok with a long buffer time.
     // If needed, now is the best time to ask the user to authenticate
     // since they have not yet entered any information into the form.
     const tokenOK = req.dsAuth.checkToken();
     if (tokenOK) {
-        res.render('pages/examples/eg021PhoneAuthentication', {
+        res.render('pages/examples/eg020PhoneAuthentication', {
             eg: eg, csrfToken: req.csrfToken(),
             title: "Signing request by email",
             sourceFile: path.basename(__filename),
@@ -94,4 +99,4 @@ eg021PhoneAuthentication.getController = (req, res) => {
         req.dsAuth.setEg(req, eg);
         res.redirect(mustAuthenticate);
     }
-}
+}

lib/eSignature/controllers/eg020SmsAuthentication.js

@@ -17,8 +17,7 @@ module.exports.eg016 = require('./eg016SetTabValues');
 module.exports.eg017 = require('./eg017SetTemplateTabValues');
 module.exports.eg018 = require('./eg018EnvelopeCustomFieldData');
 module.exports.eg019 = require('./eg019AccessCodeAuthentication');
-module.exports.eg020 = require('./eg020SmsAuthentication');
-module.exports.eg021 = require('./eg021PhoneAuthentication');
+module.exports.eg020 = require('./eg020PhoneAuthentication');
 module.exports.eg022 = require('./eg022KbaAuthentication');
 module.exports.eg023 = require('./eg023IdvAuthentication');
 module.exports.eg024 = require('./eg024CreatePermission');

lib/eSignature/controllers/index.js

@@ -1,6 +1,6 @@
 <% include ../../partials/examplesHead %>
 
-<h4>21. Requiring an Phone Authentication for a Recipient</h4>
+<h4>20. Requiring an Phone Authentication for a Recipient</h4>
 <p>
     The envelope includes a pdf document. Anchor text
     (<a href="https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/">AutoPlace</a>)
@@ -21,6 +21,11 @@
 
 <% include ../../partials/gitSource %>
 <form class="eg" action="" method="post" data-busy="form">
+  <div class="form-group">
+    <label for="countryCode">Country Code</label>
+    <input type="text" class="form-control" id="countryCode" placeholder="1" name="countryCode"
+           value="1" required>
+  </div>
   <div class="form-group">
     <label for="phoneNumber">Phone Number</label>
     <input type="text" class="form-control" id="phoneNumber" placeholder="415-555-1212" name="phoneNumber"

lib/eSignature/examples/phoneAuthentication.js

@@ -175,15 +175,8 @@
     <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>.
 </p>
 
-<h4 id="example020">20. <a href="eg020">SMS Authentication</a></h4>
-<p>This is an example of an envelope utilizing SMS authentication for multi-factor verification of a recipient.</p>
-<p>API method used:
-    <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>.
-</p>
-
-<h4 id="example021">21. <a href="eg021">Phone Authentication</a></h4>
-<p>This is an example of an envelope utilizing phone authentication for multi-factor verification of a
-    recipient.</p>
+<h4 id="example020">20. <a href="eg020">Phone Recipient Authentication</a></h4>
+<p>This is an example of creating and sending an envelope (a signing request) using an SMS message or phone call for Recipient Authentication.</p>
 <p>API method used:
     <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>.
 </p>