boldsign 3.1.0-beta.0 → 3.1.0-beta.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 +5 -1
- package/README.md +5 -1
- package/api/apis.ts +1 -1
- package/boldsign-3.1.0-beta.2.tgz +0 -0
- package/dist/api/apis.d.ts +1 -1
- package/dist/api/apis.js +1 -1
- package/dist/model/behalfDocument.d.ts +2 -0
- package/dist/model/behalfDocument.js +10 -0
- package/dist/model/behalfDocument.js.map +1 -1
- package/dist/model/behalfOfWebhookModel.d.ts +15 -0
- package/dist/model/behalfOfWebhookModel.js +23 -0
- package/dist/model/behalfOfWebhookModel.js.map +1 -0
- package/dist/model/brandCreated.d.ts +1 -0
- package/dist/model/brandCreated.js +5 -0
- package/dist/model/brandCreated.js.map +1 -1
- package/dist/model/createTemplateRequest.d.ts +1 -0
- package/dist/model/createTemplateRequest.js +5 -0
- package/dist/model/createTemplateRequest.js.map +1 -1
- package/dist/model/customFormField.d.ts +3 -1
- package/dist/model/customFormField.js +7 -0
- package/dist/model/customFormField.js.map +1 -1
- package/dist/model/documentCcWebhookModel.d.ts +1 -0
- package/dist/model/documentCcWebhookModel.js +5 -0
- package/dist/model/documentCcWebhookModel.js.map +1 -1
- package/dist/model/documentEvent.d.ts +11 -0
- package/dist/model/documentEvent.js +26 -0
- package/dist/model/documentEvent.js.map +1 -1
- package/dist/model/documentFormFields.d.ts +1 -0
- package/dist/model/documentFormFields.js +8 -0
- package/dist/model/documentFormFields.js.map +1 -1
- package/dist/model/documentGroupSignerWebhookModel.d.ts +1 -0
- package/dist/model/documentGroupSignerWebhookModel.js +5 -0
- package/dist/model/documentGroupSignerWebhookModel.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/editDocumentRequest.d.ts +9 -0
- package/dist/model/editDocumentRequest.js +21 -0
- package/dist/model/editDocumentRequest.js.map +1 -1
- package/dist/model/editDocumentSigner.d.ts +9 -3
- package/dist/model/editDocumentSigner.js +18 -3
- package/dist/model/editDocumentSigner.js.map +1 -1
- package/dist/model/editFormField.d.ts +2 -2
- package/dist/model/editFormField.js +2 -2
- package/dist/model/editFormField.js.map +1 -1
- package/dist/model/editTemplateRequest.d.ts +2 -0
- package/dist/model/editTemplateRequest.js +10 -0
- package/dist/model/editTemplateRequest.js.map +1 -1
- package/dist/model/editableDateFieldSettings.d.ts +1 -0
- package/dist/model/editableDateFieldSettings.js +5 -0
- package/dist/model/editableDateFieldSettings.js.map +1 -1
- package/dist/model/embeddedCreateTemplateRequest.d.ts +1 -0
- package/dist/model/embeddedCreateTemplateRequest.js +5 -0
- package/dist/model/embeddedCreateTemplateRequest.js.map +1 -1
- package/dist/model/embeddedDocumentRequest.d.ts +1 -0
- package/dist/model/embeddedDocumentRequest.js +5 -0
- package/dist/model/embeddedDocumentRequest.js.map +1 -1
- package/dist/model/embeddedMergeTemplateFormRequest.d.ts +1 -0
- package/dist/model/embeddedMergeTemplateFormRequest.js +5 -0
- package/dist/model/embeddedMergeTemplateFormRequest.js.map +1 -1
- package/dist/model/embeddedSendTemplateFormRequest.d.ts +1 -0
- package/dist/model/embeddedSendTemplateFormRequest.js +5 -0
- package/dist/model/embeddedSendTemplateFormRequest.js.map +1 -1
- package/dist/model/formField.d.ts +4 -1
- package/dist/model/formField.js +14 -0
- package/dist/model/formField.js.map +1 -1
- package/dist/model/formFieldPermissionWebhookModel.d.ts +16 -0
- package/dist/model/formFieldPermissionWebhookModel.js +28 -0
- package/dist/model/formFieldPermissionWebhookModel.js.map +1 -0
- package/dist/model/index.d.ts +6 -2
- package/dist/model/index.js +25 -7
- package/dist/model/index.js.map +1 -1
- package/dist/model/mergeAndSendForSignForm.d.ts +1 -0
- package/dist/model/mergeAndSendForSignForm.js +5 -0
- package/dist/model/mergeAndSendForSignForm.js.map +1 -1
- package/dist/model/roles.d.ts +2 -2
- package/dist/model/roles.js +1 -1
- package/dist/model/roles.js.map +1 -1
- package/dist/model/senderIdentityEvent.d.ts +1 -0
- package/dist/model/senderIdentityEvent.js +5 -0
- package/dist/model/senderIdentityEvent.js.map +1 -1
- package/dist/model/templateCcWebhookModel.d.ts +1 -0
- package/dist/model/templateCcWebhookModel.js +5 -0
- package/dist/model/templateCcWebhookModel.js.map +1 -1
- package/dist/model/templateEvent.d.ts +7 -0
- package/dist/model/templateEvent.js +20 -0
- package/dist/model/templateEvent.js.map +1 -1
- package/dist/model/templateFormFields.d.ts +2 -0
- package/dist/model/templateFormFields.js +13 -0
- package/dist/model/templateFormFields.js.map +1 -1
- package/dist/model/templateGroupSigner.d.ts +15 -0
- package/dist/model/templateGroupSigner.js +23 -0
- package/dist/model/templateGroupSigner.js.map +1 -0
- package/dist/model/templateProperties.d.ts +1 -0
- package/dist/model/templateProperties.js +5 -0
- package/dist/model/templateProperties.js.map +1 -1
- package/dist/model/textTagDefinition.d.ts +3 -1
- package/dist/model/textTagDefinition.js +9 -0
- package/dist/model/textTagDefinition.js.map +1 -1
- package/dist/model/webhookActorDetails.d.ts +25 -0
- package/dist/model/webhookActorDetails.js +34 -0
- package/dist/model/webhookActorDetails.js.map +1 -0
- package/dist/model/webhookContext.d.ts +51 -0
- package/dist/model/webhookContext.js +63 -0
- package/dist/model/webhookContext.js.map +1 -0
- package/dist/model/webhookEvent.d.ts +2 -0
- package/dist/model/webhookEvent.js +5 -0
- package/dist/model/webhookEvent.js.map +1 -1
- package/dist/model/webhookEventData.d.ts +14 -0
- package/dist/model/webhookEventData.js +36 -0
- package/dist/model/webhookEventData.js.map +1 -1
- package/dist/model/webhookEventMetadata.d.ts +2 -1
- package/dist/model/webhookEventMetadata.js +1 -0
- package/dist/model/webhookEventMetadata.js.map +1 -1
- package/docs/BehalfDocument.md +2 -0
- package/docs/BehalfOfWebhookModel.md +12 -0
- package/docs/BrandCreated.md +1 -0
- package/docs/CreateTemplateRequest.md +1 -0
- package/docs/CustomFormField.md +1 -0
- package/docs/DocumentCcWebhookModel.md +1 -0
- package/docs/DocumentEvent.md +4 -0
- package/docs/DocumentFormFields.md +1 -0
- package/docs/DocumentGroupSignerWebhookModel.md +1 -0
- package/docs/DocumentSignerDetails.md +1 -0
- package/docs/EditDocumentRequest.md +3 -0
- package/docs/EditDocumentSigner.md +2 -0
- package/docs/EditTemplateRequest.md +2 -0
- package/docs/EditableDateFieldSettings.md +1 -0
- package/docs/EmbeddedCreateTemplateRequest.md +1 -0
- package/docs/EmbeddedDocumentRequest.md +1 -0
- package/docs/EmbeddedMergeTemplateFormRequest.md +1 -0
- package/docs/EmbeddedSendTemplateFormRequest.md +1 -0
- package/docs/FormField.md +2 -0
- package/docs/FormFieldPermissionWebhookModel.md +13 -0
- package/docs/MergeAndSendForSignForm.md +1 -0
- package/docs/Roles.md +1 -1
- package/docs/SenderIdentityEvent.md +1 -0
- package/docs/TemplateCcWebhookModel.md +1 -0
- package/docs/TemplateEvent.md +4 -0
- package/docs/TemplateFormFields.md +2 -0
- package/docs/TemplateGroupSigner.md +12 -0
- package/docs/TemplateProperties.md +1 -0
- package/docs/TextTagDefinition.md +1 -0
- package/docs/WebhookActorDetails.md +12 -0
- package/docs/WebhookContext.md +13 -0
- package/docs/WebhookEvent.md +1 -0
- package/docs/WebhookEventData.md +6 -0
- package/model/behalfDocument.ts +12 -0
- package/model/behalfOfWebhookModel.ts +37 -0
- package/model/brandCreated.ts +6 -0
- package/model/createTemplateRequest.ts +6 -0
- package/model/customFormField.ts +8 -1
- package/model/documentCcWebhookModel.ts +6 -0
- package/model/documentEvent.ts +31 -0
- package/model/documentFormFields.ts +6 -0
- package/model/documentGroupSignerWebhookModel.ts +6 -0
- package/model/documentSignerDetails.ts +7 -0
- package/model/editDocumentRequest.ts +24 -0
- package/model/editDocumentSigner.ts +19 -3
- package/model/editFormField.ts +2 -2
- package/model/editTemplateRequest.ts +12 -0
- package/model/editableDateFieldSettings.ts +6 -0
- package/model/embeddedCreateTemplateRequest.ts +6 -0
- package/model/embeddedDocumentRequest.ts +6 -0
- package/model/embeddedMergeTemplateFormRequest.ts +6 -0
- package/model/embeddedSendTemplateFormRequest.ts +6 -0
- package/model/formField.ts +14 -1
- package/model/formFieldPermissionWebhookModel.ts +43 -0
- package/model/index.ts +21 -3
- package/model/mergeAndSendForSignForm.ts +6 -0
- package/model/roles.ts +3 -3
- package/model/senderIdentityEvent.ts +6 -0
- package/model/templateCcWebhookModel.ts +6 -0
- package/model/templateEvent.ts +27 -0
- package/model/templateFormFields.ts +12 -0
- package/model/templateGroupSigner.ts +37 -0
- package/model/templateProperties.ts +6 -0
- package/model/textTagDefinition.ts +8 -1
- package/model/webhookActorDetails.ts +47 -0
- package/model/webhookContext.ts +78 -0
- package/model/webhookEvent.ts +7 -0
- package/model/webhookEventData.ts +44 -0
- package/model/webhookEventMetadata.ts +2 -1
- package/package.json +1 -1
- package/boldsign-3.1.0-beta.0.tgz +0 -0
|
@@ -48,5 +48,6 @@ Name | Type | Description | Notes
|
|
|
48
48
|
| `allowDeleteFormField` | ```boolean``` | | |
|
|
49
49
|
| `collaborationSettings` | [```CollaborationSettings```](CollaborationSettings.md) | | |
|
|
50
50
|
| `hidden` | ```boolean``` | | |
|
|
51
|
+
| `isMasked` | ```boolean``` | | [default to false] |
|
|
51
52
|
|
|
52
53
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -13,5 +13,6 @@ Name | Type | Description | Notes
|
|
|
13
13
|
| `isViewed` | ```boolean``` | | |
|
|
14
14
|
| `isDeliveryFailed` | ```boolean``` | | |
|
|
15
15
|
| `isAuthenticationFailed` | ```boolean``` | | |
|
|
16
|
+
| `lastReminderSentOn` | ```Date``` | | |
|
|
16
17
|
|
|
17
18
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -36,5 +36,6 @@ Name | Type | Description | Notes
|
|
|
36
36
|
| `enableQes` | ```boolean``` | | |
|
|
37
37
|
| `deliveryMode` | ```string``` | | |
|
|
38
38
|
| `authenticationSettings` | [```SignerAuthenticationSettings```](SignerAuthenticationSettings.md) | | |
|
|
39
|
+
| `groupSigners` | [```Array<GroupSigner>```](GroupSigner.md) | | |
|
|
39
40
|
|
|
40
41
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -34,5 +34,8 @@ Name | Type | Description | Notes
|
|
|
34
34
|
| `formGroups` | [```Array<FormGroup>```](FormGroup.md) | | |
|
|
35
35
|
| `downloadFileName` | ```string``` | | |
|
|
36
36
|
| `scheduledSendTime` | ```number``` | | |
|
|
37
|
+
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
38
|
+
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
39
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
37
40
|
|
|
38
41
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -25,6 +25,8 @@ Name | Type | Description | Notes
|
|
|
25
25
|
| `formFields` | [```Array<EditFormField>```](EditFormField.md) | | |
|
|
26
26
|
| `language` | ```number``` | | |
|
|
27
27
|
| `locale` | ```string``` | | |
|
|
28
|
+
| `signType` | ```string``` | | |
|
|
29
|
+
| `groupId` | ```string``` | | |
|
|
28
30
|
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
29
31
|
| `authenticationRetryCount` | ```number``` | | |
|
|
30
32
|
| `enableQes` | ```boolean``` | | |
|
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
| `allowMessageEditing` | ```boolean``` | | |
|
|
17
17
|
| `allowNewRoles` | ```boolean``` | | |
|
|
18
18
|
| `allowNewFiles` | ```boolean``` | | |
|
|
19
|
+
| `allowModifyFiles` | ```boolean``` | | |
|
|
19
20
|
| `enableReassign` | ```boolean``` | | |
|
|
20
21
|
| `enablePrintAndSign` | ```boolean``` | | |
|
|
21
22
|
| `enableSigningOrder` | ```boolean``` | | |
|
|
@@ -28,5 +29,6 @@ Name | Type | Description | Notes
|
|
|
28
29
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
29
30
|
| `formFieldPermission` | [```FormFieldPermission```](FormFieldPermission.md) | | |
|
|
30
31
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
32
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
31
33
|
|
|
32
34
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -9,5 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
| `dateFormat`<sup>*_required_</sup> | ```string``` | | |
|
|
10
10
|
| `minDate` | ```Date``` | | |
|
|
11
11
|
| `maxDate` | ```Date``` | | |
|
|
12
|
+
| `timeFormat` | ```string``` | | |
|
|
12
13
|
|
|
13
14
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -45,5 +45,6 @@ Name | Type | Description | Notes
|
|
|
45
45
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
46
46
|
| `formFieldPermission` | [```FormFieldPermission```](FormFieldPermission.md) | | |
|
|
47
47
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
48
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
48
49
|
|
|
49
50
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -53,5 +53,6 @@ Name | Type | Description | Notes
|
|
|
53
53
|
| `allowScheduledSend` | ```boolean``` | | [default to false] |
|
|
54
54
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
55
55
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
56
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
56
57
|
|
|
57
58
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -54,5 +54,6 @@ Name | Type | Description | Notes
|
|
|
54
54
|
| `allowScheduledSend` | ```boolean``` | | [default to false] |
|
|
55
55
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
56
56
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
57
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
57
58
|
|
|
58
59
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -51,5 +51,6 @@ Name | Type | Description | Notes
|
|
|
51
51
|
| `allowScheduledSend` | ```boolean``` | | [default to false] |
|
|
52
52
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
53
53
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
54
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
54
55
|
|
|
55
56
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
package/docs/FormField.md
CHANGED
|
@@ -47,5 +47,7 @@ Name | Type | Description | Notes
|
|
|
47
47
|
| `allowEditFormField` | ```boolean``` | | |
|
|
48
48
|
| `allowDeleteFormField` | ```boolean``` | | |
|
|
49
49
|
| `collaborationSettings` | [```CollaborationSettings```](CollaborationSettings.md) | | |
|
|
50
|
+
| `isMasked` | ```boolean``` | | [default to false] |
|
|
51
|
+
| `isDefaultValueRequired` | ```boolean``` | | |
|
|
50
52
|
|
|
51
53
|
[[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
|
+
# # FormFieldPermissionWebhookModel
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `canAdd` | ```boolean``` | | |
|
|
10
|
+
| `canModify` | ```boolean``` | | |
|
|
11
|
+
| `canModifyDefaultValue` | ```boolean``` | | |
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -44,5 +44,6 @@ Name | Type | Description | Notes
|
|
|
44
44
|
| `allowScheduledSend` | ```boolean``` | | [default to false] |
|
|
45
45
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
46
46
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
47
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
47
48
|
|
|
48
49
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
package/docs/Roles.md
CHANGED
|
@@ -31,6 +31,6 @@ Name | Type | Description | Notes
|
|
|
31
31
|
| `enableDeleteRecipients` | ```boolean``` | | |
|
|
32
32
|
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
33
33
|
| `enableQes` | ```boolean``` | | |
|
|
34
|
-
| `groupSigners` | [```Array<
|
|
34
|
+
| `groupSigners` | [```Array<TemplateGroupSigner>```](TemplateGroupSigner.md) | | |
|
|
35
35
|
|
|
36
36
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -18,5 +18,6 @@ Name | Type | Description | Notes
|
|
|
18
18
|
| `redirectUrl` | ```string``` | | |
|
|
19
19
|
| `metaData` | ```{ [key: string]: string | null; }``` | | |
|
|
20
20
|
| `createdBy` | [```SenderIdentityCreator```](SenderIdentityCreator.md) | | |
|
|
21
|
+
| `locale` | ```string``` | | |
|
|
21
22
|
|
|
22
23
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -8,5 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
| `emailAddress` | ```string``` | | |
|
|
10
10
|
| `userId` | ```string``` | | |
|
|
11
|
+
| `id` | ```string``` | | |
|
|
11
12
|
|
|
12
13
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
package/docs/TemplateEvent.md
CHANGED
|
@@ -27,5 +27,9 @@ Name | Type | Description | Notes
|
|
|
27
27
|
| `onBehalfOf` | ```string``` | | |
|
|
28
28
|
| `labels` | ```Array<string>``` | | |
|
|
29
29
|
| `templateLabels` | ```Array<string>``` | | |
|
|
30
|
+
| `formFieldPermission` | [```FormFieldPermissionWebhookModel```](FormFieldPermissionWebhookModel.md) | | |
|
|
31
|
+
| `groupSignerSettings` | [```GroupSignerSettingsWebhookModel```](GroupSignerSettingsWebhookModel.md) | | |
|
|
32
|
+
| `behalfOf` | [```BehalfOfWebhookModel```](BehalfOfWebhookModel.md) | | |
|
|
33
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
30
34
|
|
|
31
35
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -47,5 +47,7 @@ Name | Type | Description | Notes
|
|
|
47
47
|
| `allowEditFormField` | ```boolean``` | | |
|
|
48
48
|
| `allowDeleteFormField` | ```boolean``` | | |
|
|
49
49
|
| `collaborationSettings` | [```CollaborationSettings```](CollaborationSettings.md) | | |
|
|
50
|
+
| `isMasked` | ```boolean``` | | [default to false] |
|
|
51
|
+
| `isDefaultValueRequired` | ```boolean``` | | |
|
|
50
52
|
|
|
51
53
|
[[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
|
+
# # TemplateGroupSigner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `signerEmail` | ```string``` | | |
|
|
10
|
+
| `signerName` | ```string``` | | |
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -37,5 +37,6 @@ Name | Type | Description | Notes
|
|
|
37
37
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
38
38
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
39
39
|
| `sharing` | [```TemplateSharing```](TemplateSharing.md) | | |
|
|
40
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
40
41
|
|
|
41
42
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -37,5 +37,6 @@ Name | Type | Description | Notes
|
|
|
37
37
|
| `formulaFieldSettings` | [```FormulaFieldSettings```](FormulaFieldSettings.md) | | |
|
|
38
38
|
| `resizeOption` | ```string``` | | |
|
|
39
39
|
| `collaborationSettings` | [```CollaborationSettings```](CollaborationSettings.md) | | |
|
|
40
|
+
| `isMasked` | ```boolean``` | | [default to false] |
|
|
40
41
|
|
|
41
42
|
[[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
|
+
# # WebhookActorDetails
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `userType`<sup>*_required_</sup> | ```string``` | | |
|
|
10
|
+
| `id`<sup>*_required_</sup> | ```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,13 @@
|
|
|
1
|
+
# # WebhookContext
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `eventType` | ```string``` | | |
|
|
10
|
+
| `actor` | [```WebhookActorDetails```](WebhookActorDetails.md) | | |
|
|
11
|
+
| `previousState` | ```any``` | | |
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
package/docs/WebhookEvent.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
| `event` | [```WebhookEventMetadata```](WebhookEventMetadata.md) | | |
|
|
10
|
+
| `context` | [```WebhookContext```](WebhookContext.md) | | |
|
|
10
11
|
| `data` | [```WebhookEventData```](WebhookEventData.md) | | |
|
|
11
12
|
| `document` | [```DocumentEvent```](DocumentEvent.md) | | |
|
|
12
13
|
|
package/docs/WebhookEventData.md
CHANGED
|
@@ -28,6 +28,10 @@ Name | Type | Description | Notes
|
|
|
28
28
|
| `documentDownloadOption` | ```string``` | | |
|
|
29
29
|
| `metaData` | ```{ [key: string]: string | null; }``` | | |
|
|
30
30
|
| `failedDeliveryMode` | ```string``` | | |
|
|
31
|
+
| `behalfOf` | [```BehalfOfWebhookModel```](BehalfOfWebhookModel.md) | | |
|
|
32
|
+
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
33
|
+
| `groupSignerSettings` | [```GroupSignerSettingsWebhookModel```](GroupSignerSettingsWebhookModel.md) | | |
|
|
34
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
31
35
|
| `templateId` | ```string``` | | |
|
|
32
36
|
| `allowNewFiles` | ```boolean``` | | |
|
|
33
37
|
| `allowModifyFiles` | ```boolean``` | | |
|
|
@@ -37,6 +41,7 @@ Name | Type | Description | Notes
|
|
|
37
41
|
| `templateDescription` | ```string``` | | |
|
|
38
42
|
| `isTemplate` | ```boolean``` | | [default to false] |
|
|
39
43
|
| `templateLabels` | ```Array<string>``` | | |
|
|
44
|
+
| `formFieldPermission` | [```FormFieldPermissionWebhookModel```](FormFieldPermissionWebhookModel.md) | | |
|
|
40
45
|
| `id` | ```string``` | | |
|
|
41
46
|
| `name` | ```string``` | | |
|
|
42
47
|
| `email` | ```string``` | | |
|
|
@@ -44,6 +49,7 @@ Name | Type | Description | Notes
|
|
|
44
49
|
| `approvedDateTime` | ```Date``` | | |
|
|
45
50
|
| `redirectUrl` | ```string``` | | |
|
|
46
51
|
| `createdBy` | [```SenderIdentityCreator```](SenderIdentityCreator.md) | | |
|
|
52
|
+
| `locale` | ```string``` | | |
|
|
47
53
|
| `signerDetail` | [```DocumentSignerWebhookModel```](DocumentSignerWebhookModel.md) | | |
|
|
48
54
|
|
|
49
55
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
package/model/behalfDocument.ts
CHANGED
|
@@ -34,6 +34,8 @@ export class BehalfDocument {
|
|
|
34
34
|
'cursor'?: number;
|
|
35
35
|
'brandId'?: string | null;
|
|
36
36
|
'scheduledSendTime'?: number | null;
|
|
37
|
+
'inEditingMode'?: boolean;
|
|
38
|
+
'displayStatus'?: string | null;
|
|
37
39
|
|
|
38
40
|
static discriminator: string | undefined = undefined;
|
|
39
41
|
|
|
@@ -122,6 +124,16 @@ export class BehalfDocument {
|
|
|
122
124
|
"name": "scheduledSendTime",
|
|
123
125
|
"baseName": "scheduledSendTime",
|
|
124
126
|
"type": "number"
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"name": "inEditingMode",
|
|
130
|
+
"baseName": "inEditingMode",
|
|
131
|
+
"type": "boolean"
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "displayStatus",
|
|
135
|
+
"baseName": "displayStatus",
|
|
136
|
+
"type": "string"
|
|
125
137
|
} ];
|
|
126
138
|
|
|
127
139
|
static getAttributeTypeMap() {
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* BoldSign API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
import { RequestFile } from './models';
|
|
14
|
+
|
|
15
|
+
export class BehalfOfWebhookModel {
|
|
16
|
+
'id'?: string | null;
|
|
17
|
+
'email'?: string | null;
|
|
18
|
+
|
|
19
|
+
static discriminator: string | undefined = undefined;
|
|
20
|
+
|
|
21
|
+
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
|
|
22
|
+
{
|
|
23
|
+
"name": "id",
|
|
24
|
+
"baseName": "id",
|
|
25
|
+
"type": "string"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "email",
|
|
29
|
+
"baseName": "email",
|
|
30
|
+
"type": "string"
|
|
31
|
+
} ];
|
|
32
|
+
|
|
33
|
+
static getAttributeTypeMap() {
|
|
34
|
+
return BehalfOfWebhookModel.attributeTypeMap;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
|
package/model/brandCreated.ts
CHANGED
|
@@ -14,6 +14,7 @@ import { RequestFile } from './models';
|
|
|
14
14
|
|
|
15
15
|
export class BrandCreated {
|
|
16
16
|
'brandId'?: string | null;
|
|
17
|
+
'email'?: string | null;
|
|
17
18
|
|
|
18
19
|
static discriminator: string | undefined = undefined;
|
|
19
20
|
|
|
@@ -22,6 +23,11 @@ export class BrandCreated {
|
|
|
22
23
|
"name": "brandId",
|
|
23
24
|
"baseName": "brandId",
|
|
24
25
|
"type": "string"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "email",
|
|
29
|
+
"baseName": "email",
|
|
30
|
+
"type": "string"
|
|
25
31
|
} ];
|
|
26
32
|
|
|
27
33
|
static getAttributeTypeMap() {
|
|
@@ -49,6 +49,7 @@ export class CreateTemplateRequest {
|
|
|
49
49
|
'allowedSignatureTypes'?: Array<CreateTemplateRequest.AllowedSignatureTypesEnum>;
|
|
50
50
|
'formFieldPermission'?: FormFieldPermission;
|
|
51
51
|
'groupSignerSettings'?: GroupSignerSettings;
|
|
52
|
+
'enableAllowSignEverywhere'?: boolean | null;
|
|
52
53
|
|
|
53
54
|
static discriminator: string | undefined = undefined;
|
|
54
55
|
|
|
@@ -192,6 +193,11 @@ export class CreateTemplateRequest {
|
|
|
192
193
|
"name": "groupSignerSettings",
|
|
193
194
|
"baseName": "groupSignerSettings",
|
|
194
195
|
"type": "GroupSignerSettings"
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
"name": "enableAllowSignEverywhere",
|
|
199
|
+
"baseName": "enableAllowSignEverywhere",
|
|
200
|
+
"type": "boolean"
|
|
195
201
|
} ];
|
|
196
202
|
|
|
197
203
|
static getAttributeTypeMap() {
|
package/model/customFormField.ts
CHANGED
|
@@ -49,6 +49,7 @@ export class CustomFormField {
|
|
|
49
49
|
'restrictIdPrefixChange'?: boolean = false;
|
|
50
50
|
'backgroundHexColor'?: string | null;
|
|
51
51
|
'resizeOption'?: CustomFormField.ResizeOptionEnum;
|
|
52
|
+
'isMasked'?: boolean | null = false;
|
|
52
53
|
|
|
53
54
|
static discriminator: string | undefined = undefined;
|
|
54
55
|
|
|
@@ -217,6 +218,11 @@ export class CustomFormField {
|
|
|
217
218
|
"name": "resizeOption",
|
|
218
219
|
"baseName": "resizeOption",
|
|
219
220
|
"type": "CustomFormField.ResizeOptionEnum"
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"name": "isMasked",
|
|
224
|
+
"baseName": "isMasked",
|
|
225
|
+
"type": "boolean"
|
|
220
226
|
} ];
|
|
221
227
|
|
|
222
228
|
static getAttributeTypeMap() {
|
|
@@ -240,7 +246,8 @@ export namespace CustomFormField {
|
|
|
240
246
|
Dropdown = <any> 'Dropdown',
|
|
241
247
|
Title = <any> 'Title',
|
|
242
248
|
Company = <any> 'Company',
|
|
243
|
-
Formula = <any> 'Formula'
|
|
249
|
+
Formula = <any> 'Formula',
|
|
250
|
+
Drawing = <any> 'Drawing'
|
|
244
251
|
}
|
|
245
252
|
export enum FontEnum {
|
|
246
253
|
Helvetica = <any> 'Helvetica',
|
|
@@ -14,6 +14,7 @@ import { RequestFile } from './models';
|
|
|
14
14
|
|
|
15
15
|
export class DocumentCcWebhookModel {
|
|
16
16
|
'emailAddress'?: string | null;
|
|
17
|
+
'id'?: string | null;
|
|
17
18
|
|
|
18
19
|
static discriminator: string | undefined = undefined;
|
|
19
20
|
|
|
@@ -22,6 +23,11 @@ export class DocumentCcWebhookModel {
|
|
|
22
23
|
"name": "emailAddress",
|
|
23
24
|
"baseName": "emailAddress",
|
|
24
25
|
"type": "string"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "id",
|
|
29
|
+
"baseName": "id",
|
|
30
|
+
"type": "string"
|
|
25
31
|
} ];
|
|
26
32
|
|
|
27
33
|
static getAttributeTypeMap() {
|
package/model/documentEvent.ts
CHANGED
|
@@ -11,9 +11,11 @@
|
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
|
+
import { BehalfOfWebhookModel } from './behalfOfWebhookModel';
|
|
14
15
|
import { DocumentCcWebhookModel } from './documentCcWebhookModel';
|
|
15
16
|
import { DocumentSender } from './documentSender';
|
|
16
17
|
import { DocumentSignerWebhookModel } from './documentSignerWebhookModel';
|
|
18
|
+
import { GroupSignerSettingsWebhookModel } from './groupSignerSettingsWebhookModel';
|
|
17
19
|
|
|
18
20
|
export class DocumentEvent {
|
|
19
21
|
'object'?: string | null;
|
|
@@ -38,6 +40,10 @@ export class DocumentEvent {
|
|
|
38
40
|
'documentDownloadOption'?: string | null;
|
|
39
41
|
'metaData'?: { [key: string]: string | null; } | null;
|
|
40
42
|
'failedDeliveryMode'?: DocumentEvent.FailedDeliveryModeEnum;
|
|
43
|
+
'behalfOf'?: BehalfOfWebhookModel;
|
|
44
|
+
'allowedSignatureTypes'?: Array<DocumentEvent.AllowedSignatureTypesEnum>;
|
|
45
|
+
'groupSignerSettings'?: GroupSignerSettingsWebhookModel;
|
|
46
|
+
'enableAllowSignEverywhere'?: boolean | null;
|
|
41
47
|
|
|
42
48
|
static discriminator: string | undefined = undefined;
|
|
43
49
|
|
|
@@ -151,6 +157,26 @@ export class DocumentEvent {
|
|
|
151
157
|
"name": "failedDeliveryMode",
|
|
152
158
|
"baseName": "failedDeliveryMode",
|
|
153
159
|
"type": "DocumentEvent.FailedDeliveryModeEnum"
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
"name": "behalfOf",
|
|
163
|
+
"baseName": "behalfOf",
|
|
164
|
+
"type": "BehalfOfWebhookModel"
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"name": "allowedSignatureTypes",
|
|
168
|
+
"baseName": "allowedSignatureTypes",
|
|
169
|
+
"type": "Array<DocumentEvent.AllowedSignatureTypesEnum>"
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
"name": "groupSignerSettings",
|
|
173
|
+
"baseName": "groupSignerSettings",
|
|
174
|
+
"type": "GroupSignerSettingsWebhookModel"
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"name": "enableAllowSignEverywhere",
|
|
178
|
+
"baseName": "enableAllowSignEverywhere",
|
|
179
|
+
"type": "boolean"
|
|
154
180
|
} ];
|
|
155
181
|
|
|
156
182
|
static getAttributeTypeMap() {
|
|
@@ -173,4 +199,9 @@ export namespace DocumentEvent {
|
|
|
173
199
|
Sms = <any> 'SMS',
|
|
174
200
|
WhatsApp = <any> 'WhatsApp'
|
|
175
201
|
}
|
|
202
|
+
export enum AllowedSignatureTypesEnum {
|
|
203
|
+
Text = <any> 'Text',
|
|
204
|
+
Draw = <any> 'Draw',
|
|
205
|
+
Image = <any> 'Image'
|
|
206
|
+
}
|
|
176
207
|
}
|
|
@@ -63,6 +63,7 @@ export class DocumentFormFields {
|
|
|
63
63
|
'allowDeleteFormField'?: boolean;
|
|
64
64
|
'collaborationSettings'?: CollaborationSettings;
|
|
65
65
|
'hidden'?: boolean;
|
|
66
|
+
'isMasked'?: boolean = false;
|
|
66
67
|
|
|
67
68
|
static discriminator: string | undefined = undefined;
|
|
68
69
|
|
|
@@ -276,6 +277,11 @@ export class DocumentFormFields {
|
|
|
276
277
|
"name": "hidden",
|
|
277
278
|
"baseName": "hidden",
|
|
278
279
|
"type": "boolean"
|
|
280
|
+
},
|
|
281
|
+
{
|
|
282
|
+
"name": "isMasked",
|
|
283
|
+
"baseName": "isMasked",
|
|
284
|
+
"type": "boolean"
|
|
279
285
|
} ];
|
|
280
286
|
|
|
281
287
|
static getAttributeTypeMap() {
|
|
@@ -20,6 +20,7 @@ export class DocumentGroupSignerWebhookModel {
|
|
|
20
20
|
'isViewed'?: boolean;
|
|
21
21
|
'isDeliveryFailed'?: boolean;
|
|
22
22
|
'isAuthenticationFailed'?: boolean | null;
|
|
23
|
+
'lastReminderSentOn'?: Date | null;
|
|
23
24
|
|
|
24
25
|
static discriminator: string | undefined = undefined;
|
|
25
26
|
|
|
@@ -58,6 +59,11 @@ export class DocumentGroupSignerWebhookModel {
|
|
|
58
59
|
"name": "isAuthenticationFailed",
|
|
59
60
|
"baseName": "isAuthenticationFailed",
|
|
60
61
|
"type": "boolean"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"name": "lastReminderSentOn",
|
|
65
|
+
"baseName": "lastReminderSentOn",
|
|
66
|
+
"type": "Date"
|
|
61
67
|
} ];
|
|
62
68
|
|
|
63
69
|
static getAttributeTypeMap() {
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
14
|
import { DocumentFormFields } from './documentFormFields';
|
|
15
|
+
import { GroupSigner } from './groupSigner';
|
|
15
16
|
import { IdVerificationDetails } from './idVerificationDetails';
|
|
16
17
|
import { PhoneNumber } from './phoneNumber';
|
|
17
18
|
import { RecipientNotificationSettings } from './recipientNotificationSettings';
|
|
@@ -51,6 +52,7 @@ export class DocumentSignerDetails {
|
|
|
51
52
|
'enableQes'?: boolean | null;
|
|
52
53
|
'deliveryMode'?: DocumentSignerDetails.DeliveryModeEnum;
|
|
53
54
|
'authenticationSettings'?: SignerAuthenticationSettings;
|
|
55
|
+
'groupSigners'?: Array<GroupSigner> | null;
|
|
54
56
|
|
|
55
57
|
static discriminator: string | undefined = undefined;
|
|
56
58
|
|
|
@@ -204,6 +206,11 @@ export class DocumentSignerDetails {
|
|
|
204
206
|
"name": "authenticationSettings",
|
|
205
207
|
"baseName": "authenticationSettings",
|
|
206
208
|
"type": "SignerAuthenticationSettings"
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
"name": "groupSigners",
|
|
212
|
+
"baseName": "groupSigners",
|
|
213
|
+
"type": "Array<GroupSigner>"
|
|
207
214
|
} ];
|
|
208
215
|
|
|
209
216
|
static getAttributeTypeMap() {
|
|
@@ -16,6 +16,7 @@ import { DocumentInfo } from './documentInfo';
|
|
|
16
16
|
import { EditDocumentFile } from './editDocumentFile';
|
|
17
17
|
import { EditDocumentSigner } from './editDocumentSigner';
|
|
18
18
|
import { FormGroup } from './formGroup';
|
|
19
|
+
import { GroupSignerSettings } from './groupSignerSettings';
|
|
19
20
|
import { RecipientNotificationSettings } from './recipientNotificationSettings';
|
|
20
21
|
import { ReminderSettings } from './reminderSettings';
|
|
21
22
|
import { TextTagDefinition } from './textTagDefinition';
|
|
@@ -49,6 +50,9 @@ export class EditDocumentRequest {
|
|
|
49
50
|
'formGroups'?: Array<FormGroup> | null;
|
|
50
51
|
'downloadFileName'?: string | null;
|
|
51
52
|
'scheduledSendTime'?: number | null;
|
|
53
|
+
'allowedSignatureTypes'?: Array<EditDocumentRequest.AllowedSignatureTypesEnum>;
|
|
54
|
+
'groupSignerSettings'?: GroupSignerSettings;
|
|
55
|
+
'enableAllowSignEverywhere'?: boolean | null;
|
|
52
56
|
|
|
53
57
|
static discriminator: string | undefined = undefined;
|
|
54
58
|
|
|
@@ -192,6 +196,21 @@ export class EditDocumentRequest {
|
|
|
192
196
|
"name": "scheduledSendTime",
|
|
193
197
|
"baseName": "scheduledSendTime",
|
|
194
198
|
"type": "number"
|
|
199
|
+
},
|
|
200
|
+
{
|
|
201
|
+
"name": "allowedSignatureTypes",
|
|
202
|
+
"baseName": "allowedSignatureTypes",
|
|
203
|
+
"type": "Array<EditDocumentRequest.AllowedSignatureTypesEnum>"
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"name": "groupSignerSettings",
|
|
207
|
+
"baseName": "groupSignerSettings",
|
|
208
|
+
"type": "GroupSignerSettings"
|
|
209
|
+
},
|
|
210
|
+
{
|
|
211
|
+
"name": "enableAllowSignEverywhere",
|
|
212
|
+
"baseName": "enableAllowSignEverywhere",
|
|
213
|
+
"type": "boolean"
|
|
195
214
|
} ];
|
|
196
215
|
|
|
197
216
|
static getAttributeTypeMap() {
|
|
@@ -211,4 +230,9 @@ export namespace EditDocumentRequest {
|
|
|
211
230
|
Individually = <any> 'Individually',
|
|
212
231
|
Null = <any> 'null'
|
|
213
232
|
}
|
|
233
|
+
export enum AllowedSignatureTypesEnum {
|
|
234
|
+
Text = <any> 'Text',
|
|
235
|
+
Draw = <any> 'Draw',
|
|
236
|
+
Image = <any> 'Image'
|
|
237
|
+
}
|
|
214
238
|
}
|