DEVDOCS-13760 codeDepot markers

Author: karissarjacobsen

lib/eSignature/examples/documentGeneration.js

@@ -20,46 +20,53 @@ const sendEnvelope = async (args) => {
   const accountId = args.accountId;
   const envelopeArgs = args.envelopeArgs;
 
-  // Step 1. Create the template
+  //ds-snippet-start:eSign42Step2
   const templateData = makeTemplate();
   const template = await templatesApi.createTemplate(accountId, { envelopeTemplate: templateData });
   const templateId = template.templateId;
+  //ds-snippet-end:eSign42Step2
 
-  // Step 2. Update template document
+  //ds-snippet-start:eSign42Step3
   const documentData = templateDocument(envelopeArgs);
   const documentId = '1';
   await templatesApi.updateDocument(accountId, templateId, documentId, { envelopeDefinition: documentData });
+  //ds-snippet-end:eSign42Step3
 
-  // Step 3. Update recipient tabs
+  //ds-snippet-start:eSign42Step4
   const tabs = recipientTabs(envelopeArgs);
   const recipientId = '1';
   await templatesApi.createTabs(accountId, templateId, recipientId, { templateTabs: tabs });
+  //ds-snippet-end:eSign42Step4
 
-  // Step 4. Create draft envelope
+  //ds-snippet-start:eSign42Step5
   const envelopeData = makeEnvelope(templateId, envelopeArgs);
   const envelope = await envelopesApi.createEnvelope(accountId, { envelopeDefinition: envelopeData });
   const envelopeId = envelope.envelopeId;
+  //ds-snippet-end:eSign42Step5
 
-  // Step 5. Get the document id
+  //ds-snippet-start:eSign42Step6
   const docGenFormFieldsResponse = await envelopesApi.getEnvelopeDocGenFormFields(accountId, envelopeId);
   const documentIdGuid = docGenFormFieldsResponse.docGenFormFields[0].documentId;
+  //ds-snippet-end:eSign42Step6
 
-  // Step 6. Merge the data fields
+  //ds-snippet-start:eSign42Step7
   const formFieldsData = formFields(documentIdGuid, envelopeArgs);
   await envelopesApi.updateEnvelopeDocGenFormFields(accountId, envelopeId, { docGenFormFieldRequest: formFieldsData });
+  //ds-snippet-end:eSign42Step7
 
-  // Step 7. Send the envelope
+  //ds-snippet-start:eSign42Step8
   const sendEnvelopeReq = docusign.Envelope.constructFromObject({
     status: 'sent',
   });
   return await envelopesApi.update(accountId, envelopeId, { envelope: sendEnvelopeReq });
-
+  //ds-snippet-end:eSign42Step8
 };
 
 /**
  * Creates envelope template object
  * @returns {docusign.EnvelopeTemplate} Template object
  */
+//ds-snippet-start:eSign42Step2
 const makeTemplate = () => {
   const signer = docusign.Signer.constructFromObject({
     roleName: 'signer',
@@ -82,12 +89,14 @@ const makeTemplate = () => {
 
   return templateRequest;
 };
+//ds-snippet-end:eSign42Step2
 
 /**
  * Creates an envelope definition with document
  * @param {object} args Parameters for the envelope
  * @returns {docusign.EnvelopeDefinition} An envelope definition with document
  */
+//ds-snippet-start:eSign42Step3
 const templateDocument = (args) => {
   // read file
   const docBytes = fs.readFileSync(args.docFile);
@@ -108,11 +117,13 @@ const templateDocument = (args) => {
 
   return envelopeDefinition;
 };
+//ds-snippet-end:eSign42Step3
 
 /**
  * Creates recipient tabs
  * @returns {docusign.Tabs} Recipient tabs
  */
+//ds-snippet-start:eSign42Step4
 const recipientTabs = () => {
   const signHere = docusign.SignHere.constructFromObject({
     anchorString: 'Employee Signature',
@@ -134,13 +145,15 @@ const recipientTabs = () => {
 
   return tabs;
 };
+//ds-snippet-end:eSign42Step4
 
 /**
  * Creates draft envelope
  * @param {string} templateId Template ID
  * @param {object} args Parameters for the envelope
  * @returns {docusign.EnvelopeDefinition} Draft envelope
  */
+//ds-snippet-start:eSign42Step5
 const makeEnvelope = (templateId, args) => {
   // create the signer model
   const signer = docusign.TemplateRole.constructFromObject({
@@ -158,13 +171,15 @@ const makeEnvelope = (templateId, args) => {
 
   return envelopeDefinition;
 };
+//ds-snippet-end:eSign42Step5
 
 /**
  * Creates document generation form field request
  * @param {string} documentId Document ID
  * @param {object} args Parameters for the envelope
  * @returns {docusign.DocGenFormFieldRequest} Document generation form field request
  */
+//ds-snippet-start:eSign42Step7
 const formFields = (documentId, args) => {
   const docGenFormFieldRequest = docusign.DocGenFormFieldRequest.constructFromObject({
     docGenFormFields: [
@@ -198,5 +213,6 @@ const formFields = (documentId, args) => {
 
   return docGenFormFieldRequest;
 };
+//ds-snippet-end:eSign42Step7
 
 module.exports = { sendEnvelope };