From 9237c6ecc1f73a97ad05e8f0518bea03094ff813 Mon Sep 17 00:00:00 2001 From: larry-kluger Date: Sun, 16 Dec 2018 08:50:55 +0200 Subject: [PATCH] arguments explicitly listed Added comments to explicitly list the arguments for the methods related to using the DocuSign API. --- lib/examples/eg001EmbeddedSigning.js | 19 ++++++++ lib/examples/eg002SigningViaEmail.js | 22 +++++++++ lib/examples/eg003ListEnvelopes.js | 6 +++ lib/examples/eg004EnvelopeInfo.js | 7 +++ lib/examples/eg005EnvelopeRecipients.js | 11 +++-- lib/examples/eg006EnvelopeDocs.js | 12 +++-- lib/examples/eg007EnvelopeGetDoc.js | 10 +++- lib/examples/eg008CreateTemplate.js | 23 ++++++--- lib/examples/eg009UseTemplate.js | 25 ++++++---- lib/examples/eg010SendBinaryDocs.js | 37 +++++++++------ lib/examples/eg011EmbeddedSending.js | 22 ++++----- lib/examples/eg012EmbeddedConsole.js | 20 +++++--- lib/examples/eg013AddDocToTemplate.js | 49 +++++++++++++------- lib/examples/eg014CollectPayment.js | 31 ++++++++----- lib/examples/eg015EnvelopeTabData.js | 6 +++ lib/examples/eg016SetTabValues.js | 20 ++++++-- lib/examples/eg017SetTemplateTabValues.js | 17 +++++++ lib/examples/eg018EnvelopeCustomFieldData.js | 6 +++ 18 files changed, 255 insertions(+), 88 deletions(-) diff --git a/lib/examples/eg001EmbeddedSigning.js b/lib/examples/eg001EmbeddedSigning.js index 5ffe841f..3c495d3f 100644 --- a/lib/examples/eg001EmbeddedSigning.js +++ b/lib/examples/eg001EmbeddedSigning.js @@ -95,6 +95,11 @@ eg001EmbeddedSigning.createController = async (req, res) => { */ // ***DS.worker.start ***DS.snippet.1.start eg001EmbeddedSigning.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); @@ -132,6 +137,13 @@ eg001EmbeddedSigning.worker = async (args) => { * @private */ function makeEnvelope(args){ + // Data for this method + // args.signerEmail + // args.signerName + // args.signerClientId + // demoDocsPath (module constant) + // pdf1File (module constant) + // document 1 (pdf) has tag /sn1/ // // The envelope has one recipients. @@ -200,6 +212,13 @@ function makeEnvelope(args){ // ***DS.snippet.3.start function makeRecipientViewRequest(args) { + // Data for this method + // args.dsReturnUrl + // args.signerEmail + // args.signerName + // args.signerClientId + // args.dsPingUrl + let viewRequest = new docusign.RecipientViewRequest(); // Set the url where you want the recipient to go once they are done signing diff --git a/lib/examples/eg002SigningViaEmail.js b/lib/examples/eg002SigningViaEmail.js index 41284020..1b4d08d8 100644 --- a/lib/examples/eg002SigningViaEmail.js +++ b/lib/examples/eg002SigningViaEmail.js @@ -101,6 +101,11 @@ eg002SigningViaEmail.createController = async (req, res) => { */ // ***DS.worker.start ***DS.snippet.1.start eg002SigningViaEmail.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); @@ -137,6 +142,17 @@ eg002SigningViaEmail.worker = async (args) => { * @private */ function makeEnvelope(args){ + // Data for this method + // args.signerEmail + // args.signerName + // args.ccEmail + // args.ccName + // args.status + // demoDocsPath (module constant) + // doc2File (module constant) + // doc3File (module constant) + + // document 1 (html) has tag **signature_1** // document 2 (docx) has tag /sn1/ // document 3 (pdf) has tag /sn1/ @@ -251,6 +267,12 @@ function makeEnvelope(args){ */ function document1(args) { + // Data for this method + // args.signerEmail + // args.signerName + // args.ccEmail + // args.ccName + return ` diff --git a/lib/examples/eg003ListEnvelopes.js b/lib/examples/eg003ListEnvelopes.js index c143e66b..58dc9664 100644 --- a/lib/examples/eg003ListEnvelopes.js +++ b/lib/examples/eg003ListEnvelopes.js @@ -77,6 +77,12 @@ eg003ListEnvelopes.createController = async (req, res) => { */ // ***DS.worker.start ***DS.snippet.1.start eg003ListEnvelopes.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); diff --git a/lib/examples/eg004EnvelopeInfo.js b/lib/examples/eg004EnvelopeInfo.js index 6263a820..d6ab661b 100644 --- a/lib/examples/eg004EnvelopeInfo.js +++ b/lib/examples/eg004EnvelopeInfo.js @@ -87,6 +87,13 @@ eg004EnvelopeInfo.createController = async (req, res) => { */ // ***DS.worker.start ***DS.snippet.1.start eg004EnvelopeInfo.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.envelopeId + + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); diff --git a/lib/examples/eg005EnvelopeRecipients.js b/lib/examples/eg005EnvelopeRecipients.js index 0c2eaa46..aa48eb61 100644 --- a/lib/examples/eg005EnvelopeRecipients.js +++ b/lib/examples/eg005EnvelopeRecipients.js @@ -83,13 +83,16 @@ eg005EnvelopeRecipients.createController = async (req, res) => { /** * This function does the work of listing the envelope's recipients - * @param {object} args An object with the following elements:
- * dsAPIclient: The DocuSign API Client object, already set with an access token and base url
- * accountId: Current account Id
- * envelopeId: envelope Id
+ * @param {object} args object */ // ***DS.worker.start ***DS.snippet.1.start eg005EnvelopeRecipients.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.envelopeId + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); diff --git a/lib/examples/eg006EnvelopeDocs.js b/lib/examples/eg006EnvelopeDocs.js index 93554960..c32cc8e7 100644 --- a/lib/examples/eg006EnvelopeDocs.js +++ b/lib/examples/eg006EnvelopeDocs.js @@ -100,13 +100,17 @@ eg006EnvelopeDocs.createController = async (req, res) => { /** * This function does the work of listing the envelope's documents - * @param {object} args An object with the following elements:
- * dsAPIclient: The DocuSign API Client object, already set with an access token and base url
- * accountId: Current account Id
- * envelopeId: envelope Id
+ * @param {object} args object */ // ***DS.worker.start ***DS.snippet.1.start eg006EnvelopeDocs.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.envelopeId + + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); diff --git a/lib/examples/eg007EnvelopeGetDoc.js b/lib/examples/eg007EnvelopeGetDoc.js index 1e93dd73..5752518d 100644 --- a/lib/examples/eg007EnvelopeGetDoc.js +++ b/lib/examples/eg007EnvelopeGetDoc.js @@ -90,7 +90,7 @@ eg007EnvelopeGetDoc.createController = async (req, res) => { /** * This function does the work of listing the envelope's recipients - * @param {object} args An object with the following elements:
+ * @param {object} args object with the following elements:
* dsAPIclient: The DocuSign API Client object, already set with an access token and base url
* accountId: Current account Id
* documentId: the document to be fetched
@@ -98,6 +98,14 @@ eg007EnvelopeGetDoc.createController = async (req, res) => { */ // ***DS.worker.start ***DS.snippet.1.start eg007EnvelopeGetDoc.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.documentId + // args.envelopeDocuments.envelopeId + // args.envelopeDocuments.documents -- array of {documentId, name, type} + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); diff --git a/lib/examples/eg008CreateTemplate.js b/lib/examples/eg008CreateTemplate.js index db774782..bb27ee29 100644 --- a/lib/examples/eg008CreateTemplate.js +++ b/lib/examples/eg008CreateTemplate.js @@ -79,16 +79,20 @@ eg008CreateTemplate.createController = async (req, res) => { /** * This function does the work of checking to see if the template exists and creating it if not. - * @param {object} args An object with the following elements:
- * dsAPIclient: The DocuSign API Client object, already set with an access token and base url
- * accountId: Current account Id
- * templateName: The template's name
+ * @param {object} args object */ // ***DS.worker.start ***DS.snippet.1.start eg008CreateTemplate.worker = async (args) => { - let dsApiClient = new docusign.ApiClient(); - dsApiClient.setBasePath(args.basePath); - dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.templateName + + + let dsApiClient = new docusign.ApiClient(); + dsApiClient.setBasePath(args.basePath); + dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); let templatesApi = new docusign.TemplatesApi(dsApiClient) , results = null , templateId = null // the template that exists or will be created. @@ -131,6 +135,11 @@ eg008CreateTemplate.createController = async (req, res) => { * @private */ function makeTemplate(){ + // Data for this method + // demoDocsPath -- module global + // docFile -- module global + // templateName -- module global + // document 1 (pdf) has tag /sn1/ // // The template has two recipient roles. diff --git a/lib/examples/eg009UseTemplate.js b/lib/examples/eg009UseTemplate.js index 92a2c53c..e720bb80 100644 --- a/lib/examples/eg009UseTemplate.js +++ b/lib/examples/eg009UseTemplate.js @@ -98,15 +98,16 @@ eg009UseTemplate.createController = async (req, res) => { /** * This function does the work of creating the envelope - * @param {object} args An object with the following elements:
- * dsAPIclient: The DocuSign API Client object, already set with an access token and base url
- * accountId: Current account Id
- * envelopeArgs: envelopeArgs, an object with elements - * templateId, signerEmail, signerName, - * ccEmail, ccName + * @param {object} args object */ // ***DS.worker.start ***DS.snippet.1.start eg009UseTemplate.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); @@ -128,13 +129,19 @@ eg009UseTemplate.worker = async (args) => { /** * Creates envelope from the template * @function - * @param {Object} args parameters for the envelope: - * signerEmail, signerName, ccEmail, ccName, - * templateId + * @param {Object} args object * @returns {Envelope} An envelope definition * @private */ function makeEnvelope(args){ + // Data for this method + // args.signerEmail + // args.signerName + // args.ccEmail + // args.ccName + // args.templateId + + // The envelope has two recipients. // recipient 1 - signer // recipient 2 - cc diff --git a/lib/examples/eg010SendBinaryDocs.js b/lib/examples/eg010SendBinaryDocs.js index 4dec5012..97aa59e2 100644 --- a/lib/examples/eg010SendBinaryDocs.js +++ b/lib/examples/eg010SendBinaryDocs.js @@ -99,18 +99,18 @@ eg010SendBinaryDocs.createController = async (req, res) => { /** * This function does the work of creating the envelope by using * the API directly with multipart mime - * @param {object} args An object with the following elements:
- * accountId: Current account Id
- * basePath: base path for making API call
- * accessToken: a valid access token
- * demoDocsPath: relative path for the demo docs
- * doc2File: file name for doc 2
- * doc3File: file name for doc 3
- * envelopeArgs: envelopeArgs, an object with elements
- * signerEmail, signerName, ccEmail, ccName + * @param {object} args object */ // ***DS.worker.start ***DS.snippet.1.start eg010SendBinaryDocs.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // demoDocsPath: relative path for the demo docs + // doc2File: file name for doc 2 + // doc3File: file name for doc 3 + // Step 1. Make the envelope JSON request body let envelopeJSON = makeEnvelopeJSON( args.envelopeArgs ) @@ -195,12 +195,17 @@ eg010SendBinaryDocs.worker = async (args) => { *
DocuSign will convert all of the documents to the PDF format. *
The recipients' field tags are placed using anchor strings. * @function - * @param {Object} args parameters for the envelope: - * signerEmail, signerName, ccEmail, ccName + * @param {Object} args object * @returns {Envelope} An envelope definition * @private */ function makeEnvelopeJSON(args){ + // Data for this method + // args.signerEmail + // args.signerName + // args.ccEmail + // args.ccName + // document 1 (html) has tag **signature_1** // document 2 (docx) has tag /sn1/ // document 3 (pdf) has tag /sn1/ @@ -291,12 +296,16 @@ function makeEnvelopeJSON(args){ * Creates document 1 * @function * @private - * @param {Object} args parameters for the envelope: - * signerEmail, signerName, ccEmail, ccName + * @param {Object} args object * @returns {string} A document in HTML format */ - function document1(args) { + // Data for this method + // args.signerEmail + // args.signerName + // args.ccEmail + // args.ccName + return ` diff --git a/lib/examples/eg011EmbeddedSending.js b/lib/examples/eg011EmbeddedSending.js index fe8c8d0f..a36b973b 100644 --- a/lib/examples/eg011EmbeddedSending.js +++ b/lib/examples/eg011EmbeddedSending.js @@ -93,15 +93,16 @@ eg011EmbeddedSending.createController = async (req, res) => { /** * This function does the work of creating the envelope in * draft mode and returning a URL for the sender's view - * @param {object} args An object with the following elements:
- * dsAPIclient: The DocuSign API Client object, already set with an access token and base url
- * accountId: Current account Id
- * senderView: tagging or recipient - * envelopeArgs: envelopeArgs, an object with elements - * signerEmail, signerName, ccEmail, ccName + * @param {object} args object */ // ***DS.worker.start ***DS.snippet.1.start eg011EmbeddedSending.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.startingView -- 'recipient' or 'tagging' + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); @@ -134,15 +135,12 @@ eg011EmbeddedSending.worker = async (args) => { // ***DS.snippet.3.start function makeSenderViewRequest(args) { let viewRequest = new docusign.ReturnUrlRequest(); + // Data for this method + // args.dsReturnUrl // Set the url where you want the recipient to go once they are done signing // should typically be a callback route somewhere in your app. - // The query parameter is included as an example of how - // to save/recover state information during the redirect to - // the DocuSign signing ceremony. It's usually better to use - // the session mechanism of your web framework. Query parameters - // can be changed/spoofed very easily. - viewRequest.returnUrl = args.dsReturnUrl + "?state=123"; + viewRequest.returnUrl = args.dsReturnUrl; return viewRequest } // ***DS.snippet.3.end diff --git a/lib/examples/eg012EmbeddedConsole.js b/lib/examples/eg012EmbeddedConsole.js index 6ce64950..b39af588 100644 --- a/lib/examples/eg012EmbeddedConsole.js +++ b/lib/examples/eg012EmbeddedConsole.js @@ -78,15 +78,18 @@ eg012EmbeddedConsole.createController = async (req, res) => { /** * This function does the work of returning a URL for the NDSE view - * @param {object} args An object with the following elements:
- * dsAPIclient: The DocuSign API Client object, already set - * with an access token and base url
- * accountId: Current account Id
- * dsReturnUrl: the return url back to this app - * envelopeId: optional envelope for the NDSE to focus on + * @param {object} args object */ // ***DS.worker.start ***DS.snippet.1.start eg012EmbeddedConsole.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.dsReturnUrl + // args.startingView + // args.envelopeId + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); @@ -106,6 +109,11 @@ eg012EmbeddedConsole.worker = async (args) => { // ***DS.snippet.2.start function makeConsoleViewRequest(args) { + // Data for this method + // args.dsReturnUrl + // args.startingView + // args.envelopeId + let viewRequest = new docusign.ConsoleViewRequest(); // Set the url where you want the recipient to go once they are done // with the NDSE. It is usually the case that the diff --git a/lib/examples/eg013AddDocToTemplate.js b/lib/examples/eg013AddDocToTemplate.js index 76e06cd9..de3317a9 100644 --- a/lib/examples/eg013AddDocToTemplate.js +++ b/lib/examples/eg013AddDocToTemplate.js @@ -111,16 +111,15 @@ eg013AddDocToTemplate.createController = async (req, res) => { /** * This function does the work of creating the envelope and the * embedded Signing Ceremony - * @param {object} args An object with the following elements:
- * dsAPIclient: The DocuSign API Client object, already set with an access token and base url
- * accountId: Current account Id
- * envelopeArgs: envelopeArgs, an object with elements - * templateId, item, quantity - * signerEmail, signerName, signerClientId - * ccEmail, ccName + * @param {object} args object */ // ***DS.worker.start ***DS.snippet.1.start eg013AddDocToTemplate.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); @@ -152,14 +151,19 @@ eg013AddDocToTemplate.worker = async (args) => { /** * Creates envelope * @function - * @param {Object} args parameters for the envelope: - * templateId, item, quantity - * signerEmail, signerName, signerClientId - * ccEmail, ccName + * @param {Object} args object * @returns {Envelope} An envelope definition * @private */ function makeEnvelope(args){ + // Data for this method + // args.signerEmail + // args.signerName + // args.signerClientId + // args.ccEmail + // args.ccName + // args.templateId + // The envelope request object uses Composite Template to // include in the envelope: // 1. A template stored on the DocuSign service @@ -271,6 +275,14 @@ function makeEnvelope(args){ */ function document1(args) { + // Data for this method + // args.signerEmail + // args.signerName + // args.ccEmail + // args.ccName + // args.item + // args.quantity + return ` @@ -301,16 +313,19 @@ function document1(args) { // ***DS.snippet.4.start function makeRecipientViewRequest(args) { + // Data for this method + // args.dsReturnUrl + // args.signerEmail + // args.signerName + // args.signerClientId + // args.dsPingUrl + + let viewRequest = new docusign.RecipientViewRequest(); // Set the url where you want the recipient to go once they are done signing // should typically be a callback route somewhere in your app. - // The query parameter is included as an example of how - // to save/recover state information during the redirect to - // the DocuSign signing ceremony. It's usually better to use - // the session mechanism of your web framework. Query parameters - // can be changed/spoofed very easily. - viewRequest.returnUrl = args.dsReturnUrl + "?state=123"; + viewRequest.returnUrl = args.dsReturnUrl; // How has your app authenticated the user? In addition to your app's // authentication, you can include authenticate steps from DocuSign. diff --git a/lib/examples/eg014CollectPayment.js b/lib/examples/eg014CollectPayment.js index 161bcd3b..20c4a800 100644 --- a/lib/examples/eg014CollectPayment.js +++ b/lib/examples/eg014CollectPayment.js @@ -93,16 +93,15 @@ eg014CollectPayment.createController = async (req, res) => { /** * This function does the work of creating the envelope - * @param {object} args An object with the following elements:
- * dsAPIclient: The DocuSign API Client object, already set with an access token and base url
- * accountId: Current account Id
- * envelopeArgs: envelopeArgs, an object with elements - * status: envelope status: "sent" | "created" - * signerEmail, signerName, ccEmail, ccName - * paymentGatewayId + * @param {object} args object */ // ***DS.worker.start ***DS.snippet.1.start eg014CollectPayment.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); @@ -127,14 +126,24 @@ eg014CollectPayment.worker = async (args) => { *
DocuSign will convert all of the documents to the PDF format. *
The recipients' field tags are placed using anchor strings. * @function - * @param {Object} args parameters for the envelope: - * status: envelope status: "sent" | "created" - * signerEmail, signerName, ccEmail, ccName - * paymentGatewayId + * @param {Object} args object * @returns {Envelope} An envelope definition * @private */ function makeEnvelope(args){ + // Data for this method + // args.signerEmail + // args.signerName + // args.ccEmail + // args.ccName + // args.status + // args.gatewayAccountId + // args.gatewayName + // args.gatewayDisplayName + // demoDocsPath -- module global + // doc1File -- module global + + // document 1 (html) has multiple tags: // /l1q/ and /l2q/ -- quantities: drop down // /l1e/ and /l2e/ -- extended: payment lines diff --git a/lib/examples/eg015EnvelopeTabData.js b/lib/examples/eg015EnvelopeTabData.js index f1c6ee58..45c2ec04 100644 --- a/lib/examples/eg015EnvelopeTabData.js +++ b/lib/examples/eg015EnvelopeTabData.js @@ -87,6 +87,12 @@ eg015EnvelopeTabData.createController = async (req, res) => { */ // ***DS.worker.start ***DS.snippet.1.start eg015EnvelopeTabData.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.envelopeId + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); diff --git a/lib/examples/eg016SetTabValues.js b/lib/examples/eg016SetTabValues.js index df851895..56b720d8 100644 --- a/lib/examples/eg016SetTabValues.js +++ b/lib/examples/eg016SetTabValues.js @@ -17,7 +17,6 @@ const eg016SetTabValues = exports , minimumBufferMin = 3 , signerClientId = 1000 // The id of the signer within this application. , dsReturnUrl = dsConfig.appUrl + '/ds-return' - , dsPingUrl = dsConfig.appUrl + '/' // Url that will be pinged by the DocuSign Signing Ceremony via Ajax ; @@ -51,8 +50,7 @@ eg016SetTabValues.createController = async (req, res) => { signerEmail: signerEmail, signerName: signerName, signerClientId: signerClientId, - dsReturnUrl: dsReturnUrl, - dsPingUrl: dsPingUrl + dsReturnUrl: dsReturnUrl } , args = { accessToken: req.user.accessToken, @@ -95,6 +93,16 @@ eg016SetTabValues.createController = async (req, res) => { */ // ***DS.worker.start ***DS.snippet.1.start eg016SetTabValues.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.envelopeArgs.signerEmail + // args.envelopeArgs.signerName + // args.envelopeArgs.signerClientId + // args.envelopeArgs.dsReturnUrl + + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken); @@ -137,6 +145,12 @@ eg016SetTabValues.worker = async (args) => { * @private */ function makeEnvelope(args){ + // Data for this method + // args.signerEmail + // args.signerName + // args.signerClientId + + // document 1 (docx) has tags // /sn1/ - signature field // /salary/ - yearly salary diff --git a/lib/examples/eg017SetTemplateTabValues.js b/lib/examples/eg017SetTemplateTabValues.js index 466010e8..9c5f0024 100644 --- a/lib/examples/eg017SetTemplateTabValues.js +++ b/lib/examples/eg017SetTemplateTabValues.js @@ -105,6 +105,15 @@ eg017SetTemplateTabValues.createController = async (req, res) => { */ // ***DS.worker.start ***DS.snippet.1.start eg017SetTemplateTabValues.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.envelopeArgs.signerEmail + // args.envelopeArgs.signerName + // args.envelopeArgs.signerClientId + // args.envelopeArgs.dsReturnUrl + // 1. Create envelope definition let envelopeArgs = args.envelopeArgs , envelopeDefinition = makeEnvelope(envelopeArgs); @@ -145,6 +154,14 @@ eg017SetTemplateTabValues.worker = async (args) => { * @private */ function makeEnvelope(args){ + // Data for this method + // args.signerEmail + // args.signerName + // args.signerClientId + // args.ccEmail + // args.ccName + // args.templateId + // The envelope has two recipients. // recipient 1 - signer // recipient 2 - cc diff --git a/lib/examples/eg018EnvelopeCustomFieldData.js b/lib/examples/eg018EnvelopeCustomFieldData.js index c31094d5..a50d3da8 100644 --- a/lib/examples/eg018EnvelopeCustomFieldData.js +++ b/lib/examples/eg018EnvelopeCustomFieldData.js @@ -87,6 +87,12 @@ eg018EnvelopeCustomFieldData.createController = async (req, res) => { */ // ***DS.worker.start ***DS.snippet.1.start eg018EnvelopeCustomFieldData.worker = async (args) => { + // Data for this method + // args.basePath + // args.accessToken + // args.accountId + // args.envelopeId + let dsApiClient = new docusign.ApiClient(); dsApiClient.setBasePath(args.basePath); dsApiClient.addDefaultHeader('Authorization', 'Bearer ' + args.accessToken);