Skip to content

Commit 3041684

Browse files
connorl-docusignconnorl-docusign
authored
Merge pull request #49 from docusign/DEVDOCS-6404
Changed bulk send formatting and removed step 6
2 parents bbce7e4 + e60276a commit 3041684

File tree

4 files changed

+54
-101
lines changed

4 files changed

+54
-101
lines changed

‎lib/eSignature/controllers/eg031BulkSendEnvelope.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,9 @@ eg031BulkSendEnvelopes.createController = async (req, res) => {
8484
console.log(results)
8585
res.render('pages/example_done', {
8686
title: "Bulk sent",
87-
h1: "Bulk send envelope was successfully performed!",
88-
message: `Bulk request queued to ${results.queued} user lists.`
87+
h1: "Bulk send envelopes",
88+
message: `Results from BulkSend:getBulkSendBatchStatus method:`,
89+
json: JSON.stringify(results)
8990
});
9091
}
9192
}

‎lib/eSignature/examples/bulkSendEnvelope.js‎

Lines changed: 5 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
name: "Multi Bulk Recipient::cc",
9696
email: "multiBulkRecipients-cc@docusign.com",
9797
roleName: "cc",
98-
routingOrder: "1",
98+
routingOrder: "2",
9999
status: "created",
100100
deliveryMethod: "email",
101101
recipientId: "2",
@@ -124,44 +124,8 @@
124124
});
125125
// Step 5 end
126126

127-
// Add placeholder recipients
128-
// These will be replaced by the details provided in the Bulk List uploaded during Step 3
129-
// Note: The name / email format used is:
130-
// Name: Multi Bulk Recipients::{rolename}
131-
// Email: MultiBulkRecipients-{rolename}@docusign.com
132-
// Step 6 start
133-
await envelopeApi.createRecipient(args.accountId, envelope.envelopeId, {
134-
recipients: {
135-
signers: [
136-
{
137-
name: "Multi Bulk Recipient::signer",
138-
email: "multiBulkRecipients-signer@docusign.com",
139-
roleName: "signer",
140-
routingOrder: "1",
141-
status: "created",
142-
deliveryMethod: "email",
143-
recipientId: "1",
144-
recipientType: "signer",
145-
}
146-
],
147-
carbonCopies: [
148-
{
149-
name: "Multi Bulk Recipient::cc",
150-
email: "multiBulkRecipients-cc@docusign.com",
151-
roleName: "cc",
152-
routingOrder: "1",
153-
status: "created",
154-
deliveryMethod: "email",
155-
recipientId: "2",
156-
recipientType: "cc",
157-
},
158-
],
159-
},
160-
});
161-
// Step 6 end
162-
163127
//Initiate the Bulk Send by posting your listId, and the envelopeId
164-
// Step 7 start
128+
// Step 6 start
165129
let bulkResult = await bulkEnvelopesApi.createBulkSendRequest(
166130
args.accountId,
167131
bulkList.listId,
@@ -171,15 +135,15 @@
171135
},
172136
}
173137
);
174-
// Step 7 end
138+
// Step 6 end
175139

176140
// Confirm successful bulk send
177-
// Step 8 start
141+
// Step 7 start
178142
let results = await bulkEnvelopesApi.getBulkSendBatchStatus(
179143
args.accountId,
180144
bulkResult.batchId
181145
);
182-
// Step 8 end
146+
// Step 7 end
183147

184148
return results;
185149
};

‎views/pages/examples/eg031BulkSendEnvelopes.ejs‎

Lines changed: 38 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,67 @@
11
<% include ../../partials/examplesHead %>
22

3-
<h4>31. Bulk sending envelopes to multiple recipients.</h4>
3+
<h4>31. Bulk send envelopes</h4>
44

55
<p>
6-
Method BulkSend::createBulkSendList creates a bulk send list that you can use to send an envelope to up to 1,000 recipients at once.
6+
Demonstrates how to send envelopes in bulk to multiple recipients. First, this example creates a bulk send recipients list, then creates an envelope. After that,
7+
it initiates bulk envelope sending.
78
</p>
89

910
<% include ../../partials/docBody %>
1011

1112
<p>
1213
API methods used:
13-
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/create/">EnvelopeRecipients::create</a>,
14-
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>,
15-
<a target="_blank" href="https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/BulkEnvelopes/get">BulkEnvelopes::get</a>,
16-
<a target="_blank" href="https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeCustomFields/create">EnvelopeCustomFields::create</a>,
17-
<a target="_blank" href="https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendList">BulkSend::createBulkSendList</a>
18-
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/create/">EnvelopeRecipients::create</a>.
14+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/">BulkSend:createBulkSendList</a>,
15+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes:create</a>,
16+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/create/">EnvelopeCustomFields:create</a>,
17+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/">BulkSend:createBulkSendRequest</a>,
18+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendbatchstatus/">BulkSend:getBulkSendBatchStatus</a>
1919
</p>
2020

2121

2222
<% include ../../partials/gitSource %>
2323

2424
<form action="" class="eg" method="post" data-busy="form">
2525

