boldsign 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/README.md +2 -0
- package/api/apis.ts +1 -1
- package/dist/api/apis.d.ts +1 -1
- package/dist/api/apis.js +1 -1
- package/dist/model/accessCodeDetail.d.ts +2 -0
- package/dist/model/accessCodeDetail.js +5 -0
- package/dist/model/accessCodeDetail.js.map +1 -1
- package/dist/model/authenticationSettings.d.ts +22 -0
- package/dist/model/authenticationSettings.js +27 -0
- package/dist/model/authenticationSettings.js.map +1 -0
- package/dist/model/documentSigner.d.ts +2 -0
- package/dist/model/documentSigner.js +5 -0
- package/dist/model/documentSigner.js.map +1 -1
- package/dist/model/documentSignerDetails.d.ts +2 -0
- package/dist/model/documentSignerDetails.js +5 -0
- package/dist/model/documentSignerDetails.js.map +1 -1
- package/dist/model/index.d.ts +3 -1
- package/dist/model/index.js +10 -3
- package/dist/model/index.js.map +1 -1
- package/dist/model/role.d.ts +2 -0
- package/dist/model/role.js +5 -0
- package/dist/model/role.js.map +1 -1
- package/dist/model/signerAuthenticationSettings.d.ts +15 -0
- package/dist/model/signerAuthenticationSettings.js +23 -0
- package/dist/model/signerAuthenticationSettings.js.map +1 -0
- package/dist/tests/config.d.ts +5 -0
- package/dist/tests/config.js +43 -0
- package/dist/tests/config.js.map +1 -0
- package/dist/tests/integration/BrandingApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/BrandingApiTest.spec.js +310 -0
- package/dist/tests/integration/BrandingApiTest.spec.js.map +1 -0
- package/dist/tests/integration/ContactsApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/ContactsApiTest.spec.js +249 -0
- package/dist/tests/integration/ContactsApiTest.spec.js.map +1 -0
- package/dist/tests/integration/CustomFieldApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/CustomFieldApiTest.spec.js +289 -0
- package/dist/tests/integration/CustomFieldApiTest.spec.js.map +1 -0
- package/dist/tests/integration/DocumentApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/DocumentApiTest.spec.js +1691 -0
- package/dist/tests/integration/DocumentApiTest.spec.js.map +1 -0
- package/dist/tests/integration/TemplateApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/TemplateApiTest.spec.js +1440 -0
- package/dist/tests/integration/TemplateApiTest.spec.js.map +1 -0
- package/dist/tests/integration/planApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/planApiTest.spec.js +41 -0
- package/dist/tests/integration/planApiTest.spec.js.map +1 -0
- package/dist/tests/integration/senderIdentity.spec.d.ts +1 -0
- package/dist/tests/integration/senderIdentity.spec.js +481 -0
- package/dist/tests/integration/senderIdentity.spec.js.map +1 -0
- package/dist/tests/integration/teamsApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/teamsApiTest.spec.js +230 -0
- package/dist/tests/integration/teamsApiTest.spec.js.map +1 -0
- package/dist/tests/integration/usersApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/usersApiTest.spec.js +290 -0
- package/dist/tests/integration/usersApiTest.spec.js.map +1 -0
- package/dist/tests/unit/brandingApi.spec.d.ts +1 -0
- package/dist/tests/unit/brandingApi.spec.js +174 -0
- package/dist/tests/unit/brandingApi.spec.js.map +1 -0
- package/dist/tests/unit/contactsApi.spec.d.ts +1 -0
- package/dist/tests/unit/contactsApi.spec.js +154 -0
- package/dist/tests/unit/contactsApi.spec.js.map +1 -0
- package/dist/tests/unit/customFieldApi.spec.d.ts +1 -0
- package/dist/tests/unit/customFieldApi.spec.js +140 -0
- package/dist/tests/unit/customFieldApi.spec.js.map +1 -0
- package/dist/tests/unit/documentApi.spec.d.ts +1 -0
- package/dist/tests/unit/documentApi.spec.js +476 -0
- package/dist/tests/unit/documentApi.spec.js.map +1 -0
- package/dist/tests/unit/planApi.spec.d.ts +1 -0
- package/dist/tests/unit/planApi.spec.js +69 -0
- package/dist/tests/unit/planApi.spec.js.map +1 -0
- package/dist/tests/unit/senderIdentitiesApi.spec.d.ts +1 -0
- package/dist/tests/unit/senderIdentitiesApi.spec.js +148 -0
- package/dist/tests/unit/senderIdentitiesApi.spec.js.map +1 -0
- package/dist/tests/unit/teamApi.spec.d.ts +1 -0
- package/dist/tests/unit/teamApi.spec.js +116 -0
- package/dist/tests/unit/teamApi.spec.js.map +1 -0
- package/dist/tests/unit/templateApi.spec.d.ts +1 -0
- package/dist/tests/unit/templateApi.spec.js +285 -0
- package/dist/tests/unit/templateApi.spec.js.map +1 -0
- package/dist/tests/unit/userApi.spec.d.ts +1 -0
- package/dist/tests/unit/userApi.spec.js +163 -0
- package/dist/tests/unit/userApi.spec.js.map +1 -0
- package/docs/AccessCodeDetail.md +19 -0
- package/docs/AccessCodeDetails.md +13 -0
- package/docs/Address.md +16 -0
- package/docs/AttachmentInfo.md +14 -0
- package/docs/AuditTrail.md +18 -0
- package/docs/AuthenticationSettings.md +11 -0
- package/docs/Base64File.md +12 -0
- package/docs/BehalfDocument.md +27 -0
- package/docs/BehalfDocumentRecords.md +12 -0
- package/docs/BehalfOf.md +12 -0
- package/docs/BillingViewModel.md +11 -0
- package/docs/BrandCreated.md +11 -0
- package/docs/BrandCustomFieldDetails.md +16 -0
- package/docs/BrandingApi.md +258 -0
- package/docs/BrandingMessage.md +11 -0
- package/docs/BrandingRecords.md +11 -0
- package/docs/ChangeRecipient.md +18 -0
- package/docs/ConditionalRule.md +13 -0
- package/docs/ContactCreated.md +12 -0
- package/docs/ContactDetails.md +15 -0
- package/docs/ContactPageDetails.md +13 -0
- package/docs/ContactsApi.md +176 -0
- package/docs/ContactsDetails.md +16 -0
- package/docs/ContactsList.md +12 -0
- package/docs/CreateContactResponse.md +11 -0
- package/docs/CreateSenderIdentityRequest.md +16 -0
- package/docs/CreateTeamRequest.md +11 -0
- package/docs/CreateTemplateRequest.md +35 -0
- package/docs/CreateUser.md +14 -0
- package/docs/CustomDomainSettings.md +12 -0
- package/docs/CustomFieldApi.md +174 -0
- package/docs/CustomFieldCollection.md +11 -0
- package/docs/CustomFieldMessage.md +12 -0
- package/docs/CustomFormField.md +43 -0
- package/docs/Date.md +13 -0
- package/docs/DeleteCustomFieldReply.md +11 -0
- package/docs/Document.md +26 -0
- package/docs/DocumentApi.md +756 -0
- package/docs/DocumentCC.md +11 -0
- package/docs/DocumentCcDetails.md +12 -0
- package/docs/DocumentCreated.md +11 -0
- package/docs/DocumentExpirySettings.md +16 -0
- package/docs/DocumentFiles.md +13 -0
- package/docs/DocumentFormFields.md +49 -0
- package/docs/DocumentInfo.md +14 -0
- package/docs/DocumentProperties.md +50 -0
- package/docs/DocumentReassign.md +13 -0
- package/docs/DocumentRecords.md +12 -0
- package/docs/DocumentSenderDetail.md +14 -0
- package/docs/DocumentSigner.md +31 -0
- package/docs/DocumentSignerDetails.md +37 -0
- package/docs/DocumentTags.md +12 -0
- package/docs/DownloadImageRequest.md +16 -0
- package/docs/EditSenderIdentityRequest.md +14 -0
- package/docs/EditTemplateRequest.md +29 -0
- package/docs/EditableDateFieldSettings.md +13 -0
- package/docs/EmbeddedCreateTemplateRequest.md +46 -0
- package/docs/EmbeddedCustomFieldCreated.md +11 -0
- package/docs/EmbeddedDocumentRequest.md +55 -0
- package/docs/EmbeddedFileDetails.md +16 -0
- package/docs/EmbeddedFileLink.md +11 -0
- package/docs/EmbeddedMergeTemplateFormRequest.md +56 -0
- package/docs/EmbeddedSendCreated.md +12 -0
- package/docs/EmbeddedSendTemplateFormRequest.md +53 -0
- package/docs/EmbeddedSigningLink.md +11 -0
- package/docs/EmbeddedTemplateCreated.md +12 -0
- package/docs/EmbeddedTemplateEditRequest.md +21 -0
- package/docs/EmbeddedTemplateEdited.md +11 -0
- package/docs/Error.md +12 -0
- package/docs/ErrorResult.md +11 -0
- package/docs/ExistingFormField.md +15 -0
- package/docs/ExtendExpiry.md +14 -0
- package/docs/FileInfo.md +14 -0
- package/docs/Font.md +18 -0
- package/docs/FormField.md +50 -0
- package/docs/FormGroup.md +15 -0
- package/docs/FormulaFieldSettings.md +12 -0
- package/docs/IdDocument.md +21 -0
- package/docs/IdReport.md +14 -0
- package/docs/IdVerification.md +18 -0
- package/docs/IdentityVerificationApi.md +109 -0
- package/docs/IdentityVerificationSettings.md +16 -0
- package/docs/ImageInfo.md +13 -0
- package/docs/MergeAndSendForSignForm.md +46 -0
- package/docs/NotificationSettings.md +22 -0
- package/docs/PageDetails.md +16 -0
- package/docs/PhoneNumber.md +12 -0
- package/docs/PlanApi.md +38 -0
- package/docs/PrefillField.md +12 -0
- package/docs/PrefillFieldRequest.md +12 -0
- package/docs/ProblemDetails.md +15 -0
- package/docs/RecipientNotificationSettings.md +22 -0
- package/docs/Rectangle.md +14 -0
- package/docs/ReminderMessage.md +13 -0
- package/docs/ReminderSettings.md +13 -0
- package/docs/RemoveAuthentication.md +14 -0
- package/docs/RevokeDocument.md +12 -0
- package/docs/Role.md +33 -0
- package/docs/Roles.md +33 -0
- package/docs/SendForSign.md +45 -0
- package/docs/SendForSignFromTemplateForm.md +43 -0
- package/docs/SenderIdentitiesApi.md +209 -0
- package/docs/SenderIdentityCreated.md +11 -0
- package/docs/SenderIdentityList.md +12 -0
- package/docs/SenderIdentityViewModel.md +19 -0
- package/docs/SignerAuthenticationSettings.md +12 -0
- package/docs/Size.md +12 -0
- package/docs/TeamCreated.md +11 -0
- package/docs/TeamDocumentRecords.md +12 -0
- package/docs/TeamListResponse.md +12 -0
- package/docs/TeamPageDetails.md +12 -0
- package/docs/TeamResponse.md +15 -0
- package/docs/TeamUpdateRequest.md +12 -0
- package/docs/TeamUsers.md +16 -0
- package/docs/Teams.md +14 -0
- package/docs/TeamsApi.md +141 -0
- package/docs/Template.md +29 -0
- package/docs/TemplateApi.md +484 -0
- package/docs/TemplateCC.md +12 -0
- package/docs/TemplateCreated.md +11 -0
- package/docs/TemplateFormFields.md +50 -0
- package/docs/TemplateProperties.md +37 -0
- package/docs/TemplateRecords.md +12 -0
- package/docs/TemplateRole.md +28 -0
- package/docs/TemplateSenderDetail.md +12 -0
- package/docs/TemplateSenderDetails.md +13 -0
- package/docs/TemplateSharedTemplateDetail.md +12 -0
- package/docs/TemplateSignerDetails.md +27 -0
- package/docs/TemplateTag.md +14 -0
- package/docs/TextTagDefinition.md +40 -0
- package/docs/TextTagOffset.md +12 -0
- package/docs/UpdateUser.md +14 -0
- package/docs/UpdateUserMetaData.md +12 -0
- package/docs/UserApi.md +240 -0
- package/docs/UserPageDetails.md +12 -0
- package/docs/UserProperties.md +21 -0
- package/docs/UserRecords.md +12 -0
- package/docs/UsersDetails.md +21 -0
- package/docs/Validation.md +13 -0
- package/docs/VerificationDataRequest.md +15 -0
- package/docs/ViewBrandDetails.md +34 -0
- package/docs/ViewCustomFieldDetails.md +17 -0
- package/model/accessCodeDetail.ts +7 -0
- package/model/authenticationSettings.ts +39 -0
- package/model/documentSigner.ts +7 -0
- package/model/documentSignerDetails.ts +7 -0
- package/model/index.ts +7 -0
- package/model/role.ts +7 -0
- package/model/signerAuthenticationSettings.ts +37 -0
- package/package.json +2 -1
|
@@ -0,0 +1,484 @@
|
|
|
1
|
+
# TemplateApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to https://api.boldsign.com.
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------------- | ------------- | ------------- |
|
|
7
|
+
| [**addTag()**](TemplateApi.md#addTag) | **PATCH** /v1/template/addTags | Add the Tags in Templates. |
|
|
8
|
+
| [**createEmbeddedRequestUrlTemplate()**](TemplateApi.md#createEmbeddedRequestUrlTemplate) | **POST** /v1/template/createEmbeddedRequestUrl | Generates a send URL using a template which embeds document sending process into your application. |
|
|
9
|
+
| [**createEmbeddedTemplateUrl()**](TemplateApi.md#createEmbeddedTemplateUrl) | **POST** /v1/template/createEmbeddedTemplateUrl | Generates a create URL to embeds template create process into your application. |
|
|
10
|
+
| [**createTemplate()**](TemplateApi.md#createTemplate) | **POST** /v1/template/create | Creates a new template. |
|
|
11
|
+
| [**deleteTemplate()**](TemplateApi.md#deleteTemplate) | **DELETE** /v1/template/delete | Deletes a template. |
|
|
12
|
+
| [**deleteTag()**](TemplateApi.md#deleteTag) | **DELETE** /v1/template/deleteTags | Delete the Tags in Templates. |
|
|
13
|
+
| [**download()**](TemplateApi.md#download) | **GET** /v1/template/download | Download the template. |
|
|
14
|
+
| [**editTemplate()**](TemplateApi.md#editTemplate) | **PUT** /v1/template/edit | Edit and updates an existing template. |
|
|
15
|
+
| [**getEmbeddedTemplateEditUrl()**](TemplateApi.md#getEmbeddedTemplateEditUrl) | **POST** /v1/template/getEmbeddedTemplateEditUrl | Generates a edit URL to embeds template edit process into your application. |
|
|
16
|
+
| [**getProperties()**](TemplateApi.md#getProperties) | **GET** /v1/template/properties | Get summary of the template. |
|
|
17
|
+
| [**listTemplates()**](TemplateApi.md#listTemplates) | **GET** /v1/template/list | List all the templates. |
|
|
18
|
+
| [**mergeAndSend()**](TemplateApi.md#mergeAndSend) | **POST** /v1/template/mergeAndSend | Send the document by merging multiple templates. |
|
|
19
|
+
| [**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. |
|
|
20
|
+
| [**sendUsingTemplate()**](TemplateApi.md#sendUsingTemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## `addTag()`
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
addTag(templateTag: TemplateTag)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Add the Tags in Templates.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Parameters
|
|
33
|
+
|
|
34
|
+
|Name | Type | Description | Notes |
|
|
35
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
36
|
+
| **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| ContainsTemplateId and Label Names for AddingTags. | [optional] |
|
|
37
|
+
|
|
38
|
+
### Return type
|
|
39
|
+
|
|
40
|
+
void (empty response body)
|
|
41
|
+
|
|
42
|
+
### Authorization
|
|
43
|
+
|
|
44
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
45
|
+
|
|
46
|
+
### HTTP request headers
|
|
47
|
+
|
|
48
|
+
- **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`
|
|
49
|
+
- **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`
|
|
50
|
+
|
|
51
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
52
|
+
[[Back to Model list]](../README.md#models)
|
|
53
|
+
[[Back to README]](../README.md)
|
|
54
|
+
|
|
55
|
+
## `createEmbeddedRequestUrlTemplate()`
|
|
56
|
+
|
|
57
|
+
```typescript
|
|
58
|
+
createEmbeddedRequestUrlTemplate(templateId: string, embeddedSendTemplateFormRequest: EmbeddedSendTemplateFormRequest): EmbeddedSendCreated
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Generates a send URL using a template which embeds document sending process into your application.
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
|Name | Type | Description | Notes |
|
|
67
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
68
|
+
| **templateId** | **string**| The template id. | |
|
|
69
|
+
| **embeddedSendTemplateFormRequest** | [**EmbeddedSendTemplateFormRequest**](../docs/EmbeddedSendTemplateFormRequest.md)| Embedded send template json request. | [optional] |
|
|
70
|
+
|
|
71
|
+
### Return type
|
|
72
|
+
|
|
73
|
+
[**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
|
|
74
|
+
|
|
75
|
+
### Authorization
|
|
76
|
+
|
|
77
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
78
|
+
|
|
79
|
+
### HTTP request headers
|
|
80
|
+
|
|
81
|
+
- **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
|
|
82
|
+
- **Accept**: `application/json`
|
|
83
|
+
|
|
84
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
85
|
+
[[Back to Model list]](../README.md#models)
|
|
86
|
+
[[Back to README]](../README.md)
|
|
87
|
+
|
|
88
|
+
## `createEmbeddedTemplateUrl()`
|
|
89
|
+
|
|
90
|
+
```typescript
|
|
91
|
+
createEmbeddedTemplateUrl(embeddedCreateTemplateRequest: EmbeddedCreateTemplateRequest): EmbeddedTemplateCreated
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Generates a create URL to embeds template create process into your application.
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|Name | Type | Description | Notes |
|
|
100
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
101
|
+
| **embeddedCreateTemplateRequest** | [**EmbeddedCreateTemplateRequest**](../docs/EmbeddedCreateTemplateRequest.md)| The create embedded template request body. | [optional] |
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
[**EmbeddedTemplateCreated**](../docs/EmbeddedTemplateCreated.md)
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
|
|
114
|
+
- **Accept**: `application/json`
|
|
115
|
+
|
|
116
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
117
|
+
[[Back to Model list]](../README.md#models)
|
|
118
|
+
[[Back to README]](../README.md)
|
|
119
|
+
|
|
120
|
+
## `createTemplate()`
|
|
121
|
+
|
|
122
|
+
```typescript
|
|
123
|
+
createTemplate(createTemplateRequest: CreateTemplateRequest): TemplateCreated
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Creates a new template.
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
### Parameters
|
|
130
|
+
|
|
131
|
+
|Name | Type | Description | Notes |
|
|
132
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
133
|
+
| **createTemplateRequest** | [**CreateTemplateRequest**](../docs/CreateTemplateRequest.md)| The create template request body. | [optional] |
|
|
134
|
+
|
|
135
|
+
### Return type
|
|
136
|
+
|
|
137
|
+
[**TemplateCreated**](../docs/TemplateCreated.md)
|
|
138
|
+
|
|
139
|
+
### Authorization
|
|
140
|
+
|
|
141
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
142
|
+
|
|
143
|
+
### HTTP request headers
|
|
144
|
+
|
|
145
|
+
- **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
|
|
146
|
+
- **Accept**: `application/json`
|
|
147
|
+
|
|
148
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
149
|
+
[[Back to Model list]](../README.md#models)
|
|
150
|
+
[[Back to README]](../README.md)
|
|
151
|
+
|
|
152
|
+
## `deleteTemplate()`
|
|
153
|
+
|
|
154
|
+
```typescript
|
|
155
|
+
deleteTemplate(templateId: string, onBehalfOf: string)
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
Deletes a template.
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### Parameters
|
|
162
|
+
|
|
163
|
+
|Name | Type | Description | Notes |
|
|
164
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
165
|
+
| **templateId** | **string**| The template id. | |
|
|
166
|
+
| **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
|
|
167
|
+
|
|
168
|
+
### Return type
|
|
169
|
+
|
|
170
|
+
void (empty response body)
|
|
171
|
+
|
|
172
|
+
### Authorization
|
|
173
|
+
|
|
174
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
175
|
+
|
|
176
|
+
### HTTP request headers
|
|
177
|
+
|
|
178
|
+
- **Content-Type**: Not defined
|
|
179
|
+
- **Accept**: `application/json`
|
|
180
|
+
|
|
181
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
182
|
+
[[Back to Model list]](../README.md#models)
|
|
183
|
+
[[Back to README]](../README.md)
|
|
184
|
+
|
|
185
|
+
## `deleteTag()`
|
|
186
|
+
|
|
187
|
+
```typescript
|
|
188
|
+
deleteTag(templateTag: TemplateTag)
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
Delete the Tags in Templates.
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
### Parameters
|
|
195
|
+
|
|
196
|
+
|Name | Type | Description | Notes |
|
|
197
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
198
|
+
| **templateTag** | [**TemplateTag**](../docs/TemplateTag.md)| Contains TemplateId and LabelNames for Adding Tags. | [optional] |
|
|
199
|
+
|
|
200
|
+
### Return type
|
|
201
|
+
|
|
202
|
+
void (empty response body)
|
|
203
|
+
|
|
204
|
+
### Authorization
|
|
205
|
+
|
|
206
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
207
|
+
|
|
208
|
+
### HTTP request headers
|
|
209
|
+
|
|
210
|
+
- **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`
|
|
211
|
+
- **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`
|
|
212
|
+
|
|
213
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
214
|
+
[[Back to Model list]](../README.md#models)
|
|
215
|
+
[[Back to README]](../README.md)
|
|
216
|
+
|
|
217
|
+
## `download()`
|
|
218
|
+
|
|
219
|
+
```typescript
|
|
220
|
+
download(templateId: string, onBehalfOf: string): Buffer
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
Download the template.
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
### Parameters
|
|
227
|
+
|
|
228
|
+
|Name | Type | Description | Notes |
|
|
229
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
230
|
+
| **templateId** | **string**| Template Id. | |
|
|
231
|
+
| **onBehalfOf** | **string**| The on behalfof email address. | [optional] |
|
|
232
|
+
|
|
233
|
+
### Return type
|
|
234
|
+
|
|
235
|
+
**Buffer**
|
|
236
|
+
|
|
237
|
+
### Authorization
|
|
238
|
+
|
|
239
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
240
|
+
|
|
241
|
+
### HTTP request headers
|
|
242
|
+
|
|
243
|
+
- **Content-Type**: Not defined
|
|
244
|
+
- **Accept**: `application/json`
|
|
245
|
+
|
|
246
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
247
|
+
[[Back to Model list]](../README.md#models)
|
|
248
|
+
[[Back to README]](../README.md)
|
|
249
|
+
|
|
250
|
+
## `editTemplate()`
|
|
251
|
+
|
|
252
|
+
```typescript
|
|
253
|
+
editTemplate(templateId: string, editTemplateRequest: EditTemplateRequest)
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
Edit and updates an existing template.
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
### Parameters
|
|
260
|
+
|
|
261
|
+
|Name | Type | Description | Notes |
|
|
262
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
263
|
+
| **templateId** | **string**| The template id. | |
|
|
264
|
+
| **editTemplateRequest** | [**EditTemplateRequest**](../docs/EditTemplateRequest.md)| The edit template request body. | |
|
|
265
|
+
|
|
266
|
+
### Return type
|
|
267
|
+
|
|
268
|
+
void (empty response body)
|
|
269
|
+
|
|
270
|
+
### Authorization
|
|
271
|
+
|
|
272
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
273
|
+
|
|
274
|
+
### HTTP request headers
|
|
275
|
+
|
|
276
|
+
- **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`
|
|
277
|
+
- **Accept**: `application/json`
|
|
278
|
+
|
|
279
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
280
|
+
[[Back to Model list]](../README.md#models)
|
|
281
|
+
[[Back to README]](../README.md)
|
|
282
|
+
|
|
283
|
+
## `getEmbeddedTemplateEditUrl()`
|
|
284
|
+
|
|
285
|
+
```typescript
|
|
286
|
+
getEmbeddedTemplateEditUrl(templateId: string, embeddedTemplateEditRequest: EmbeddedTemplateEditRequest): EmbeddedTemplateEdited
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
Generates a edit URL to embeds template edit process into your application.
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
### Parameters
|
|
293
|
+
|
|
294
|
+
|Name | Type | Description | Notes |
|
|
295
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
296
|
+
| **templateId** | **string**| The template id. | |
|
|
297
|
+
| **embeddedTemplateEditRequest** | [**EmbeddedTemplateEditRequest**](../docs/EmbeddedTemplateEditRequest.md)| The embedded edit template request body. | [optional] |
|
|
298
|
+
|
|
299
|
+
### Return type
|
|
300
|
+
|
|
301
|
+
[**EmbeddedTemplateEdited**](../docs/EmbeddedTemplateEdited.md)
|
|
302
|
+
|
|
303
|
+
### Authorization
|
|
304
|
+
|
|
305
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
306
|
+
|
|
307
|
+
### HTTP request headers
|
|
308
|
+
|
|
309
|
+
- **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
|
|
310
|
+
- **Accept**: `application/json`
|
|
311
|
+
|
|
312
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
313
|
+
[[Back to Model list]](../README.md#models)
|
|
314
|
+
[[Back to README]](../README.md)
|
|
315
|
+
|
|
316
|
+
## `getProperties()`
|
|
317
|
+
|
|
318
|
+
```typescript
|
|
319
|
+
getProperties(templateId: string): TemplateProperties
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
Get summary of the template.
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
### Parameters
|
|
326
|
+
|
|
327
|
+
|Name | Type | Description | Notes |
|
|
328
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
329
|
+
| **templateId** | **string**| Template Id. | |
|
|
330
|
+
|
|
331
|
+
### Return type
|
|
332
|
+
|
|
333
|
+
[**TemplateProperties**](../docs/TemplateProperties.md)
|
|
334
|
+
|
|
335
|
+
### Authorization
|
|
336
|
+
|
|
337
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
338
|
+
|
|
339
|
+
### HTTP request headers
|
|
340
|
+
|
|
341
|
+
- **Content-Type**: Not defined
|
|
342
|
+
- **Accept**: `application/json`
|
|
343
|
+
|
|
344
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
345
|
+
[[Back to Model list]](../README.md#models)
|
|
346
|
+
[[Back to README]](../README.md)
|
|
347
|
+
|
|
348
|
+
## `listTemplates()`
|
|
349
|
+
|
|
350
|
+
```typescript
|
|
351
|
+
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
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
List all the templates.
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
### Parameters
|
|
358
|
+
|
|
359
|
+
|Name | Type | Description | Notes |
|
|
360
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
361
|
+
| **page** | **number**| | [default to 1] |
|
|
362
|
+
| **templateType** | **'mytemplates' | 'sharedtemplate' | 'all'**| | [optional] |
|
|
363
|
+
| **pageSize** | **number**| | [optional] [default to 10] |
|
|
364
|
+
| **searchKey** | **string**| | [optional] |
|
|
365
|
+
| **onBehalfOf** | [**Array<string>**](../docs/string.md)| The sender identity\'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] |
|
|
366
|
+
| **createdBy** | [**Array<string>**](../docs/string.md)| The templates can be listed by the creator of the template. | [optional] |
|
|
367
|
+
| **templateLabels** | [**Array<string>**](../docs/string.md)| Labels of the template. | [optional] |
|
|
368
|
+
| **startDate** | **Date**| Start date of the template | [optional] |
|
|
369
|
+
| **endDate** | **Date**| End date of the template | [optional] |
|
|
370
|
+
| **brandIds** | [**Array<string>**](../docs/string.md)| BrandId(s) of the template. | [optional] |
|
|
371
|
+
|
|
372
|
+
### Return type
|
|
373
|
+
|
|
374
|
+
[**TemplateRecords**](../docs/TemplateRecords.md)
|
|
375
|
+
|
|
376
|
+
### Authorization
|
|
377
|
+
|
|
378
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
379
|
+
|
|
380
|
+
### HTTP request headers
|
|
381
|
+
|
|
382
|
+
- **Content-Type**: Not defined
|
|
383
|
+
- **Accept**: `application/json`
|
|
384
|
+
|
|
385
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
386
|
+
[[Back to Model list]](../README.md#models)
|
|
387
|
+
[[Back to README]](../README.md)
|
|
388
|
+
|
|
389
|
+
## `mergeAndSend()`
|
|
390
|
+
|
|
391
|
+
```typescript
|
|
392
|
+
mergeAndSend(mergeAndSendForSignForm: MergeAndSendForSignForm): DocumentCreated
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
Send the document by merging multiple templates.
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
### Parameters
|
|
399
|
+
|
|
400
|
+
|Name | Type | Description | Notes |
|
|
401
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
402
|
+
| **mergeAndSendForSignForm** | [**MergeAndSendForSignForm**](../docs/MergeAndSendForSignForm.md)| The merge and send details as JSON. | [optional] |
|
|
403
|
+
|
|
404
|
+
### Return type
|
|
405
|
+
|
|
406
|
+
[**DocumentCreated**](../docs/DocumentCreated.md)
|
|
407
|
+
|
|
408
|
+
### Authorization
|
|
409
|
+
|
|
410
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
411
|
+
|
|
412
|
+
### HTTP request headers
|
|
413
|
+
|
|
414
|
+
- **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
|
|
415
|
+
- **Accept**: `application/json`
|
|
416
|
+
|
|
417
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
418
|
+
[[Back to Model list]](../README.md#models)
|
|
419
|
+
[[Back to README]](../README.md)
|
|
420
|
+
|
|
421
|
+
## `mergeCreateEmbeddedRequestUrlTemplate()`
|
|
422
|
+
|
|
423
|
+
```typescript
|
|
424
|
+
mergeCreateEmbeddedRequestUrlTemplate(embeddedMergeTemplateFormRequest: EmbeddedMergeTemplateFormRequest): EmbeddedSendCreated
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
Generates a merge request URL using a template that combines document merging and sending processes into your application.
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
### Parameters
|
|
431
|
+
|
|
432
|
+
|Name | Type | Description | Notes |
|
|
433
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
434
|
+
| **embeddedMergeTemplateFormRequest** | [**EmbeddedMergeTemplateFormRequest**](../docs/EmbeddedMergeTemplateFormRequest.md)| Embedded merge and send template json request. | [optional] |
|
|
435
|
+
|
|
436
|
+
### Return type
|
|
437
|
+
|
|
438
|
+
[**EmbeddedSendCreated**](../docs/EmbeddedSendCreated.md)
|
|
439
|
+
|
|
440
|
+
### Authorization
|
|
441
|
+
|
|
442
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
443
|
+
|
|
444
|
+
### HTTP request headers
|
|
445
|
+
|
|
446
|
+
- **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
|
|
447
|
+
- **Accept**: `application/json`
|
|
448
|
+
|
|
449
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
450
|
+
[[Back to Model list]](../README.md#models)
|
|
451
|
+
[[Back to README]](../README.md)
|
|
452
|
+
|
|
453
|
+
## `sendUsingTemplate()`
|
|
454
|
+
|
|
455
|
+
```typescript
|
|
456
|
+
sendUsingTemplate(templateId: string, sendForSignFromTemplateForm: SendForSignFromTemplateForm): DocumentCreated
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
Send a document for signature using a Template.
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
### Parameters
|
|
463
|
+
|
|
464
|
+
|Name | Type | Description | Notes |
|
|
465
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
466
|
+
| **templateId** | **string**| The template id. | |
|
|
467
|
+
| **sendForSignFromTemplateForm** | [**SendForSignFromTemplateForm**](../docs/SendForSignFromTemplateForm.md)| The send template details as JSON. | [optional] |
|
|
468
|
+
|
|
469
|
+
### Return type
|
|
470
|
+
|
|
471
|
+
[**DocumentCreated**](../docs/DocumentCreated.md)
|
|
472
|
+
|
|
473
|
+
### Authorization
|
|
474
|
+
|
|
475
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
476
|
+
|
|
477
|
+
### HTTP request headers
|
|
478
|
+
|
|
479
|
+
- **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
|
|
480
|
+
- **Accept**: `application/json`
|
|
481
|
+
|
|
482
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
483
|
+
[[Back to Model list]](../README.md#models)
|
|
484
|
+
[[Back to README]](../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# # TemplateCC
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `emailAddress` | ```string``` | | |
|
|
10
|
+
| `userId` | ```string``` | | |
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# # TemplateCreated
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `templateId` | ```string``` | | |
|
|
10
|
+
|
|
11
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# # TemplateFormFields
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `id` | ```string``` | | |
|
|
10
|
+
| `fieldType` | ```string``` | | |
|
|
11
|
+
| `type` | ```string``` | | |
|
|
12
|
+
| `value` | ```string``` | | |
|
|
13
|
+
| `font` | ```string``` | | |
|
|
14
|
+
| `isRequired` | ```boolean``` | | |
|
|
15
|
+
| `isReadOnly` | ```boolean``` | | |
|
|
16
|
+
| `lineHeight` | ```number``` | | |
|
|
17
|
+
| `fontSize` | ```number``` | | |
|
|
18
|
+
| `fontHexColor` | ```string``` | | |
|
|
19
|
+
| `isUnderLineFont` | ```boolean``` | | |
|
|
20
|
+
| `isItalicFont` | ```boolean``` | | |
|
|
21
|
+
| `isBoldFont` | ```boolean``` | | |
|
|
22
|
+
| `groupName` | ```string``` | | |
|
|
23
|
+
| `label` | ```string``` | | |
|
|
24
|
+
| `placeholder` | ```string``` | | |
|
|
25
|
+
| `validationtype` | ```string``` | | |
|
|
26
|
+
| `validationCustomRegex` | ```string``` | | |
|
|
27
|
+
| `validationCustomRegexMessage` | ```string``` | | |
|
|
28
|
+
| `dateFormat` | ```string``` | | |
|
|
29
|
+
| `timeFormat` | ```string``` | | |
|
|
30
|
+
| `imageInfo` | [```ImageInfo```](ImageInfo.md) | | |
|
|
31
|
+
| `attachmentInfo` | [```AttachmentInfo```](AttachmentInfo.md) | | |
|
|
32
|
+
| `editableDateFieldSettings` | [```EditableDateFieldSettings```](EditableDateFieldSettings.md) | | |
|
|
33
|
+
| `dropdownOptions` | ```Array<string>``` | | |
|
|
34
|
+
| `bounds` | [```Rectangle```](Rectangle.md) | | |
|
|
35
|
+
| `pageNumber` | ```number``` | | |
|
|
36
|
+
| `conditionalRules` | [```Array<ConditionalRule>```](ConditionalRule.md) | | |
|
|
37
|
+
| `dataSyncTag` | ```string``` | | |
|
|
38
|
+
| `textAlign` | ```string``` | | |
|
|
39
|
+
| `textDirection` | ```string``` | | |
|
|
40
|
+
| `characterSpacing` | ```number``` | | |
|
|
41
|
+
| `characterLimit` | ```number``` | | |
|
|
42
|
+
| `hyperlinkText` | ```string``` | | |
|
|
43
|
+
| `backgroundHexColor` | ```string``` | | |
|
|
44
|
+
| `tabIndex` | ```number``` | | |
|
|
45
|
+
| `formulaFieldSettings` | [```FormulaFieldSettings```](FormulaFieldSettings.md) | | |
|
|
46
|
+
| `resizeOption` | ```string``` | | |
|
|
47
|
+
| `allowEditFormField` | ```boolean``` | | |
|
|
48
|
+
| `allowDeleteFormField` | ```boolean``` | | |
|
|
49
|
+
|
|
50
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# # TemplateProperties
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `templateId` | ```string``` | | |
|
|
10
|
+
| `title` | ```string``` | | |
|
|
11
|
+
| `description` | ```string``` | | |
|
|
12
|
+
| `documentTitle` | ```string``` | | |
|
|
13
|
+
| `documentMessage` | ```string``` | | |
|
|
14
|
+
| `files` | [```Array<DocumentFiles>```](DocumentFiles.md) | | |
|
|
15
|
+
| `roles` | [```Array<Roles>```](Roles.md) | | |
|
|
16
|
+
| `formGroups` | [```Array<FormGroup>```](FormGroup.md) | | |
|
|
17
|
+
| `commonFields` | [```Array<TemplateFormFields>```](TemplateFormFields.md) | | |
|
|
18
|
+
| `cCDetails` | ```Array<string>``` | | |
|
|
19
|
+
| `brandId` | ```string``` | | |
|
|
20
|
+
| `allowMessageEditing` | ```boolean``` | | |
|
|
21
|
+
| `allowNewRoles` | ```boolean``` | | |
|
|
22
|
+
| `allowNewFiles` | ```boolean``` | | |
|
|
23
|
+
| `allowModifyFiles` | ```boolean``` | | |
|
|
24
|
+
| `enableReassign` | ```boolean``` | | |
|
|
25
|
+
| `enablePrintAndSign` | ```boolean``` | | |
|
|
26
|
+
| `enableSigningOrder` | ```boolean``` | | |
|
|
27
|
+
| `createdDate` | ```number``` | | |
|
|
28
|
+
| `createdBy` | [```TemplateSenderDetail```](TemplateSenderDetail.md) | | |
|
|
29
|
+
| `sharedTemplateDetail` | [```Array<TemplateSharedTemplateDetail>```](TemplateSharedTemplateDetail.md) | | |
|
|
30
|
+
| `documentInfo` | [```Array<DocumentInfo>```](DocumentInfo.md) | | |
|
|
31
|
+
| `labels` | ```Array<string>``` | | |
|
|
32
|
+
| `templateLabels` | ```Array<string>``` | | |
|
|
33
|
+
| `behalfOf` | [```BehalfOf```](BehalfOf.md) | | |
|
|
34
|
+
| `documentDownloadOption` | ```string``` | | |
|
|
35
|
+
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# # TemplateRecords
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `pageDetails` | [```PageDetails```](PageDetails.md) | | |
|
|
10
|
+
| `result` | [```Array<Template>```](Template.md) | | |
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# # TemplateRole
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `index`<sup>*_required_</sup> | ```number``` | | |
|
|
10
|
+
| `name` | ```string``` | | |
|
|
11
|
+
| `defaultSignerName` | ```string``` | | |
|
|
12
|
+
| `defaultSignerEmail` | ```string``` | | |
|
|
13
|
+
| `signerOrder` | ```number``` | | |
|
|
14
|
+
| `signerType` | ```string``` | | |
|
|
15
|
+
| `hostEmail` | ```string``` | | |
|
|
16
|
+
| `language` | ```number``` | <p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul> | |
|
|
17
|
+
| `locale` | ```string``` | | |
|
|
18
|
+
| `imposeAuthentication` | ```string``` | | |
|
|
19
|
+
| `phoneNumber` | [```PhoneNumber```](PhoneNumber.md) | | |
|
|
20
|
+
| `deliveryMode` | ```string``` | | |
|
|
21
|
+
| `allowFieldConfiguration` | ```boolean``` | | |
|
|
22
|
+
| `formFields` | [```Array<FormField>```](FormField.md) | | |
|
|
23
|
+
| `allowRoleEdit` | ```boolean``` | | |
|
|
24
|
+
| `allowRoleDelete` | ```boolean``` | | |
|
|
25
|
+
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
26
|
+
| `enableQes` | ```boolean``` | | |
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# # TemplateSenderDetail
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `emailAddress` | ```string``` | | |
|
|
10
|
+
| `name` | ```string``` | | |
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|