UNPKG

boldsign

Version:

NodeJS client for boldsign

boldsign.com

boldsign/boldsign-node-sdk

486 lines (300 loc) • 27.9 kB
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
478
479
480
481
482
483
484
485
486
# TemplateApi All URIs are relative to https://api.boldsign.com. | Method | HTTP request | Description | | ------------- | ------------- | ------------- | | [**addTag()**](TemplateApi.md#addTag) | **PATCH** /v1/template/addTags | Add the Tags in Templates. | | [**createEmbeddedRequestUrlTemplate()**](TemplateApi.md#createEmbeddedRequestUrlTemplate) | **POST** /v1/template/createEmbeddedRequestUrl | Generates a send URL using a template which embeds document sending process into your application. | | [**createEmbeddedTemplateUrl()**](TemplateApi.md#createEmbeddedTemplateUrl) | **POST** /v1/template/createEmbeddedTemplateUrl | Generates a create URL to embeds template create process into your application. | | [**createTemplate()**](TemplateApi.md#createTemplate) | **POST** /v1/template/create | Creates a new template. | | [**deleteTemplate()**](TemplateApi.md#deleteTemplate) | **DELETE** /v1/template/delete | Deletes a template. | | [**deleteTag()**](TemplateApi.md#deleteTag) | **DELETE** /v1/template/deleteTags | Delete the Tags in Templates. | | [**download()**](TemplateApi.md#download) | **GET** /v1/template/download | Download the template. | | [**editTemplate()**](TemplateApi.md#editTemplate) | **PUT** /v1/template/edit | Edit and updates an existing template. | | [**getEmbeddedTemplateEditUrl()**](TemplateApi.md#getEmbeddedTemplateEditUrl) | **POST** /v1/template/getEmbeddedTemplateEditUrl | Generates a edit URL to embeds template edit process into your application. | | [**getProperties()**](TemplateApi.md#getProperties) | **GET** /v1/template/properties | Get summary of the template. | | [**listTemplates()**](TemplateApi.md#listTemplates) | **GET** /v1/template/list | List all the templates. | | [**mergeAndSend()**](TemplateApi.md#mergeAndSend) | **POST** /v1/template/mergeAndSend | Send the document by merging multiple templates. | | [**mergeCreateEmbeddedRequestUrlTemplate()**](TemplateApi.md#mergeCreateEmbeddedRequestUrlTemplate) | **POST** /v1/template/mergeCreateEmbeddedRequestUrl | Generates a merge request URL using a template that combines document merging and sending processes into your application. | | [**sendUsingTemplate()**](TemplateApi.md#sendUsingTemplate) | **POST** /v1/template/send | Send a document for signature using a Template. | ## `addTag()` ```typescript addTag(templateTag: TemplateTag) ``` Add the Tags in Templates. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| ContainsTemplateId and Label Names for AddingTags. | [optional] | ### Return type void (empty response body) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json` - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `createEmbeddedRequestUrlTemplate()` ```typescript createEmbeddedRequestUrlTemplate(templateId: string, embeddedSendTemplateFormRequest: EmbeddedSendTemplateFormRequest): EmbeddedSendCreated ``` Generates a send URL using a template which embeds document sending process into your application. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateId** | **string**| The template id. | | | **embeddedSendTemplateFormRequest** | [**EmbeddedSendTemplateFormRequest**](../docs/EmbeddedSendTemplateFormRequest.md)| Embedded send template json request. | [optional] | ### Return type [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded` - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `createEmbeddedTemplateUrl()` ```typescript createEmbeddedTemplateUrl(embeddedCreateTemplateRequest: EmbeddedCreateTemplateRequest): EmbeddedTemplateCreated ``` Generates a create URL to embeds template create process into your application. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **embeddedCreateTemplateRequest** | [**EmbeddedCreateTemplateRequest**](../docs/EmbeddedCreateTemplateRequest.md)| The create embedded template request body. | [optional] | ### Return type [**EmbeddedTemplateCreated**](../docs/EmbeddedTemplateCreated.md) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded` - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `createTemplate()` ```typescript createTemplate(createTemplateRequest: CreateTemplateRequest): TemplateCreated ``` Creates a new template. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **createTemplateRequest** | [**CreateTemplateRequest**](../docs/CreateTemplateRequest.md)| The create template request body. | [optional] | ### Return type [**TemplateCreated**](../docs/TemplateCreated.md) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded` - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `deleteTemplate()` ```typescript deleteTemplate(templateId: string, onBehalfOf: string) ``` Deletes a template. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateId** | **string**| The template id. | | | **onBehalfOf** | **string**| The on behalfof email address. | [optional] | ### Return type void (empty response body) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `deleteTag()` ```typescript deleteTag(templateTag: TemplateTag) ``` Delete the Tags in Templates. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| Contains TemplateId and LabelNames for Adding Tags. | [optional] | ### Return type void (empty response body) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json` - **Accept**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/octet-stream`, `text/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `download()` ```typescript download(templateId: string, onBehalfOf: string, includeFormFieldValues: boolean): Buffer ``` Download the template. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateId** | **string**| Template Id. | | | **onBehalfOf** | **string**| The on behalfof email address. | [optional] | | **includeFormFieldValues** | **boolean**| Include form field data. | [optional] [default to false] | ### Return type **Buffer** ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `editTemplate()` ```typescript editTemplate(templateId: string, editTemplateRequest: EditTemplateRequest) ``` Edit and updates an existing template. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateId** | **string**| The template id. | | | **editTemplateRequest** | [**EditTemplateRequest**](../docs/EditTemplateRequest.md)| The edit template request body. | | ### Return type void (empty response body) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json;odata.metadata=minimal;odata.streaming=true`, `application/json;odata.metadata=minimal;odata.streaming=false`, `application/json;odata.metadata=minimal`, `application/json;odata.metadata=full;odata.streaming=true`, `application/json;odata.metadata=full;odata.streaming=false`, `application/json;odata.metadata=full`, `application/json;odata.metadata=none;odata.streaming=true`, `application/json;odata.metadata=none;odata.streaming=false`, `application/json;odata.metadata=none`, `application/json;odata.streaming=true`, `application/json;odata.streaming=false`, `application/json`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=minimal;IEEE754Compatible=false`, `application/json;odata.metadata=minimal;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=full;IEEE754Compatible=false`, `application/json;odata.metadata=full;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true`, `application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=false`, `application/json;odata.metadata=none;IEEE754Compatible=true`, `application/json;odata.streaming=true;IEEE754Compatible=false`, `application/json;odata.streaming=true;IEEE754Compatible=true`, `application/json;odata.streaming=false;IEEE754Compatible=false`, `application/json;odata.streaming=false;IEEE754Compatible=true`, `application/json;IEEE754Compatible=false`, `application/json;IEEE754Compatible=true`, `application/xml`, `text/plain`, `application/json-patch+json`, `text/json`, `application/*+json` - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `getEmbeddedTemplateEditUrl()` ```typescript getEmbeddedTemplateEditUrl(templateId: string, embeddedTemplateEditRequest: EmbeddedTemplateEditRequest): EmbeddedTemplateEdited ``` Generates a edit URL to embeds template edit process into your application. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateId** | **string**| The template id. | | | **embeddedTemplateEditRequest** | [**EmbeddedTemplateEditRequest**](../docs/EmbeddedTemplateEditRequest.md)| The embedded edit template request body. | [optional] | ### Return type [**EmbeddedTemplateEdited**](../docs/EmbeddedTemplateEdited.md) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded` - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `getProperties()` ```typescript getProperties(templateId: string): TemplateProperties ``` Get summary of the template. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateId** | **string**| Template Id. | | ### Return type [**TemplateProperties**](../docs/TemplateProperties.md) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `listTemplates()` ```typescript listTemplates(page: number, templateType: 'mytemplates' | 'sharedtemplate' | 'all', pageSize: number, searchKey: string, onBehalfOf: Array<string>, createdBy: Array<string>, templateLabels: Array<string>, startDate: Date, endDate: Date, brandIds: Array<string>): TemplateRecords ``` List all the templates. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **page** | **number**| | [default to 1] | | **templateType** | **'mytemplates' | 'sharedtemplate' | 'all'**| | [optional] | | **pageSize** | **number**| | [optional] [default to 10] | | **searchKey** | **string**| | [optional] | | **onBehalfOf** | [**Array<string>**](../docs/string.md)| The sender identity\&#39;s email used to filter the templates returned in the API. The API will return templates that were sent on behalf of the specified email address. | [optional] | | **createdBy** | [**Array<string>**](../docs/string.md)| The templates can be listed by the creator of the template. | [optional] | | **templateLabels** | [**Array<string>**](../docs/string.md)| Labels of the template. | [optional] | | **startDate** | **Date**| Start date of the template | [optional] | | **endDate** | **Date**| End date of the template | [optional] | | **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the template. | [optional] | ### Return type [**TemplateRecords**](../docs/TemplateRecords.md) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `mergeAndSend()` ```typescript mergeAndSend(mergeAndSendForSignForm: MergeAndSendForSignForm): DocumentCreated ``` Send the document by merging multiple templates. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **mergeAndSendForSignForm** | [**MergeAndSendForSignForm**](../docs/MergeAndSendForSignForm.md)| The merge and send details as JSON. | [optional] | ### Return type [**DocumentCreated**](../docs/DocumentCreated.md) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded` - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `mergeCreateEmbeddedRequestUrlTemplate()` ```typescript mergeCreateEmbeddedRequestUrlTemplate(embeddedMergeTemplateFormRequest: EmbeddedMergeTemplateFormRequest): EmbeddedSendCreated ``` Generates a merge request URL using a template that combines document merging and sending processes into your application. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **embeddedMergeTemplateFormRequest** | [**EmbeddedMergeTemplateFormRequest**](../docs/EmbeddedMergeTemplateFormRequest.md)| Embedded merge and send template json request. | [optional] | ### Return type [**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded` - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md) ## `sendUsingTemplate()` ```typescript sendUsingTemplate(templateId: string, sendForSignFromTemplateForm: SendForSignFromTemplateForm): DocumentCreated ``` Send a document for signature using a Template. ### Parameters |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateId** | **string**| The template id. | | | **sendForSignFromTemplateForm** | [**SendForSignFromTemplateForm**](../docs/SendForSignFromTemplateForm.md)| The send template details as JSON. | [optional] | ### Return type [**DocumentCreated**](../docs/DocumentCreated.md) ### Authorization [X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer) ### HTTP request headers - **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded` - **Accept**: `application/json` [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)