forked from docusign/code-examples-csharp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathExtensionManifestPHP.json
477 lines (477 loc) · 24.7 KB
/
ExtensionManifestPHP.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
{
"codeExamples": [
{
"number": "1",
"name": "Embedded Signing Ceremony",
"description": "This example sends an envelope, and then uses an embedded signing ceremony for the first signer. With embedded signing, the DocuSign signing ceremony is initiated from your website.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/CreateAnEnvelopeService.php",
"method": "SendEnvelopeForEmbeddedSigning",
"apiType": "ESignature"
},
{
"number": "2",
"name": "Send an envelope with a remote (email) signer and cc recipient",
"description": "The envelope includes a pdf, Word, and HTML document. Anchor text (AutoPlace) is used to position the signing fields in the documents.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/SigningViaEmailService.php",
"method": "SendEnvelopeViaEmail",
"apiType": "ESignature"
},
{
"number": "3",
"name": "List envelopes in the user's account",
"description": "The envelopes' current status is included.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/ListEnvelopesService.php",
"method": "ListAllEnvelope",
"apiType": "ESignature"
},
{
"number": "4",
"name": "Get an envelope's basic information",
"description": "The example lists the basic information about an envelope, including its overall status.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/EnvelopeInfoService.php",
"method": "GetEnvelope",
"apiType": "ESignature"
},
{
"number": "5",
"name": "List an envelope's recipients",
"description": "Includes current recipient status.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/EnvelopeRecipientsService.php",
"method": "GetRecipients",
"apiType": "ESignature"
},
{
"number": "6",
"name": "Listing Envelope Documents",
"description": "This code example demonstrates how to retrieve a list of all documents within a specific envelope.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/EnvelopeDocsService.php",
"method": "GetDocuments",
"apiType": "ESignature"
},
{
"number": "7",
"name": "Downloading Envelope Documents",
"description": "The example can download individual documents, the documents concatenated together, or a zip file of the documents.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/EnvelopeGetDocService.php",
"method": "DownloadDocument",
"apiType": "ESignature"
},
{
"number": "8",
"name": "Programmatically create a template",
"description": "This code example demonstrates how to create a new DocuSign template using the eSignature API.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/CreateTemplateService.php",
"method": "CreateTemplate",
"apiType": "ESignature"
},
{
"number": "9",
"name": "Send an envelope using a template",
"description": "This code example demonstrates how to generate a new envelope from an existing template.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/UseTemplateService.php",
"method": "SendEnvelopeFromTemplate",
"apiType": "ESignature"
},
{
"number": "10",
"name": "Send an envelope and upload its documents with multpart binary transfer",
"description": "Binary transfer is 33% more efficient than using Base64 encoding.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/SendBinaryDocsService.php",
"method": "CreateAndSendEnvelope",
"apiType": "ESignature"
},
{
"number": "11",
"name": "Embedded sending",
"description": "Embeds the DocuSign web tool (NDSE) in your web app to finalize or update the envelope and documents before they are sent.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/EmbeddedSendingService.php",
"method": "SendEnvelopeUsingEmbeddedSending",
"apiType": "ESignature"
},
{
"number": "12",
"name": "Embedded DocuSign web tool (NDSE).",
"description": "Embeds the DocuSign web tool (NDSE) in your web app.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/EmbeddedConsoleService.php",
"method": "CreateEmbeddedConsoleView",
"apiType": "ESignature"
},
{
"number": "13",
"name": "Embedded Signing Ceremony from a template with an added document.",
"description": "This example sends an envelope based on a template. In addition to the template's document(s), the example adds an additional document to the envelope by using the Composite Templates feature.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/AddDocToTemplateService.php",
"method": "CreateEnvelopeUsingCompositeTemplate",
"apiType": "ESignature"
},
{
"number": "14",
"name": "Payments example: an order form, with online payment by credit card",
"description": "This code example demonstrates how to create an envelope that enables the recipients to also submit a payment when signing the envelope.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/CollectPaymentService.php",
"method": "CreateEnvelopeWithPayment",
"apiType": "ESignature"
},
{
"number": "15",
"name": "Get the envelope tab data.",
"description": "Retrieve the tab (field) values for all of the envelope's recipients. ",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/EnvelopeTabDataService.php",
"method": "GetEnvelopeFormData",
"apiType": "ESignature"
},
{
"number": "16",
"name": "Set envelope tab values",
"description": "The example creates an envelope and sets the initial values for its tabs (fields). Some of the tabs are set to be read-only, others can be updated by the recipient. The example also stores metadata with the envelope.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/SetTabValuesService.php",
"method": "CreateEnvelopeAndUpdateTabData",
"apiType": "ESignature"
},
{
"number": "17",
"name": "Set template tab values",
"description": "The example creates an envelope using a template and sets the initial values for its tabs (fields). The example also stores metadata with the envelope. ",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/SetTemplateTabValuesService.php",
"method": "CreateEnvelopeFromTempalteAndUpdateTabValues",
"apiType": "ESignature"
},
{
"number": "18",
"name": "Get the envelope custom field data (metadata)",
"description": "The example retrieves the custom metadata (custom data fields) stored with the envelope. ",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/EnvelopeCustomFieldDataService.php",
"method": "ListAllCustomFieldsForEnvelope",
"apiType": "ESignature"
},
{
"number": "19",
"name": "Requiring an Access Code for a Recipient",
"description": "This example sends an envelope that requires an access-code for the purpose of multi-factor authentication.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/AccessCodeAuthenticationService.php",
"method": "CreateEnvelopeWithRecipientUsingAccessCodeAuth",
"apiType": "ESignature"
},
{
"number": "20",
"name": "Requiring Phone authentication for a recipient",
"description": "This example sends an envelope that requires entering in a voice-based response code for the purpose of multi-factor authentication.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/PhoneAuthenticationService.php",
"method": "CreateEnvelopeWithRecipientUsingPhoneAuth",
"apiType": "ESignature"
},
{
"number": "21",
"name": "Requiring Knowledge-Based Authentication (KBA) for a Recipient",
"description": "This example sends an envelope that requires passing a Public records check to validate identity for the purpose of multi-factor authentication.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/KbAuthenticationService.php",
"method": "CreateEnvelopeWithRecipientUsingKBAAuth",
"apiType": "ESignature"
},
{
"number": "22",
"name": "Requiring ID Verification (IDV) for a recipient",
"description": "This example sends an envelope that requires submitting a photo of a government issued id for the purpose of multi-factor authentication.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/IDVAuthenticationService.php",
"method": "CreateEnvelopeWithRecipientUsingIDVAuth",
"apiType": "ESignature"
},
{
"number": "23",
"name": "Creating a permission profile",
"description": "This example creates a new permission profile that can be assigned to users in the DocuSign account.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/PermissionCreateService.php",
"method": "Create",
"apiType": "ESignature"
},
{
"number": "24",
"name": "Setting a permission profile",
"description": "This example applies an existing permission profile to a group of users in the DocuSign account.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/PermissionSetUserGroupService.php",
"method": "GetGroupInformation",
"apiType": "ESignature"
},
{
"number": "25",
"name": "Updating individual permission settings",
"description": "This example updates the settings of an existing permission profile.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/PermissionChangeSingleSettingService.php",
"method": "UpdatePermissionProfile",
"apiType": "ESignature"
},
{
"number": "26",
"name": "Deleting a permission profile",
"description": "This example deletes a permission profile.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/PermissionDeleteService.php",
"method": "DeletePermissionProfile",
"apiType": "ESignature"
},
{
"number": "27",
"name": "Creating a brand",
"description": "This example creates a new brand that can be used to customize the user experience of envelopes in the DocuSign account.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/CreateBrandService.php",
"method": "Create",
"apiType": "ESignature"
},
{
"number": "28",
"name": "Applying a brand to an envelope",
"description": "This example creates a new envelope and applies an existing brand to that envelope.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/ApplyBrandToEnvelopeService.php",
"method": "CreateEnvelopeWithBranding",
"apiType": "ESignature"
},
{
"number": "29",
"name": "Applying a brand and template to an envelope",
"description": "This example creates a new envelope from a template and also applies an existing brand to it.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/ApplyBrandToTemplateService.php",
"method": "CreateEnvelopeFromTemplateWithBrand",
"apiType": "ESignature"
},
{
"number": "30",
"name": "Bulk sending envelopes to multiple recipients",
"description": "This example sends an envelope to multiple recipients by using the DocuSign Bulk Send feature.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/BulkSendEnvelopesService.php",
"method": "GetStatus",
"apiType": "ESignature"
},
{
"number": "31",
"name": "Pause a signature workflow",
"description": "This example creates and envelope and then pauses the signature workflow",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/PauseSignatureWorkflowService.php",
"method": "PauseWorkflow",
"apiType": "ESignature"
},
{
"number": "32",
"name": "Unpause a signature workflow",
"description": "This example unpauses a signature workflow for the previously created envelope that was paused.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/UnpauseSignatureWorkflowService.php",
"method": "UnpauseWorkflow",
"apiType": "ESignature"
},
{
"number": "33",
"name": "Conditional recipients",
"description": "This example creates an envelope that is routed to different recipients based on a predefined condition.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/UseConditionalRecipientsService.php",
"method": "SendEnvelope",
"apiType": "ESignature"
},
{
"number": "34",
"name": "Schedule an envelope",
"description": "Demonstrates how to schedule an envelope using the scheduled sending feature.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/ScheduledSendingService.php",
"method": "ScheduleEnvelope",
"apiType": "ESignature"
},
{
"number": "35",
"name": "Send an envelope with delayed routing",
"description": "Demonstrates how to delay an envelope's delivery between recipients using the delayed routing feature.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/DelayedRoutingService.php",
"method": "SendWithDelayedRouting",
"apiType": "ESignature"
},
{
"number": "36",
"name": "Request Signature by SMS",
"description": "This example demonstrates how to send a signature request for a signer (and CC) to read and sign via an SMS message.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/SMSDeliveryService.php",
"method": "SendRequestViaSMS",
"apiType": "ESignature"
},
{
"number": "37",
"name": "Create a signable HTML document",
"description": "Demonstrates how to create an HTML document for responsive signing.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/ResponsiveSigningService.php",
"method": "worker",
"apiType": "ESignature"
},
{
"number": "38",
"name": "Create Clickwraps",
"description": "This example shows how to create a clickwrap.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Click/CreateClickwrapService.php",
"method": "CreateClickwrap",
"apiType": "Click"
},
{
"number": "39",
"name": "Activate Clickwrap",
"description": "This example shows how to activate a clickwrap.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Click/ActivateClickwrapService.php",
"method": "UpdateClickwrapVersion",
"apiType": "Click"
},
{
"number": "40",
"name": "Clickwrap Versioning",
"description": "This example shows how to create a new clickwrap version.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Click/CreateNewClickwrapVersionService.php",
"method": "UpdateClickwrapVersion",
"apiType": "Click"
},
{
"number": "41",
"name": "Retrieve Clickwraps",
"description": "This example shows how to get a list of clickwraps.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Click/GetClickwrapsService.php",
"method": "GetClickwraps",
"apiType": "Click"
},
{
"number": "42",
"name": "Get Clickwrap Responses",
"description": "This example shows how to get clickwrap responses.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Click/GetClickwrapResponseService.php",
"method": "GetClickwrapAgreements",
"apiType": "Click"
},
{
"number": "43",
"name": "Create a room with data",
"description": "This example creates a room using specified data.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Rooms/CreateRoomsWithDataService.php",
"method": "CreateRoom",
"apiType": "Rooms"
},
{
"number": "44",
"name": "Create a room from template",
"description": "This example creates a room from a template.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Rooms/CreateRoomWithTemplatesService.php",
"method": "CreateRoom",
"apiType": "Rooms"
},
{
"number": "45",
"name": "Export data from a room",
"description": "This example exports data from a room.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Rooms/ExportDataFromRoomService.php",
"method": "GetRoomFieldData",
"apiType": "Rooms"
},
{
"number": "46",
"name": "Add form to a room",
"description": "This example adds form to a room.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Rooms/AddFormsToRoomService.php",
"method": "AddFormToRoom",
"apiType": "Rooms"
},
{
"number": "47",
"name": "Get filtered rooms",
"description": "This example returns rooms by filter.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Rooms/GetRoomsWithFiltersService.php",
"method": "GetRooms",
"apiType": "Rooms"
},
{
"number": "48",
"name": "Create external form fill session",
"description": "This is an example of creating external form fill session.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Rooms/CreateExternalFormFillSessionService.php",
"method": "CreateExternalFormFillSession",
"apiType": "Rooms"
},
{
"number": "49",
"name": "Create a form group",
"description": "This is an example of creating a form group for your DocuSign Rooms for Real Estate account.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Rooms/CreateFormGroupService.php",
"method": "CreateFormGroup",
"apiType": "Rooms"
},
{
"number": "50",
"name": "Grants office access to a form group",
"description": "This is an example of granting office access to a form group.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Rooms/GrantOfficeAccessToFormGroupService.php",
"method": "GrantOfficeAccessToFormGroup",
"apiType": "Rooms"
},
{
"number": "51",
"name": "Assign a form to a form group",
"description": "This is an example of assigning a form to a form group.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Rooms/AssignFormToFormGroupService.php",
"method": "AssignFormGroupForm",
"apiType": "Rooms"
},
{
"number": "52",
"name": "Getting the monitoring data",
"description": "Demonstrates how to get and display all of your organization’s monitoring data.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Monitor/GetMonitoringDataService.php",
"method": "GetMonitoringData",
"apiType": "Monitor"
},
{
"number": "53",
"name": "Send an envelope to an In Person Signer",
"description": "Demonstrates how to host an In Person Signing session with embedded signing.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/InPersonSigningService.php",
"method": "worker",
"apiType": "ESignature"
},
{
"number": "54",
"name": "Request a signature through your app (embedded signing) with a CFR Part 11 account",
"description": "Sends an envelope, then uses embedded signing with recipient authentication by phone for the first signer. With embedded signing, DocuSign signing is initiated from your website.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/CFREmbeddedSigningService.php",
"method": "worker",
"apiType": "ESignature"
},
{
"number": "55",
"name": "Embed a clickwrap",
"description": "Creates a unique URL for an active clickwrap and embeds the clickwrap on your page.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/Click/EmbedClickwrapService.php",
"method": "worker",
"apiType": "Click"
},
{
"number": "56",
"name": "Set document visibility for envelope recipients",
"description": "Demonstrates how to set document visibility for envelope recipients.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/SetDocumentsVisibilityService.php",
"method": "worker",
"apiType": "ESignature"
},
{
"number": "57",
"name": "Request a signature by email with document generation",
"description": "Creates an envelope from a template with a document that is dynamically generated to include all the customized data specified by the sender.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/DocumentGenerationService.php",
"method": "worker",
"apiType": "ESignature"
},
{
"number": "58",
"name": "Share access to a DocuSign envelope inbox",
"description": "Share envelope inbox access with an agent user and view the principal user's envelopes using the Shared Access view in the DocuSign UI",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/SharedAccessService.php",
"method": "shareAccess",
"apiType": "ESignature"
},
{
"number": "59",
"name": "Request a signature using focused view",
"description": "Sends an envelope, then uses focused view for the signer.",
"source": "https://raw.githubusercontent.com/docusign/code-examples-php/master/src/Services/Examples/eSignature/FocusedViewService.php",
"method": "worker",
"apiType": "ESignature"
}
],
"postAddOpenURI": "https://developers.docusign.com/platform/auth/authcode/"
}