26-
<h5 class="mt-4"> Bulk copy #1</h5>
2726
<div class="row">
2827
<div class="col-md-6 column">
29-
<div class='form-group'>
30-
<label for= "">Signer name</label >
31-
<input type = 'text' name = "signerName1" id = "signerName1" placeholder = "Bob" required class='form-control'/>
32-
</div>
33-
<div class='form-group'>
34-
<label for= "">Signer Email</label >
35-
<input type = 'mail' name = "signerEmail1" id = "signerEmail1" placeholder = "bob@mail.com" required class='form-control'/>
36-
</div>
37-
</div>
38-
<div class="col-md-6 column">
39-
<div class='form-group'>
40-
<label for= "">CC name</label >
41-
<input type = 'text' name = "ccName1" id = "ccName1" placeholder = "Alice" required class='form-control'/>
42-
</div>
43-
<div class='form-group'>
44-
<label for= "">CC Email</label >
45-
<input type = 'mail' name = "ccEmail1" id = "ccEmail1" placeholder = "alice@mail.com" required class='form-control'/>
46-
</div>
47-
</div>
48-
</div>
49-
50-
<h5 class="mt-4"> Bulk copy #2</h5>
51-
<div class="row">
52-
<div class="col-md-6 column">
53-
<div class='form-group'>
54-
<label for= "">Signer name</label >
55-
<input type = 'text' name = "signerName2" id = "signerName2" placeholder = "Eve" required class='form-control'/>
56-
</div>
28+
<h5 class="mt-4"> Bulk copy #1</h5>
5729
<div class='form-group'>
5830
<label for= "">Signer Email</label >
59-
<input type = 'mail' name = "signerEmail2" id = "signerEmail2" placeholder = "eve@mail.com" required class='form-control'/>
31+
<input type = 'mail' name = "signerEmail1" id = "signerEmail1" placeholder = "bob@mail.com" required class='form-control'/>
6032
</div>
61-
</div>
62-
<div class="col-md-6 column">
6333
<div class='form-group'>
64-
<label for= "">CC name</label >
65-
<input type = 'text' name = "ccName2" id = "ccName2" placeholder = "Ted" required class='form-control'/>
34+
<label for= "">Signer Name</label >
35+
<input type = 'text' name = "signerName1" id = "signerName1" placeholder = "Bob" required class='form-control'/>
6636
</div>
6737
<div class='form-group'>
6838
<label for= "">CC Email</label >
69-
<input type = 'mail' name = "ccEmail2" id = "ccEmail2" placeholder = "ted@mail.com" required class='form-control'/>
39+
<input type = 'mail' name = "ccEmail1" id = "ccEmail1" placeholder = "alice@mail.com" required class='form-control'/>
7040
</div>
41+
<div class='form-group'>
42+
<label for= "">CC Name</label >
43+
<input type = 'text' name = "ccName1" id = "ccName1" placeholder = "Alice" required class='form-control'/>
44+
</div>
45+
</div>
46+
47+
<div class="col-md-6 column">
48+
<h5 class="mt-4"> Bulk copy #2</h5>
49+
<div class='form-group'>
50+
<label for= "">Signer Email</label >
51+
<input type = 'mail' name = "signerEmail2" id = "signerEmail2" placeholder = "eve@mail.com" required class='form-control'/>
52+
</div>
53+
<div class='form-group'>
54+
<label for= "">Signer Name</label >
55+
<input type = 'text' name = "signerName2" id = "signerName2" placeholder = "Eve" required class='form-control'/>
56+
</div>
57+
<div class='form-group'>
58+
<label for= "">CC Email</label >
59+
<input type = 'mail' name = "ccEmail2" id = "ccEmail2" placeholder = "ted@mail.com" required class='form-control'/>
60+
</div>
61+
<div class='form-group'>
62+
<label for= "">CC Name</label >
63+
<input type = 'text' name = "ccName2" id = "ccName2" placeholder = "Ted" required class='form-control'/>
64+
</div>
7165
</div>
7266
</div>
7367

@@ -76,4 +70,4 @@
7670
</form>
7771

7872

79-
<% include ../../partials/examplesFoot %>
73+
<% include ../../partials/examplesFoot %>

‎views/pages/index_esignature_examples.ejs‎

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -249,24 +249,18 @@
249249

250250
<h2>Bulk operations</h2>
251251

252-
<h4 id="example031">31. <a href="eg031">Bulk sending envelopes to multiple recipients.</a></h4>
252+
<h4 id="example031">31. <a href="eg031">Bulk send envelopes</a></h4>
253253
<p>
254-
Method BulkSend::createBulkSendList creates a bulk send list that you can use to send an envelope to up to 1,000
255-
recipients at once.
254+
Demonstrates how to send envelopes in bulk to multiple recipients. First, this example creates a bulk send recipients list,
255+
then creates an envelope. After that, it initiates bulk envelope sending.
256256
</p>
257257
<p>
258258
API methods used:
259-
<a target="_blank"
260-
href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/create/">EnvelopeRecipients::create</a>,
261-
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>,
262-
<a target="_blank"
263-
href="https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/BulkEnvelopes/get">BulkEnvelopes::get</a>,
264-
<a target="_blank"
265-
href="https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeCustomFields/create">EnvelopeCustomFields::create</a>,
266-
<a target="_blank"
267-
href="https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendList">BulkSend::createBulkSendList</a>
268-
<a target="_blank"
269-
href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/create/">EnvelopeRecipients::create</a>.
259+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/">BulkSend:createBulkSendList</a>,
260+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes:create</a>,
261+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/create/">EnvelopeCustomFields:create</a>,
262+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/">BulkSend:createBulkSendRequest</a>,
263+
<a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendbatchstatus/">BulkSend:getBulkSendBatchStatus</a>
270264
</p>
271265

272266
<h2>Advanced recipient routing</h2>

0 commit comments

Comments
 (0)