adding step comments (#92)

Author: paigesrossi

lib/eSignature/examples/setDocumentVisibility.js

@@ -26,22 +26,26 @@ const docusign = require("docusign-esign");
  * @param {string} args.envelopeArgs.doc3File Path to the third document
  */
 async function sendEnvelope(args) {
+  // Step 2 start
   const dsApiClient = new docusign.ApiClient();
 
   dsApiClient.setBasePath(args.basePath);
   dsApiClient.addDefaultHeader("Authorization", "Bearer " + args.accessToken);
+  // Step 2 end
 
+  // Step 4 start
   const envelopesApi = new docusign.EnvelopesApi(dsApiClient);
 
-  // Step 1. Make the envelope request body
+  // Make the envelope request body
   const envelope = makeEnvelope(args.envelopeArgs);
 
-  // Step 2. call Envelopes::create API method
+  // Call Envelopes::create API method
   // Exceptions will be caught by the calling function
   const results = await envelopesApi.createEnvelope(args.accountId, {
     envelopeDefinition: envelope,
   });
   const envelopeId = results.envelopeId;
+  // Step 4 end
 
   console.log(`Envelope was created. EnvelopeId ${envelopeId}`);
   return { envelopeId };
@@ -63,6 +67,7 @@ async function sendEnvelope(args) {
  * @returns {docusign.EnvelopeDefinition} An envelope definition
  * @private
  */
+// Step 3 start
 function makeEnvelope(args) {
   /**
    * document 1 (html) has tag **signature_1**
@@ -233,5 +238,6 @@ function document1(args) {
     </html>
   `;
 }
+// Step 3 end
 
 module.exports = { sendEnvelope };

lib/eSignature/examples/signingInPerson.js

@@ -23,30 +23,35 @@ const docusign = require("docusign-esign");
  * @param {string} args.envelopeArgs.docFile Path to the document
  */
 const sendEnvelopeForInPersonSigning = async (args) => {
+
+  // Step 3 start
   const dsApiClient = new docusign.ApiClient();
   dsApiClient.setBasePath(args.basePath);
   dsApiClient.addDefaultHeader("Authorization", "Bearer " + args.accessToken);
   const envelopesApi = new docusign.EnvelopesApi(dsApiClient);
 
-  // Step 1. Make the envelope request body
+  // Make the envelope request body
   const envelope = makeEnvelope(args.envelopeArgs);
 
-  // Step 2. call Envelopes::create API method
+  // Call Envelopes::create API method
   // Exceptions will be caught by the calling function
   let results = await envelopesApi.createEnvelope(args.accountId, {
     envelopeDefinition: envelope,
   });
 
   const envelopeId = results.envelopeId;
+  // Step 3 end
   console.log(`Envelope was created. EnvelopeId ${envelopeId}`);
 
-  // Step 3. create the recipient view, the embedded signing
+  // Create the recipient view, the embedded signing
+  // Step 5 start
   const viewRequest = makeRecipientViewRequest(args.envelopeArgs);
   // Call the CreateRecipientView API
   // Exceptions will be caught by the calling function
   results = await envelopesApi.createRecipientView(args.accountId, envelopeId, {
     recipientViewRequest: viewRequest,
   });
+  // Step 5 end
 
   return { envelopeId: envelopeId, redirectUrl: results.url };
 };
@@ -62,6 +67,8 @@ const sendEnvelopeForInPersonSigning = async (args) => {
  * @returns {Envelope} An envelope definition
  * @private
  */
+
+// Step 2 start
 function makeEnvelope(args) {
   // document 1 (pdf) has tag /sn1/
   //
@@ -127,6 +134,8 @@ function makeEnvelope(args) {
   return env;
 }
 
+// Step 2 end
+
 /**
  * Creates recipient view definition
  * @function
@@ -138,6 +147,7 @@ function makeEnvelope(args) {
  * @returns {docusign.RecipientViewRequest} A recipient view definition
  * @private
  */
+// Step 4 start
 function makeRecipientViewRequest(args) {
   let viewRequest = new docusign.RecipientViewRequest();
 
@@ -172,5 +182,6 @@ function makeRecipientViewRequest(args) {
 
   return viewRequest;
 }
+// Step 4 end
 
 module.exports = { sendEnvelopeForInPersonSigning };