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,11 @@
|
|
|
1
|
+
# # DocumentCC
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `emailAddress`<sup>*_required_</sup> | ```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,12 @@
|
|
|
1
|
+
# # DocumentCcDetails
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `emailAddress` | ```string``` | | |
|
|
10
|
+
| `isViewed` | ```boolean``` | | [default to false] |
|
|
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
|
+
# # DocumentCreated
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `documentId` | ```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,16 @@
|
|
|
1
|
+
# # DocumentExpirySettings
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `expiryDateType` | ```string``` | | |
|
|
10
|
+
| `expiryValue` | ```number``` | | |
|
|
11
|
+
| `enableDefaultExpiryAlert` | ```boolean``` | | |
|
|
12
|
+
| `enableAutoReminder` | ```boolean``` | | |
|
|
13
|
+
| `reminderDays` | ```number``` | | |
|
|
14
|
+
| `reminderCount` | ```number``` | | |
|
|
15
|
+
|
|
16
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# # DocumentFiles
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `documentName` | ```string``` | | |
|
|
10
|
+
| `order` | ```number``` | | |
|
|
11
|
+
| `pageCount` | ```number``` | | |
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# # DocumentFormFields
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `id` | ```string``` | | |
|
|
10
|
+
| `type` | ```string``` | | |
|
|
11
|
+
| `value` | ```string``` | | |
|
|
12
|
+
| `font` | ```string``` | | |
|
|
13
|
+
| `isRequired` | ```boolean``` | | |
|
|
14
|
+
| `isReadOnly` | ```boolean``` | | |
|
|
15
|
+
| `lineHeight` | ```number``` | | |
|
|
16
|
+
| `fontSize` | ```number``` | | |
|
|
17
|
+
| `fontColor` | ```string``` | | |
|
|
18
|
+
| `isUnderline` | ```boolean``` | | |
|
|
19
|
+
| `isItalic` | ```boolean``` | | |
|
|
20
|
+
| `isBold` | ```boolean``` | | |
|
|
21
|
+
| `groupName` | ```string``` | | |
|
|
22
|
+
| `label` | ```string``` | | |
|
|
23
|
+
| `placeholder` | ```string``` | | |
|
|
24
|
+
| `validationtype` | ```string``` | | |
|
|
25
|
+
| `validationCustomRegex` | ```string``` | | |
|
|
26
|
+
| `validationCustomRegexMessage` | ```string``` | | |
|
|
27
|
+
| `dateFormat` | ```string``` | | |
|
|
28
|
+
| `timeFormat` | ```string``` | | |
|
|
29
|
+
| `imageInfo` | [```ImageInfo```](ImageInfo.md) | | |
|
|
30
|
+
| `attachmentInfo` | [```AttachmentInfo```](AttachmentInfo.md) | | |
|
|
31
|
+
| `fileInfo` | [```FileInfo```](FileInfo.md) | | |
|
|
32
|
+
| `editableDateFieldSettings` | [```EditableDateFieldSettings```](EditableDateFieldSettings.md) | | |
|
|
33
|
+
| `hyperlinkText` | ```string``` | | |
|
|
34
|
+
| `conditionalRules` | [```Array<ConditionalRule>```](ConditionalRule.md) | | |
|
|
35
|
+
| `bounds` | [```Rectangle```](Rectangle.md) | | |
|
|
36
|
+
| `pageNumber` | ```number``` | | |
|
|
37
|
+
| `dataSyncTag` | ```string``` | | |
|
|
38
|
+
| `dropdownOptions` | ```Array<string>``` | | |
|
|
39
|
+
| `textAlign` | ```string``` | | |
|
|
40
|
+
| `textDirection` | ```string``` | | |
|
|
41
|
+
| `characterSpacing` | ```number``` | | |
|
|
42
|
+
| `backgroundHexColor` | ```string``` | | |
|
|
43
|
+
| `tabIndex` | ```number``` | | |
|
|
44
|
+
| `formulaFieldSettings` | [```FormulaFieldSettings```](FormulaFieldSettings.md) | | |
|
|
45
|
+
| `resizeOption` | ```string``` | | |
|
|
46
|
+
| `allowEditFormField` | ```boolean``` | | |
|
|
47
|
+
| `allowDeleteFormField` | ```boolean``` | | |
|
|
48
|
+
|
|
49
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# # DocumentInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `locale`<sup>*_required_</sup> | ```string``` | | |
|
|
10
|
+
| `title`<sup>*_required_</sup> | ```string``` | | |
|
|
11
|
+
| `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> | |
|
|
12
|
+
| `description` | ```string``` | | |
|
|
13
|
+
|
|
14
|
+
[[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
|
+
# # DocumentProperties
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `documentId` | ```string``` | | |
|
|
10
|
+
| `brandId` | ```string``` | | |
|
|
11
|
+
| `messageTitle` | ```string``` | | |
|
|
12
|
+
| `documentDescription` | ```string``` | | |
|
|
13
|
+
| `status` | ```string``` | | |
|
|
14
|
+
| `files` | [```Array<DocumentFiles>```](DocumentFiles.md) | | |
|
|
15
|
+
| `senderDetail` | [```DocumentSenderDetail```](DocumentSenderDetail.md) | | |
|
|
16
|
+
| `signerDetails` | [```Array<DocumentSignerDetails>```](DocumentSignerDetails.md) | | |
|
|
17
|
+
| `formGroups` | [```Array<FormGroup>```](FormGroup.md) | | |
|
|
18
|
+
| `commonFields` | [```Array<DocumentFormFields>```](DocumentFormFields.md) | | |
|
|
19
|
+
| `behalfOf` | [```BehalfOf```](BehalfOf.md) | | |
|
|
20
|
+
| `ccDetails` | [```Array<DocumentCcDetails>```](DocumentCcDetails.md) | | |
|
|
21
|
+
| `reminderSettings` | [```ReminderSettings```](ReminderSettings.md) | | |
|
|
22
|
+
| `reassign` | [```Array<DocumentReassign>```](DocumentReassign.md) | | |
|
|
23
|
+
| `documentHistory` | [```Array<AuditTrail>```](AuditTrail.md) | | |
|
|
24
|
+
| `activityBy` | ```string``` | | |
|
|
25
|
+
| `activityDate` | ```number``` | | |
|
|
26
|
+
| `activityAction` | ```string``` | | |
|
|
27
|
+
| `createdDate` | ```number``` | | |
|
|
28
|
+
| `expiryDays` | ```number``` | | |
|
|
29
|
+
| `expiryDate` | ```number``` | | |
|
|
30
|
+
| `enableSigningOrder` | ```boolean``` | | |
|
|
31
|
+
| `isDeleted` | ```boolean``` | | |
|
|
32
|
+
| `revokeMessage` | ```string``` | | |
|
|
33
|
+
| `declineMessage` | ```string``` | | |
|
|
34
|
+
| `applicationId` | ```string``` | | |
|
|
35
|
+
| `labels` | ```Array<string>``` | | |
|
|
36
|
+
| `disableEmails` | ```boolean``` | | |
|
|
37
|
+
| `enablePrintAndSign` | ```boolean``` | | |
|
|
38
|
+
| `enableReassign` | ```boolean``` | | |
|
|
39
|
+
| `disableExpiryAlert` | ```boolean``` | | |
|
|
40
|
+
| `hideDocumentId` | ```boolean``` | | |
|
|
41
|
+
| `expiryDateType` | ```string``` | | |
|
|
42
|
+
| `expiryValue` | ```number``` | | |
|
|
43
|
+
| `documentDownloadOption` | ```string``` | | |
|
|
44
|
+
| `metaData` | ```{ [key: string]: string | null; }``` | | |
|
|
45
|
+
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
46
|
+
| `enableAuditTrailLocalization` | ```boolean``` | | |
|
|
47
|
+
| `downloadFileName` | ```string``` | | |
|
|
48
|
+
| `scheduledSendTime` | ```number``` | | |
|
|
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,13 @@
|
|
|
1
|
+
# # DocumentReassign
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `signerEmail` | ```string``` | | |
|
|
10
|
+
| `order` | ```number``` | | [default to 0] |
|
|
11
|
+
| `message` | ```string``` | | |
|
|
12
|
+
|
|
13
|
+
[[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
|
+
# # DocumentRecords
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `pageDetails` | [```PageDetails```](PageDetails.md) | | |
|
|
10
|
+
| `result` | [```Array<Document>```](Document.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,14 @@
|
|
|
1
|
+
# # DocumentSenderDetail
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `name` | ```string``` | | |
|
|
10
|
+
| `privateMessage` | ```string``` | | |
|
|
11
|
+
| `emailAddress` | ```string``` | | |
|
|
12
|
+
| `isViewed` | ```boolean``` | | [default to false] |
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# # DocumentSigner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `name`<sup>*_required_</sup> | ```string``` | | |
|
|
10
|
+
| `emailAddress` | ```string``` | | |
|
|
11
|
+
| `privateMessage` | ```string``` | | |
|
|
12
|
+
| `authenticationType` | ```string``` | | |
|
|
13
|
+
| `phoneNumber` | [```PhoneNumber```](PhoneNumber.md) | | |
|
|
14
|
+
| `deliveryMode` | ```string``` | | |
|
|
15
|
+
| `authenticationCode` | ```string``` | | |
|
|
16
|
+
| `identityVerificationSettings` | [```IdentityVerificationSettings```](IdentityVerificationSettings.md) | | |
|
|
17
|
+
| `signerOrder` | ```number``` | | |
|
|
18
|
+
| `enableEmailOTP` | ```boolean``` | | |
|
|
19
|
+
| `signerType` | ```string``` | | |
|
|
20
|
+
| `hostEmail` | ```string``` | | |
|
|
21
|
+
| `signerRole` | ```string``` | | |
|
|
22
|
+
| `allowFieldConfiguration` | ```boolean``` | | |
|
|
23
|
+
| `formFields` | [```Array<FormField>```](FormField.md) | | |
|
|
24
|
+
| `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> | |
|
|
25
|
+
| `locale` | ```string``` | | |
|
|
26
|
+
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
27
|
+
| `authenticationRetryCount` | ```number``` | | |
|
|
28
|
+
| `enableQes` | ```boolean``` | | |
|
|
29
|
+
| `authenticationSettings` | [```AuthenticationSettings```](AuthenticationSettings.md) | | |
|
|
30
|
+
|
|
31
|
+
[[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
|
+
# # DocumentSignerDetails
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `signerName` | ```string``` | | |
|
|
10
|
+
| `signerRole` | ```string``` | | |
|
|
11
|
+
| `signerEmail` | ```string``` | | |
|
|
12
|
+
| `status` | ```string``` | | |
|
|
13
|
+
| `enableAccessCode` | ```boolean``` | | |
|
|
14
|
+
| `isAuthenticationFailed` | ```boolean``` | | [default to false] |
|
|
15
|
+
| `enableEmailOTP` | ```boolean``` | | |
|
|
16
|
+
| `authenticationType` | ```string``` | | |
|
|
17
|
+
| `isDeliveryFailed` | ```boolean``` | | [default to false] |
|
|
18
|
+
| `isViewed` | ```boolean``` | | [default to false] |
|
|
19
|
+
| `order` | ```number``` | | [default to 0] |
|
|
20
|
+
| `signerType` | ```string``` | | [default to SignerTypeEnum.Signer] |
|
|
21
|
+
| `hostEmail` | ```string``` | | |
|
|
22
|
+
| `hostName` | ```string``` | | |
|
|
23
|
+
| `isReassigned` | ```boolean``` | | |
|
|
24
|
+
| `privateMessage` | ```string``` | | |
|
|
25
|
+
| `allowFieldConfiguration` | ```boolean``` | | |
|
|
26
|
+
| `formFields` | [```Array<DocumentFormFields>```](DocumentFormFields.md) | | |
|
|
27
|
+
| `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> | |
|
|
28
|
+
| `locale` | ```string``` | | |
|
|
29
|
+
| `phoneNumber` | [```PhoneNumber```](PhoneNumber.md) | | |
|
|
30
|
+
| `idVerification` | [```IdVerification```](IdVerification.md) | | |
|
|
31
|
+
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
32
|
+
| `authenticationRetryCount` | ```number``` | | |
|
|
33
|
+
| `enableQes` | ```boolean``` | | |
|
|
34
|
+
| `deliveryMode` | ```string``` | | |
|
|
35
|
+
| `authenticationSettings` | [```SignerAuthenticationSettings```](SignerAuthenticationSettings.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
|
+
# # DocumentTags
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `documentId`<sup>*_required_</sup> | ```string``` | | |
|
|
10
|
+
| `tags`<sup>*_required_</sup> | ```Array<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,16 @@
|
|
|
1
|
+
# # DownloadImageRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `emailId` | ```string``` | | |
|
|
10
|
+
| `countryCode` | ```string``` | | |
|
|
11
|
+
| `phoneNumber` | ```string``` | | |
|
|
12
|
+
| `order` | ```number``` | | |
|
|
13
|
+
| `fileId` | ```string``` | | |
|
|
14
|
+
| `onBehalfOf` | ```string``` | | |
|
|
15
|
+
|
|
16
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# # EditSenderIdentityRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `name` | ```string``` | | |
|
|
10
|
+
| `notificationSettings` | [```NotificationSettings```](NotificationSettings.md) | | |
|
|
11
|
+
| `redirectUrl` | ```string``` | | |
|
|
12
|
+
| `metaData` | ```{ [key: string]: string | null; }``` | | |
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# # EditTemplateRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `title` | ```string``` | | |
|
|
10
|
+
| `description` | ```string``` | | |
|
|
11
|
+
| `documentTitle` | ```string``` | | |
|
|
12
|
+
| `documentMessage` | ```string``` | | |
|
|
13
|
+
| `roles` | [```Array<TemplateRole>```](TemplateRole.md) | | |
|
|
14
|
+
| `cc` | [```Array<DocumentCC>```](DocumentCC.md) | | |
|
|
15
|
+
| `brandId` | ```string``` | | |
|
|
16
|
+
| `allowMessageEditing` | ```boolean``` | | |
|
|
17
|
+
| `allowNewRoles` | ```boolean``` | | |
|
|
18
|
+
| `allowNewFiles` | ```boolean``` | | |
|
|
19
|
+
| `enableReassign` | ```boolean``` | | |
|
|
20
|
+
| `enablePrintAndSign` | ```boolean``` | | |
|
|
21
|
+
| `enableSigningOrder` | ```boolean``` | | |
|
|
22
|
+
| `documentInfo` | [```Array<DocumentInfo>```](DocumentInfo.md) | | |
|
|
23
|
+
| `onBehalfOf` | ```string``` | | |
|
|
24
|
+
| `labels` | ```Array<string>``` | | |
|
|
25
|
+
| `templateLabels` | ```Array<string>``` | | |
|
|
26
|
+
| `formGroups` | [```Array<FormGroup>```](FormGroup.md) | | |
|
|
27
|
+
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# # EditableDateFieldSettings
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `dateFormat`<sup>*_required_</sup> | ```string``` | | |
|
|
10
|
+
| `minDate` | ```Date``` | | |
|
|
11
|
+
| `maxDate` | ```Date``` | | |
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# # EmbeddedCreateTemplateRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `title`<sup>*_required_</sup> | ```string``` | | |
|
|
10
|
+
| `redirectUrl` | ```string``` | | |
|
|
11
|
+
| `showToolbar` | ```boolean``` | | [default to false] |
|
|
12
|
+
| `viewOption` | ```string``` | | [default to ViewOptionEnum.PreparePage] |
|
|
13
|
+
| `showSaveButton` | ```boolean``` | | [default to true] |
|
|
14
|
+
| `locale` | ```string``` | | [default to LocaleEnum.En] |
|
|
15
|
+
| `showSendButton` | ```boolean``` | | |
|
|
16
|
+
| `showCreateButton` | ```boolean``` | | [default to true] |
|
|
17
|
+
| `showPreviewButton` | ```boolean``` | | [default to true] |
|
|
18
|
+
| `showNavigationButtons` | ```boolean``` | | [default to true] |
|
|
19
|
+
| `linkValidTill` | ```Date``` | | |
|
|
20
|
+
| `showTooltip` | ```boolean``` | | [default to false] |
|
|
21
|
+
| `description` | ```string``` | | |
|
|
22
|
+
| `documentTitle` | ```string``` | | |
|
|
23
|
+
| `documentMessage` | ```string``` | | |
|
|
24
|
+
| `files` | ```Array<RequestFile>``` | | |
|
|
25
|
+
| `fileUrls` | ```Array<string>``` | | |
|
|
26
|
+
| `roles` | [```Array<TemplateRole>```](TemplateRole.md) | | |
|
|
27
|
+
| `allowModifyFiles` | ```boolean``` | | [default to true] |
|
|
28
|
+
| `cc` | [```Array<DocumentCC>```](DocumentCC.md) | | |
|
|
29
|
+
| `brandId` | ```string``` | | |
|
|
30
|
+
| `allowMessageEditing` | ```boolean``` | | [default to true] |
|
|
31
|
+
| `allowNewRoles` | ```boolean``` | | [default to true] |
|
|
32
|
+
| `allowNewFiles` | ```boolean``` | | [default to true] |
|
|
33
|
+
| `enableReassign` | ```boolean``` | | [default to true] |
|
|
34
|
+
| `enablePrintAndSign` | ```boolean``` | | [default to false] |
|
|
35
|
+
| `enableSigningOrder` | ```boolean``` | | [default to false] |
|
|
36
|
+
| `documentInfo` | [```Array<DocumentInfo>```](DocumentInfo.md) | | |
|
|
37
|
+
| `useTextTags` | ```boolean``` | | [default to false] |
|
|
38
|
+
| `textTagDefinitions` | [```Array<TextTagDefinition>```](TextTagDefinition.md) | | |
|
|
39
|
+
| `autoDetectFields` | ```boolean``` | | [default to false] |
|
|
40
|
+
| `onBehalfOf` | ```string``` | | |
|
|
41
|
+
| `labels` | ```Array<string>``` | | |
|
|
42
|
+
| `templateLabels` | ```Array<string>``` | | |
|
|
43
|
+
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
44
|
+
| `formGroups` | [```Array<FormGroup>```](FormGroup.md) | | |
|
|
45
|
+
|
|
46
|
+
[[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
|
+
# # EmbeddedCustomFieldCreated
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `createUrl` | ```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,55 @@
|
|
|
1
|
+
# # EmbeddedDocumentRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `redirectUrl` | ```string``` | | |
|
|
10
|
+
| `showToolbar` | ```boolean``` | | [default to false] |
|
|
11
|
+
| `sendViewOption` | ```string``` | | [default to SendViewOptionEnum.PreparePage] |
|
|
12
|
+
| `showSaveButton` | ```boolean``` | | [default to true] |
|
|
13
|
+
| `locale` | ```string``` | | [default to LocaleEnum.En] |
|
|
14
|
+
| `showSendButton` | ```boolean``` | | [default to true] |
|
|
15
|
+
| `showPreviewButton` | ```boolean``` | | [default to true] |
|
|
16
|
+
| `showNavigationButtons` | ```boolean``` | | [default to true] |
|
|
17
|
+
| `showTooltip` | ```boolean``` | | [default to false] |
|
|
18
|
+
| `embeddedSendLinkValidTill` | ```Date``` | | |
|
|
19
|
+
| `files` | ```Array<RequestFile>``` | | |
|
|
20
|
+
| `title` | ```string``` | | |
|
|
21
|
+
| `message` | ```string``` | | |
|
|
22
|
+
| `signers` | [```Array<DocumentSigner>```](DocumentSigner.md) | | |
|
|
23
|
+
| `cc` | [```Array<DocumentCC>```](DocumentCC.md) | | |
|
|
24
|
+
| `enableSigningOrder` | ```boolean``` | | [default to false] |
|
|
25
|
+
| `expiryDays` | ```number``` | | |
|
|
26
|
+
| `expiryDateType` | ```string``` | | |
|
|
27
|
+
| `expiryValue` | ```number``` | | [default to 60] |
|
|
28
|
+
| `reminderSettings` | [```ReminderSettings```](ReminderSettings.md) | | |
|
|
29
|
+
| `enableEmbeddedSigning` | ```boolean``` | | [default to false] |
|
|
30
|
+
| `disableEmails` | ```boolean``` | | [default to false] |
|
|
31
|
+
| `disableSMS` | ```boolean``` | | [default to false] |
|
|
32
|
+
| `brandId` | ```string``` | | |
|
|
33
|
+
| `hideDocumentId` | ```boolean``` | | [default to false] |
|
|
34
|
+
| `labels` | ```Array<string>``` | | |
|
|
35
|
+
| `fileUrls` | ```Array<string>``` | | |
|
|
36
|
+
| `sendLinkValidTill` | ```Date``` | | |
|
|
37
|
+
| `useTextTags` | ```boolean``` | | [default to false] |
|
|
38
|
+
| `textTagDefinitions` | [```Array<TextTagDefinition>```](TextTagDefinition.md) | | |
|
|
39
|
+
| `enablePrintAndSign` | ```boolean``` | | [default to false] |
|
|
40
|
+
| `enableReassign` | ```boolean``` | | [default to true] |
|
|
41
|
+
| `disableExpiryAlert` | ```boolean``` | | |
|
|
42
|
+
| `documentInfo` | [```Array<DocumentInfo>```](DocumentInfo.md) | | |
|
|
43
|
+
| `onBehalfOf` | ```string``` | | |
|
|
44
|
+
| `autoDetectFields` | ```boolean``` | | [default to false] |
|
|
45
|
+
| `documentDownloadOption` | ```string``` | | |
|
|
46
|
+
| `isSandbox` | ```boolean``` | | |
|
|
47
|
+
| `metaData` | ```{ [key: string]: string | null; }``` | | |
|
|
48
|
+
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
49
|
+
| `formGroups` | [```Array<FormGroup>```](FormGroup.md) | | |
|
|
50
|
+
| `enableAuditTrailLocalization` | ```boolean``` | | |
|
|
51
|
+
| `downloadFileName` | ```string``` | | |
|
|
52
|
+
| `scheduledSendTime` | ```number``` | | |
|
|
53
|
+
| `allowScheduledSend` | ```boolean``` | | [default to false] |
|
|
54
|
+
|
|
55
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# # EmbeddedFileDetails
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `emailId` | ```string``` | | |
|
|
10
|
+
| `countryCode` | ```string``` | | |
|
|
11
|
+
| `phoneNumber` | ```string``` | | |
|
|
12
|
+
| `redirectUrl` | ```string``` | | |
|
|
13
|
+
| `order` | ```number``` | | |
|
|
14
|
+
| `onBehalfOf` | ```string``` | | |
|
|
15
|
+
|
|
16
|
+
[[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
|
+
# # EmbeddedFileLink
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `url` | ```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,56 @@
|
|
|
1
|
+
# # EmbeddedMergeTemplateFormRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `files` | ```Array<RequestFile>``` | | |
|
|
10
|
+
| `fileUrls` | ```Array<string>``` | | |
|
|
11
|
+
| `redirectUrl` | ```string``` | | |
|
|
12
|
+
| `showToolbar` | ```boolean``` | | |
|
|
13
|
+
| `sendViewOption` | ```string``` | | |
|
|
14
|
+
| `showSaveButton` | ```boolean``` | | |
|
|
15
|
+
| `locale` | ```string``` | | |
|
|
16
|
+
| `showSendButton` | ```boolean``` | | |
|
|
17
|
+
| `showPreviewButton` | ```boolean``` | | |
|
|
18
|
+
| `showNavigationButtons` | ```boolean``` | | |
|
|
19
|
+
| `sendLinkValidTill` | ```Date``` | | |
|
|
20
|
+
| `showTooltip` | ```boolean``` | | |
|
|
21
|
+
| `templateIds` | ```Array<string>``` | | |
|
|
22
|
+
| `useTextTags` | ```boolean``` | | |
|
|
23
|
+
| `textTagDefinitions` | [```Array<TextTagDefinition>```](TextTagDefinition.md) | | |
|
|
24
|
+
| `documentId` | ```string``` | | |
|
|
25
|
+
| `title` | ```string``` | | |
|
|
26
|
+
| `message` | ```string``` | | |
|
|
27
|
+
| `roles` | [```Array<Role>```](Role.md) | | |
|
|
28
|
+
| `brandId` | ```string``` | | |
|
|
29
|
+
| `labels` | ```Array<string>``` | | |
|
|
30
|
+
| `disableEmails` | ```boolean``` | | |
|
|
31
|
+
| `disableSMS` | ```boolean``` | | [default to false] |
|
|
32
|
+
| `hideDocumentId` | ```boolean``` | | |
|
|
33
|
+
| `reminderSettings` | [```ReminderSettings```](ReminderSettings.md) | | |
|
|
34
|
+
| `cc` | [```Array<DocumentCC>```](DocumentCC.md) | | |
|
|
35
|
+
| `expiryDays` | ```number``` | | |
|
|
36
|
+
| `expiryDateType` | ```string``` | | |
|
|
37
|
+
| `expiryValue` | ```number``` | | [default to 60] |
|
|
38
|
+
| `enablePrintAndSign` | ```boolean``` | | |
|
|
39
|
+
| `enableReassign` | ```boolean``` | | |
|
|
40
|
+
| `enableSigningOrder` | ```boolean``` | | |
|
|
41
|
+
| `disableExpiryAlert` | ```boolean``` | | |
|
|
42
|
+
| `documentInfo` | [```Array<DocumentInfo>```](DocumentInfo.md) | | |
|
|
43
|
+
| `onBehalfOf` | ```string``` | | |
|
|
44
|
+
| `isSandbox` | ```boolean``` | | |
|
|
45
|
+
| `roleRemovalIndices` | ```Array<number>``` | | |
|
|
46
|
+
| `documentDownloadOption` | ```string``` | | |
|
|
47
|
+
| `metaData` | ```{ [key: string]: string | null; }``` | | |
|
|
48
|
+
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
49
|
+
| `formGroups` | [```Array<FormGroup>```](FormGroup.md) | | |
|
|
50
|
+
| `removeFormFields` | ```Array<string>``` | | |
|
|
51
|
+
| `enableAuditTrailLocalization` | ```boolean``` | | |
|
|
52
|
+
| `downloadFileName` | ```string``` | | |
|
|
53
|
+
| `scheduledSendTime` | ```number``` | | |
|
|
54
|
+
| `allowScheduledSend` | ```boolean``` | | [default to false] |
|
|
55
|
+
|
|
56
|
+
[[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
|
+
# # EmbeddedSendCreated
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `documentId` | ```string``` | | |
|
|
10
|
+
| `sendUrl` | ```string``` | | |
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|