boldsign 1.0.4 → 2.0.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 +24 -0
- package/README.md +28 -0
- package/api/apis.ts +53 -8
- package/api/brandingApi.ts +12 -2
- package/api/documentApi.ts +257 -1
- package/api/senderIdentitiesApi.ts +120 -1
- package/api/templateApi.ts +6 -1
- package/api/userApi.ts +122 -1
- package/auth/OAuthClient.ts +137 -0
- package/auth/OAuthToken.ts +17 -0
- package/auth/PKCEHelper.ts +36 -0
- package/boldsign-2.0.0-beta.2.tgz +0 -0
- package/dist/api/apis.d.ts +1 -1
- package/dist/api/apis.js +43 -7
- package/dist/api/apis.js.map +1 -1
- package/dist/api/brandingApi.d.ts +2 -2
- package/dist/api/brandingApi.js +10 -4
- package/dist/api/brandingApi.js.map +1 -1
- package/dist/api/documentApi.d.ts +3 -1
- package/dist/api/documentApi.js +165 -0
- package/dist/api/documentApi.js.map +1 -1
- package/dist/api/senderIdentitiesApi.d.ts +2 -1
- package/dist/api/senderIdentitiesApi.js +78 -0
- package/dist/api/senderIdentitiesApi.js.map +1 -1
- package/dist/api/templateApi.d.ts +1 -1
- package/dist/api/templateApi.js +5 -2
- package/dist/api/templateApi.js.map +1 -1
- package/dist/api/userApi.d.ts +2 -1
- package/dist/api/userApi.js +81 -0
- package/dist/api/userApi.js.map +1 -1
- package/dist/auth/OAuthClient.d.ts +36 -0
- package/dist/auth/OAuthClient.js +152 -0
- package/dist/auth/OAuthClient.js.map +1 -0
- package/dist/auth/OAuthToken.d.ts +9 -0
- package/dist/auth/OAuthToken.js +15 -0
- package/dist/auth/OAuthToken.js.map +1 -0
- package/dist/auth/PKCEHelper.d.ts +7 -0
- package/dist/auth/PKCEHelper.js +58 -0
- package/dist/auth/PKCEHelper.js.map +1 -0
- package/dist/examples/documentDraftSend.d.ts +1 -0
- package/dist/examples/documentDraftSend.js +27 -0
- package/dist/examples/documentDraftSend.js.map +1 -0
- package/dist/examples/documentEdit.d.ts +1 -0
- package/dist/examples/documentEdit.js +86 -0
- package/dist/examples/documentEdit.js.map +1 -0
- package/dist/examples/documentSend.js +4 -0
- package/dist/examples/documentSend.js.map +1 -1
- package/dist/examples/oAuthAuthorizationFlow.d.ts +1 -0
- package/dist/examples/oAuthAuthorizationFlow.js +49 -0
- package/dist/examples/oAuthAuthorizationFlow.js.map +1 -0
- package/dist/examples/oAuthClientCredentialFlow.d.ts +1 -0
- package/dist/examples/oAuthClientCredentialFlow.js +42 -0
- package/dist/examples/oAuthClientCredentialFlow.js.map +1 -0
- package/dist/examples/senderIdentityProperties.d.ts +1 -0
- package/dist/examples/senderIdentityProperties.js +27 -0
- package/dist/examples/senderIdentityProperties.js.map +1 -0
- package/dist/examples/templateCreate.js +15 -0
- package/dist/examples/templateCreate.js.map +1 -1
- package/dist/examples/templateEdit.js +5 -0
- package/dist/examples/templateEdit.js.map +1 -1
- package/dist/examples/userChangeTeam.d.ts +1 -0
- package/dist/examples/userChangeTeam.js +30 -0
- package/dist/examples/userChangeTeam.js.map +1 -0
- package/dist/model/authenticationSettings.d.ts +1 -2
- package/dist/model/authenticationSettings.js +0 -1
- package/dist/model/authenticationSettings.js.map +1 -1
- package/dist/model/changeTeamRequest.d.ts +15 -0
- package/dist/model/changeTeamRequest.js +23 -0
- package/dist/model/changeTeamRequest.js.map +1 -0
- package/dist/model/createTemplateRequest.d.ts +2 -0
- package/dist/model/createTemplateRequest.js +5 -0
- package/dist/model/createTemplateRequest.js.map +1 -1
- package/dist/model/customFormField.d.ts +1 -2
- package/dist/model/customFormField.js +0 -1
- package/dist/model/customFormField.js.map +1 -1
- package/dist/model/documentCcWebhookModel.d.ts +14 -0
- package/dist/model/documentCcWebhookModel.js +18 -0
- package/dist/model/documentCcWebhookModel.js.map +1 -0
- package/dist/model/documentEdited.d.ts +20 -0
- package/dist/model/documentEdited.js +25 -0
- package/dist/model/documentEdited.js.map +1 -0
- package/dist/model/documentEvent.d.ts +56 -0
- package/dist/model/documentEvent.js +141 -0
- package/dist/model/documentEvent.js.map +1 -0
- package/dist/model/documentExpirySettings.d.ts +1 -2
- package/dist/model/documentExpirySettings.js +0 -1
- package/dist/model/documentExpirySettings.js.map +1 -1
- package/dist/model/documentFiles.d.ts +2 -0
- package/dist/model/documentFiles.js +10 -0
- package/dist/model/documentFiles.js.map +1 -1
- package/dist/model/documentFormFields.d.ts +2 -2
- package/dist/model/documentFormFields.js +5 -1
- package/dist/model/documentFormFields.js.map +1 -1
- package/dist/model/documentInfo.d.ts +10 -2
- package/dist/model/documentInfo.js +8 -0
- package/dist/model/documentInfo.js.map +1 -1
- package/dist/model/documentSender.d.ts +17 -0
- package/dist/model/documentSender.js +33 -0
- package/dist/model/documentSender.js.map +1 -0
- package/dist/model/documentSigner.d.ts +10 -2
- package/dist/model/documentSigner.js +8 -0
- package/dist/model/documentSigner.js.map +1 -1
- package/dist/model/documentSignerDetails.d.ts +10 -2
- package/dist/model/documentSignerDetails.js +8 -0
- package/dist/model/documentSignerDetails.js.map +1 -1
- package/dist/model/documentSignerWebhookModel.d.ts +48 -0
- package/dist/model/documentSignerWebhookModel.js +134 -0
- package/dist/model/documentSignerWebhookModel.js.map +1 -0
- package/dist/model/editDocumentFile.d.ts +25 -0
- package/dist/model/editDocumentFile.js +41 -0
- package/dist/model/editDocumentFile.js.map +1 -0
- package/dist/model/editDocumentJsonRequest.d.ts +62 -0
- package/dist/model/editDocumentJsonRequest.js +163 -0
- package/dist/model/editDocumentJsonRequest.js.map +1 -0
- package/dist/model/editDocumentRequest.d.ts +64 -0
- package/dist/model/editDocumentRequest.js +168 -0
- package/dist/model/editDocumentRequest.js.map +1 -0
- package/dist/model/editDocumentSigner.d.ts +107 -0
- package/dist/model/editDocumentSigner.js +200 -0
- package/dist/model/editDocumentSigner.js.map +1 -0
- package/dist/model/editFormField.d.ts +121 -0
- package/dist/model/editFormField.js +294 -0
- package/dist/model/editFormField.js.map +1 -0
- package/dist/model/editTemplateRequest.d.ts +2 -0
- package/dist/model/editTemplateRequest.js +5 -0
- package/dist/model/editTemplateRequest.js.map +1 -1
- package/dist/model/embeddedCreateTemplateRequest.d.ts +7 -1
- package/dist/model/embeddedCreateTemplateRequest.js +9 -0
- package/dist/model/embeddedCreateTemplateRequest.js.map +1 -1
- package/dist/model/embeddedDocumentRequest.d.ts +7 -5
- package/dist/model/embeddedDocumentRequest.js +4 -2
- package/dist/model/embeddedDocumentRequest.js.map +1 -1
- package/dist/model/embeddedMergeTemplateFormRequest.d.ts +7 -5
- package/dist/model/embeddedMergeTemplateFormRequest.js +4 -2
- package/dist/model/embeddedMergeTemplateFormRequest.js.map +1 -1
- package/dist/model/embeddedSendTemplateFormRequest.d.ts +7 -5
- package/dist/model/embeddedSendTemplateFormRequest.js +4 -2
- package/dist/model/embeddedSendTemplateFormRequest.js.map +1 -1
- package/dist/model/embeddedTemplateEditRequest.d.ts +5 -1
- package/dist/model/embeddedTemplateEditRequest.js +4 -0
- package/dist/model/embeddedTemplateEditRequest.js.map +1 -1
- package/dist/model/font.d.ts +2 -4
- package/dist/model/font.js +0 -2
- package/dist/model/font.js.map +1 -1
- package/dist/model/formField.d.ts +1 -2
- package/dist/model/formField.js +0 -1
- package/dist/model/formField.js.map +1 -1
- package/dist/model/formFieldPermission.d.ts +16 -0
- package/dist/model/formFieldPermission.js +28 -0
- package/dist/model/formFieldPermission.js.map +1 -0
- package/dist/model/iWebhookData.d.ts +14 -0
- package/dist/model/iWebhookData.js +18 -0
- package/dist/model/iWebhookData.js.map +1 -0
- package/dist/model/identityVerificationEvent.d.ts +33 -0
- package/dist/model/identityVerificationEvent.js +60 -0
- package/dist/model/identityVerificationEvent.js.map +1 -0
- package/dist/model/identityVerificationSettings.d.ts +2 -4
- package/dist/model/identityVerificationSettings.js +0 -2
- package/dist/model/identityVerificationSettings.js.map +1 -1
- package/dist/model/index.d.ts +25 -1
- package/dist/model/index.js +103 -3
- package/dist/model/index.js.map +1 -1
- package/dist/model/mergeAndSendForSignForm.d.ts +2 -4
- package/dist/model/mergeAndSendForSignForm.js +0 -2
- package/dist/model/mergeAndSendForSignForm.js.map +1 -1
- package/dist/model/phoneNumberWebhookModel.d.ts +15 -0
- package/dist/model/phoneNumberWebhookModel.js +23 -0
- package/dist/model/phoneNumberWebhookModel.js.map +1 -0
- package/dist/model/role.d.ts +11 -4
- package/dist/model/role.js +8 -1
- package/dist/model/role.js.map +1 -1
- package/dist/model/roles.d.ts +10 -2
- package/dist/model/roles.js +8 -0
- package/dist/model/roles.js.map +1 -1
- package/dist/model/sendForSign.d.ts +2 -4
- package/dist/model/sendForSign.js +0 -2
- package/dist/model/sendForSign.js.map +1 -1
- package/dist/model/sendForSignFromTemplateForm.d.ts +2 -4
- package/dist/model/sendForSignFromTemplateForm.js +0 -2
- package/dist/model/sendForSignFromTemplateForm.js.map +1 -1
- package/dist/model/senderIdentityCreator.d.ts +17 -0
- package/dist/model/senderIdentityCreator.js +33 -0
- package/dist/model/senderIdentityCreator.js.map +1 -0
- package/dist/model/senderIdentityEvent.d.ts +28 -0
- package/dist/model/senderIdentityEvent.js +73 -0
- package/dist/model/senderIdentityEvent.js.map +1 -0
- package/dist/model/senderIdentityViewModel.d.ts +1 -0
- package/dist/model/senderIdentityViewModel.js +5 -0
- package/dist/model/senderIdentityViewModel.js.map +1 -1
- package/dist/model/templateCcWebhookModel.d.ts +15 -0
- package/dist/model/templateCcWebhookModel.js +23 -0
- package/dist/model/templateCcWebhookModel.js.map +1 -0
- package/dist/model/templateEvent.d.ts +48 -0
- package/dist/model/templateEvent.js +133 -0
- package/dist/model/templateEvent.js.map +1 -0
- package/dist/model/templateFiles.d.ts +17 -0
- package/dist/model/templateFiles.js +33 -0
- package/dist/model/templateFiles.js.map +1 -0
- package/dist/model/templateFormFields.d.ts +1 -2
- package/dist/model/templateFormFields.js +0 -1
- package/dist/model/templateFormFields.js.map +1 -1
- package/dist/model/templateProperties.d.ts +4 -2
- package/dist/model/templateProperties.js +6 -1
- package/dist/model/templateProperties.js.map +1 -1
- package/dist/model/templateRole.d.ts +10 -2
- package/dist/model/templateRole.js +8 -0
- package/dist/model/templateRole.js.map +1 -1
- package/dist/model/templateSender.d.ts +17 -0
- package/dist/model/templateSender.js +33 -0
- package/dist/model/templateSender.js.map +1 -0
- package/dist/model/templateSigner.d.ts +39 -0
- package/dist/model/templateSigner.js +99 -0
- package/dist/model/templateSigner.js.map +1 -0
- package/dist/model/textTagDefinition.d.ts +1 -2
- package/dist/model/textTagDefinition.js +0 -1
- package/dist/model/textTagDefinition.js.map +1 -1
- package/dist/model/viewBrandDetails.d.ts +1 -0
- package/dist/model/viewBrandDetails.js +5 -0
- package/dist/model/viewBrandDetails.js.map +1 -1
- package/dist/model/webhookEvent.d.ts +19 -0
- package/dist/model/webhookEvent.js +28 -0
- package/dist/model/webhookEvent.js.map +1 -0
- package/dist/model/webhookEventData.d.ts +75 -0
- package/dist/model/webhookEventData.js +229 -0
- package/dist/model/webhookEventData.js.map +1 -0
- package/dist/model/webhookEventMetadata.d.ts +55 -0
- package/dist/model/webhookEventMetadata.js +77 -0
- package/dist/model/webhookEventMetadata.js.map +1 -0
- package/dist/tests/integration/WebhookApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/WebhookApiTest.spec.js +218 -0
- package/dist/tests/integration/WebhookApiTest.spec.js.map +1 -0
- package/docs/BrandingApi.md +4 -2
- package/docs/ChangeTeamRequest.md +12 -0
- package/docs/CreateTemplateRequest.md +1 -0
- package/docs/DocumentApi.md +67 -0
- package/docs/DocumentCcWebhookModel.md +11 -0
- package/docs/DocumentEdited.md +11 -0
- package/docs/DocumentEvent.md +32 -0
- package/docs/DocumentFiles.md +2 -0
- package/docs/DocumentFormFields.md +1 -0
- package/docs/DocumentInfo.md +1 -1
- package/docs/DocumentSender.md +14 -0
- package/docs/DocumentSigner.md +1 -1
- package/docs/DocumentSignerDetails.md +1 -1
- package/docs/DocumentSignerWebhookModel.md +32 -0
- package/docs/EditDocumentFile.md +14 -0
- package/docs/EditDocumentJsonRequest.md +37 -0
- package/docs/EditDocumentRequest.md +38 -0
- package/docs/EditDocumentSigner.md +33 -0
- package/docs/EditFormField.md +53 -0
- package/docs/EditTemplateRequest.md +1 -0
- package/docs/EmbeddedCreateTemplateRequest.md +1 -0
- package/docs/FormFieldPermission.md +13 -0
- package/docs/IWebhookData.md +11 -0
- package/docs/IdentityVerificationEvent.md +17 -0
- package/docs/PhoneNumberWebhookModel.md +12 -0
- package/docs/Role.md +1 -1
- package/docs/Roles.md +1 -1
- package/docs/SenderIdentitiesApi.md +34 -0
- package/docs/SenderIdentityCreator.md +14 -0
- package/docs/SenderIdentityEvent.md +22 -0
- package/docs/SenderIdentityViewModel.md +1 -0
- package/docs/TemplateApi.md +2 -1
- package/docs/TemplateCcWebhookModel.md +12 -0
- package/docs/TemplateEvent.md +31 -0
- package/docs/TemplateFiles.md +14 -0
- package/docs/TemplateProperties.md +2 -1
- package/docs/TemplateRole.md +1 -1
- package/docs/TemplateSender.md +14 -0
- package/docs/TemplateSigner.md +25 -0
- package/docs/UserApi.md +34 -0
- package/docs/ViewBrandDetails.md +1 -0
- package/docs/WebhookEvent.md +13 -0
- package/docs/WebhookEventData.md +49 -0
- package/docs/WebhookEventMetadata.md +15 -0
- package/examples/documentDraftSend.ts +16 -0
- package/examples/documentEdit.ts +43 -0
- package/examples/documentSend.ts +4 -0
- package/examples/oAuthAuthorizationFlow.ts +45 -0
- package/examples/oAuthClientCredentialFlow.ts +34 -0
- package/examples/senderIdentityProperties.ts +15 -0
- package/examples/templateCreate.ts +19 -1
- package/examples/templateEdit.ts +7 -1
- package/examples/userChangeTeam.ts +15 -0
- package/model/authenticationSettings.ts +1 -2
- package/model/changeTeamRequest.ts +37 -0
- package/model/createTemplateRequest.ts +7 -0
- package/model/customFormField.ts +1 -2
- package/model/documentCcWebhookModel.ts +31 -0
- package/model/documentEdited.ts +37 -0
- package/model/documentEvent.ts +176 -0
- package/model/documentExpirySettings.ts +1 -2
- package/model/documentFiles.ts +12 -0
- package/model/documentFormFields.ts +7 -2
- package/model/documentInfo.ts +11 -3
- package/model/documentSender.ts +49 -0
- package/model/documentSigner.ts +11 -3
- package/model/documentSignerDetails.ts +11 -3
- package/model/documentSignerWebhookModel.ts +170 -0
- package/model/editDocumentFile.ts +56 -0
- package/model/editDocumentJsonRequest.ts +207 -0
- package/model/editDocumentRequest.ts +214 -0
- package/model/editDocumentSigner.ts +234 -0
- package/model/editFormField.ts +348 -0
- package/model/editTemplateRequest.ts +7 -0
- package/model/embeddedCreateTemplateRequest.ts +12 -1
- package/model/embeddedDocumentRequest.ts +7 -5
- package/model/embeddedMergeTemplateFormRequest.ts +7 -5
- package/model/embeddedSendTemplateFormRequest.ts +7 -5
- package/model/embeddedTemplateEditRequest.ts +5 -1
- package/model/font.ts +2 -4
- package/model/formField.ts +1 -2
- package/model/formFieldPermission.ts +43 -0
- package/model/iWebhookData.ts +31 -0
- package/model/identityVerificationEvent.ts +80 -0
- package/model/identityVerificationSettings.ts +2 -4
- package/model/index.ts +99 -0
- package/model/mergeAndSendForSignForm.ts +2 -4
- package/model/phoneNumberWebhookModel.ts +37 -0
- package/model/role.ts +12 -5
- package/model/roles.ts +11 -3
- package/model/sendForSign.ts +2 -4
- package/model/sendForSignFromTemplateForm.ts +2 -4
- package/model/senderIdentityCreator.ts +49 -0
- package/model/senderIdentityEvent.ts +98 -0
- package/model/senderIdentityViewModel.ts +6 -0
- package/model/templateCcWebhookModel.ts +37 -0
- package/model/templateEvent.ts +165 -0
- package/model/templateFiles.ts +49 -0
- package/model/templateFormFields.ts +1 -2
- package/model/templateProperties.ts +10 -3
- package/model/templateRole.ts +11 -3
- package/model/templateSender.ts +49 -0
- package/model/templateSigner.ts +126 -0
- package/model/textTagDefinition.ts +1 -2
- package/model/viewBrandDetails.ts +6 -0
- package/model/webhookEvent.ts +46 -0
- package/model/webhookEventData.ts +284 -0
- package/model/webhookEventMetadata.ts +92 -0
- package/package.json +1 -1
- package/tests/documents/document_event.json +109 -0
- package/tests/documents/identity_event.json +56 -0
- package/tests/documents/sender_event.json +23 -0
- package/tests/documents/template_event.json +55 -0
- package/tests/integration/WebhookApiTest.spec.ts +187 -0
- package/boldsign-1.0.4.tgz +0 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -32,6 +32,7 @@ model/brandCustomFieldDetails.ts
|
|
|
32
32
|
model/brandingMessage.ts
|
|
33
33
|
model/brandingRecords.ts
|
|
34
34
|
model/changeRecipient.ts
|
|
35
|
+
model/changeTeamRequest.ts
|
|
35
36
|
model/collaborationSettings.ts
|
|
36
37
|
model/conditionalRule.ts
|
|
37
38
|
model/contactCreated.ts
|
|
@@ -52,7 +53,10 @@ model/deleteCustomFieldReply.ts
|
|
|
52
53
|
model/document.ts
|
|
53
54
|
model/documentCC.ts
|
|
54
55
|
model/documentCcDetails.ts
|
|
56
|
+
model/documentCcWebhookModel.ts
|
|
55
57
|
model/documentCreated.ts
|
|
58
|
+
model/documentEdited.ts
|
|
59
|
+
model/documentEvent.ts
|
|
56
60
|
model/documentExpirySettings.ts
|
|
57
61
|
model/documentFiles.ts
|
|
58
62
|
model/documentFormFields.ts
|
|
@@ -60,11 +64,17 @@ model/documentInfo.ts
|
|
|
60
64
|
model/documentProperties.ts
|
|
61
65
|
model/documentReassign.ts
|
|
62
66
|
model/documentRecords.ts
|
|
67
|
+
model/documentSender.ts
|
|
63
68
|
model/documentSenderDetail.ts
|
|
64
69
|
model/documentSigner.ts
|
|
65
70
|
model/documentSignerDetails.ts
|
|
71
|
+
model/documentSignerWebhookModel.ts
|
|
66
72
|
model/documentTags.ts
|
|
67
73
|
model/downloadImageRequest.ts
|
|
74
|
+
model/editDocumentFile.ts
|
|
75
|
+
model/editDocumentRequest.ts
|
|
76
|
+
model/editDocumentSigner.ts
|
|
77
|
+
model/editFormField.ts
|
|
68
78
|
model/editSenderIdentityRequest.ts
|
|
69
79
|
model/editTemplateRequest.ts
|
|
70
80
|
model/editableDateFieldSettings.ts
|
|
@@ -86,11 +96,14 @@ model/extendExpiry.ts
|
|
|
86
96
|
model/fileInfo.ts
|
|
87
97
|
model/font.ts
|
|
88
98
|
model/formField.ts
|
|
99
|
+
model/formFieldPermission.ts
|
|
89
100
|
model/formGroup.ts
|
|
90
101
|
model/formulaFieldSettings.ts
|
|
102
|
+
model/iWebhookData.ts
|
|
91
103
|
model/idDocument.ts
|
|
92
104
|
model/idReport.ts
|
|
93
105
|
model/idVerification.ts
|
|
106
|
+
model/identityVerificationEvent.ts
|
|
94
107
|
model/identityVerificationSettings.ts
|
|
95
108
|
model/imageInfo.ts
|
|
96
109
|
model/index.ts
|
|
@@ -102,6 +115,7 @@ model/modificationDetails.ts
|
|
|
102
115
|
model/notificationSettings.ts
|
|
103
116
|
model/pageDetails.ts
|
|
104
117
|
model/phoneNumber.ts
|
|
118
|
+
model/phoneNumberWebhookModel.ts
|
|
105
119
|
model/prefillField.ts
|
|
106
120
|
model/prefillFieldRequest.ts
|
|
107
121
|
model/recipientChangeLog.ts
|
|
@@ -117,6 +131,8 @@ model/roles.ts
|
|
|
117
131
|
model/sendForSign.ts
|
|
118
132
|
model/sendForSignFromTemplateForm.ts
|
|
119
133
|
model/senderIdentityCreated.ts
|
|
134
|
+
model/senderIdentityCreator.ts
|
|
135
|
+
model/senderIdentityEvent.ts
|
|
120
136
|
model/senderIdentityList.ts
|
|
121
137
|
model/senderIdentityViewModel.ts
|
|
122
138
|
model/signerAuthenticationSettings.ts
|
|
@@ -131,14 +147,19 @@ model/teamUsers.ts
|
|
|
131
147
|
model/teams.ts
|
|
132
148
|
model/template.ts
|
|
133
149
|
model/templateCC.ts
|
|
150
|
+
model/templateCcWebhookModel.ts
|
|
134
151
|
model/templateCreated.ts
|
|
152
|
+
model/templateEvent.ts
|
|
153
|
+
model/templateFiles.ts
|
|
135
154
|
model/templateFormFields.ts
|
|
136
155
|
model/templateProperties.ts
|
|
137
156
|
model/templateRecords.ts
|
|
138
157
|
model/templateRole.ts
|
|
158
|
+
model/templateSender.ts
|
|
139
159
|
model/templateSenderDetail.ts
|
|
140
160
|
model/templateSenderDetails.ts
|
|
141
161
|
model/templateSharedTemplateDetail.ts
|
|
162
|
+
model/templateSigner.ts
|
|
142
163
|
model/templateSignerDetails.ts
|
|
143
164
|
model/templateTag.ts
|
|
144
165
|
model/textTagDefinition.ts
|
|
@@ -153,5 +174,8 @@ model/validation.ts
|
|
|
153
174
|
model/verificationDataRequest.ts
|
|
154
175
|
model/viewBrandDetails.ts
|
|
155
176
|
model/viewCustomFieldDetails.ts
|
|
177
|
+
model/webhookEvent.ts
|
|
178
|
+
model/webhookEventData.ts
|
|
179
|
+
model/webhookEventMetadata.ts
|
|
156
180
|
package.json
|
|
157
181
|
tsconfig.json
|
package/README.md
CHANGED
|
@@ -93,6 +93,8 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
93
93
|
| *DocumentApi* | [**downloadAttachment**](./docs/DocumentApi.md#downloadattachment) | **GET** /v1/document/downloadAttachment | Download the Attachment. |
|
|
94
94
|
| *DocumentApi* | [**downloadAuditLog**](./docs/DocumentApi.md#downloadauditlog) | **GET** /v1/document/downloadAuditLog | Download the audit trail document. |
|
|
95
95
|
| *DocumentApi* | [**downloadDocument**](./docs/DocumentApi.md#downloaddocument) | **GET** /v1/document/download | Download the document. |
|
|
96
|
+
| *DocumentApi* | [**draftSend**](./docs/DocumentApi.md#draftsend) | **POST** /v1-beta/document/draftSend | Sends a draft-status document out for signature. |
|
|
97
|
+
| *DocumentApi* | [**editDocument**](./docs/DocumentApi.md#editdocument) | **PUT** /v1-beta/document/edit | Edit and updates an existing document. |
|
|
96
98
|
| *DocumentApi* | [**extendExpiry**](./docs/DocumentApi.md#extendexpiry) | **PATCH** /v1/document/extendExpiry | Extends the expiration date of the document. |
|
|
97
99
|
| *DocumentApi* | [**getProperties**](./docs/DocumentApi.md#getproperties) | **GET** /v1/document/properties | Get summary of the document. |
|
|
98
100
|
| *DocumentApi* | [**getEmbeddedSignLink**](./docs/DocumentApi.md#getembeddedsignlink) | **GET** /v1/document/getEmbeddedSignLink | Get sign link for Embedded Sign. |
|
|
@@ -109,6 +111,7 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
109
111
|
| *PlanApi* | [**apiCreditsCount**](./docs/PlanApi.md#apicreditscount) | **GET** /v1/plan/apiCreditsCount | Gets the Api credits details. |
|
|
110
112
|
| *SenderIdentitiesApi* | [**createSenderIdentities**](./docs/SenderIdentitiesApi.md#createsenderidentities) | **POST** /v1/senderIdentities/create | Creates sender identity. |
|
|
111
113
|
| *SenderIdentitiesApi* | [**deleteSenderIdentities**](./docs/SenderIdentitiesApi.md#deletesenderidentities) | **DELETE** /v1/senderIdentities/delete | Deletes sender identity. |
|
|
114
|
+
| *SenderIdentitiesApi* | [**getSenderIdentityProperties**](./docs/SenderIdentitiesApi.md#getsenderidentityproperties) | **GET** /v1/senderIdentities/properties | Gets sender identity by ID or email. |
|
|
112
115
|
| *SenderIdentitiesApi* | [**listSenderIdentities**](./docs/SenderIdentitiesApi.md#listsenderidentities) | **GET** /v1/senderIdentities/list | Lists sender identity. |
|
|
113
116
|
| *SenderIdentitiesApi* | [**reRequestSenderIdentities**](./docs/SenderIdentitiesApi.md#rerequestsenderidentities) | **POST** /v1/senderIdentities/rerequest | Rerequests denied sender identity. |
|
|
114
117
|
| *SenderIdentitiesApi* | [**resendInvitationSenderIdentities**](./docs/SenderIdentitiesApi.md#resendinvitationsenderidentities) | **POST** /v1/senderIdentities/resendInvitation | Resends sender identity invitation. |
|
|
@@ -132,6 +135,7 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
132
135
|
| *TemplateApi* | [**mergeCreateEmbeddedRequestUrlTemplate**](./docs/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. |
|
|
133
136
|
| *TemplateApi* | [**sendUsingTemplate**](./docs/TemplateApi.md#sendusingtemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
|
|
134
137
|
| *UserApi* | [**cancelInvitation**](./docs/UserApi.md#cancelinvitation) | **POST** /v1/users/cancelInvitation | Cancel the users invitation. |
|
|
138
|
+
| *UserApi* | [**changeTeam**](./docs/UserApi.md#changeteam) | **PUT** /v1-beta/users/changeTeam | Change users to other team. |
|
|
135
139
|
| *UserApi* | [**createUser**](./docs/UserApi.md#createuser) | **POST** /v1/users/create | Create the user. |
|
|
136
140
|
| *UserApi* | [**getUser**](./docs/UserApi.md#getuser) | **GET** /v1/users/get | Get summary of the user. |
|
|
137
141
|
| *UserApi* | [**listUsers**](./docs/UserApi.md#listusers) | **GET** /v1/users/list | List user documents. |
|
|
@@ -158,6 +162,7 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
158
162
|
- [BrandingMessage](./docs/BrandingMessage.md)
|
|
159
163
|
- [BrandingRecords](./docs/BrandingRecords.md)
|
|
160
164
|
- [ChangeRecipient](./docs/ChangeRecipient.md)
|
|
165
|
+
- [ChangeTeamRequest](./docs/ChangeTeamRequest.md)
|
|
161
166
|
- [CollaborationSettings](./docs/CollaborationSettings.md)
|
|
162
167
|
- [ConditionalRule](./docs/ConditionalRule.md)
|
|
163
168
|
- [ContactCreated](./docs/ContactCreated.md)
|
|
@@ -178,7 +183,10 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
178
183
|
- [Document](./docs/Document.md)
|
|
179
184
|
- [DocumentCC](./docs/DocumentCC.md)
|
|
180
185
|
- [DocumentCcDetails](./docs/DocumentCcDetails.md)
|
|
186
|
+
- [DocumentCcWebhookModel](./docs/DocumentCcWebhookModel.md)
|
|
181
187
|
- [DocumentCreated](./docs/DocumentCreated.md)
|
|
188
|
+
- [DocumentEdited](./docs/DocumentEdited.md)
|
|
189
|
+
- [DocumentEvent](./docs/DocumentEvent.md)
|
|
182
190
|
- [DocumentExpirySettings](./docs/DocumentExpirySettings.md)
|
|
183
191
|
- [DocumentFiles](./docs/DocumentFiles.md)
|
|
184
192
|
- [DocumentFormFields](./docs/DocumentFormFields.md)
|
|
@@ -186,11 +194,17 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
186
194
|
- [DocumentProperties](./docs/DocumentProperties.md)
|
|
187
195
|
- [DocumentReassign](./docs/DocumentReassign.md)
|
|
188
196
|
- [DocumentRecords](./docs/DocumentRecords.md)
|
|
197
|
+
- [DocumentSender](./docs/DocumentSender.md)
|
|
189
198
|
- [DocumentSenderDetail](./docs/DocumentSenderDetail.md)
|
|
190
199
|
- [DocumentSigner](./docs/DocumentSigner.md)
|
|
191
200
|
- [DocumentSignerDetails](./docs/DocumentSignerDetails.md)
|
|
201
|
+
- [DocumentSignerWebhookModel](./docs/DocumentSignerWebhookModel.md)
|
|
192
202
|
- [DocumentTags](./docs/DocumentTags.md)
|
|
193
203
|
- [DownloadImageRequest](./docs/DownloadImageRequest.md)
|
|
204
|
+
- [EditDocumentFile](./docs/EditDocumentFile.md)
|
|
205
|
+
- [EditDocumentRequest](./docs/EditDocumentRequest.md)
|
|
206
|
+
- [EditDocumentSigner](./docs/EditDocumentSigner.md)
|
|
207
|
+
- [EditFormField](./docs/EditFormField.md)
|
|
194
208
|
- [EditSenderIdentityRequest](./docs/EditSenderIdentityRequest.md)
|
|
195
209
|
- [EditTemplateRequest](./docs/EditTemplateRequest.md)
|
|
196
210
|
- [EditableDateFieldSettings](./docs/EditableDateFieldSettings.md)
|
|
@@ -212,11 +226,14 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
212
226
|
- [FileInfo](./docs/FileInfo.md)
|
|
213
227
|
- [Font](./docs/Font.md)
|
|
214
228
|
- [FormField](./docs/FormField.md)
|
|
229
|
+
- [FormFieldPermission](./docs/FormFieldPermission.md)
|
|
215
230
|
- [FormGroup](./docs/FormGroup.md)
|
|
216
231
|
- [FormulaFieldSettings](./docs/FormulaFieldSettings.md)
|
|
232
|
+
- [IWebhookData](./docs/IWebhookData.md)
|
|
217
233
|
- [IdDocument](./docs/IdDocument.md)
|
|
218
234
|
- [IdReport](./docs/IdReport.md)
|
|
219
235
|
- [IdVerification](./docs/IdVerification.md)
|
|
236
|
+
- [IdentityVerificationEvent](./docs/IdentityVerificationEvent.md)
|
|
220
237
|
- [IdentityVerificationSettings](./docs/IdentityVerificationSettings.md)
|
|
221
238
|
- [ImageInfo](./docs/ImageInfo.md)
|
|
222
239
|
- [MergeAndSendForSignForm](./docs/MergeAndSendForSignForm.md)
|
|
@@ -226,6 +243,7 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
226
243
|
- [NotificationSettings](./docs/NotificationSettings.md)
|
|
227
244
|
- [PageDetails](./docs/PageDetails.md)
|
|
228
245
|
- [PhoneNumber](./docs/PhoneNumber.md)
|
|
246
|
+
- [PhoneNumberWebhookModel](./docs/PhoneNumberWebhookModel.md)
|
|
229
247
|
- [PrefillField](./docs/PrefillField.md)
|
|
230
248
|
- [PrefillFieldRequest](./docs/PrefillFieldRequest.md)
|
|
231
249
|
- [RecipientChangeLog](./docs/RecipientChangeLog.md)
|
|
@@ -241,6 +259,8 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
241
259
|
- [SendForSign](./docs/SendForSign.md)
|
|
242
260
|
- [SendForSignFromTemplateForm](./docs/SendForSignFromTemplateForm.md)
|
|
243
261
|
- [SenderIdentityCreated](./docs/SenderIdentityCreated.md)
|
|
262
|
+
- [SenderIdentityCreator](./docs/SenderIdentityCreator.md)
|
|
263
|
+
- [SenderIdentityEvent](./docs/SenderIdentityEvent.md)
|
|
244
264
|
- [SenderIdentityList](./docs/SenderIdentityList.md)
|
|
245
265
|
- [SenderIdentityViewModel](./docs/SenderIdentityViewModel.md)
|
|
246
266
|
- [SignerAuthenticationSettings](./docs/SignerAuthenticationSettings.md)
|
|
@@ -255,14 +275,19 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
255
275
|
- [Teams](./docs/Teams.md)
|
|
256
276
|
- [Template](./docs/Template.md)
|
|
257
277
|
- [TemplateCC](./docs/TemplateCC.md)
|
|
278
|
+
- [TemplateCcWebhookModel](./docs/TemplateCcWebhookModel.md)
|
|
258
279
|
- [TemplateCreated](./docs/TemplateCreated.md)
|
|
280
|
+
- [TemplateEvent](./docs/TemplateEvent.md)
|
|
281
|
+
- [TemplateFiles](./docs/TemplateFiles.md)
|
|
259
282
|
- [TemplateFormFields](./docs/TemplateFormFields.md)
|
|
260
283
|
- [TemplateProperties](./docs/TemplateProperties.md)
|
|
261
284
|
- [TemplateRecords](./docs/TemplateRecords.md)
|
|
262
285
|
- [TemplateRole](./docs/TemplateRole.md)
|
|
286
|
+
- [TemplateSender](./docs/TemplateSender.md)
|
|
263
287
|
- [TemplateSenderDetail](./docs/TemplateSenderDetail.md)
|
|
264
288
|
- [TemplateSenderDetails](./docs/TemplateSenderDetails.md)
|
|
265
289
|
- [TemplateSharedTemplateDetail](./docs/TemplateSharedTemplateDetail.md)
|
|
290
|
+
- [TemplateSigner](./docs/TemplateSigner.md)
|
|
266
291
|
- [TemplateSignerDetails](./docs/TemplateSignerDetails.md)
|
|
267
292
|
- [TemplateTag](./docs/TemplateTag.md)
|
|
268
293
|
- [TextTagDefinition](./docs/TextTagDefinition.md)
|
|
@@ -277,6 +302,9 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
277
302
|
- [VerificationDataRequest](./docs/VerificationDataRequest.md)
|
|
278
303
|
- [ViewBrandDetails](./docs/ViewBrandDetails.md)
|
|
279
304
|
- [ViewCustomFieldDetails](./docs/ViewCustomFieldDetails.md)
|
|
305
|
+
- [WebhookEvent](./docs/WebhookEvent.md)
|
|
306
|
+
- [WebhookEventData](./docs/WebhookEventData.md)
|
|
307
|
+
- [WebhookEventMetadata](./docs/WebhookEventMetadata.md)
|
|
280
308
|
|
|
281
309
|
## Authorization
|
|
282
310
|
|
package/api/apis.ts
CHANGED
|
@@ -24,7 +24,7 @@ export const queryParamsSerializer = (params) => {
|
|
|
24
24
|
return Qs.stringify(params, { arrayFormat: 'repeat' })
|
|
25
25
|
}
|
|
26
26
|
|
|
27
|
-
export const USER_AGENT = "boldsign-node-sdk/
|
|
27
|
+
export const USER_AGENT = "boldsign-node-sdk/2.0.0-beta.2";
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
30
|
* Generates an object containing form data.
|
|
@@ -92,6 +92,19 @@ export const generateFormData = (
|
|
|
92
92
|
return;
|
|
93
93
|
}
|
|
94
94
|
|
|
95
|
+
if (paramInfo.type.includes('Array') && paramInfo.type.includes('EditDocumentFile')) {
|
|
96
|
+
obj[paramInfo.name].forEach((childObject, i) => {
|
|
97
|
+
Object.entries(childObject).forEach(([property, value]) => {
|
|
98
|
+
const key = `${paramInfo.baseName}[${i}].${property}`;
|
|
99
|
+
if(property == "file"){
|
|
100
|
+
localVarUseFormData = true;
|
|
101
|
+
}
|
|
102
|
+
data[key] = value;
|
|
103
|
+
});
|
|
104
|
+
});
|
|
105
|
+
return;
|
|
106
|
+
}
|
|
107
|
+
|
|
95
108
|
if(paramInfo.type.indexOf("Array") !== -1) {
|
|
96
109
|
const serializedArray: string[] = [];
|
|
97
110
|
obj[paramInfo.name].forEach((childObject, i) => {
|
|
@@ -109,6 +122,18 @@ export const generateFormData = (
|
|
|
109
122
|
return;
|
|
110
123
|
}
|
|
111
124
|
|
|
125
|
+
// Special handling for dictionary/metadata objects with signature { [key: string]: string | null; }
|
|
126
|
+
if (paramInfo.type.includes("{ [key: string]:") && typeof obj[paramInfo.name] === "object" && obj[paramInfo.name] !== null) {
|
|
127
|
+
// For metadata objects, we need to send each key-value pair separately
|
|
128
|
+
Object.keys(obj[paramInfo.name]).forEach((key) => {
|
|
129
|
+
const value = obj[paramInfo.name][key];
|
|
130
|
+
if (value !== null && value !== undefined) {
|
|
131
|
+
data[`${paramInfo.baseName}[${key}]`] = value.toString();
|
|
132
|
+
}
|
|
133
|
+
});
|
|
134
|
+
return;
|
|
135
|
+
}
|
|
136
|
+
|
|
112
137
|
/**
|
|
113
138
|
* Everything else that is not binary data (file uploads) can be
|
|
114
139
|
* serialized to JSON and sent over. This helps reduce complexity
|
|
@@ -135,15 +160,31 @@ export const toFormData = (obj: object): any => {
|
|
|
135
160
|
const form = new formData();
|
|
136
161
|
|
|
137
162
|
Object.keys(obj).forEach((key) => {
|
|
138
|
-
if (
|
|
163
|
+
if (Array.isArray(obj[key])) {
|
|
164
|
+
obj[key].forEach(function (item, index) {
|
|
165
|
+
// Handle RequestDetailedFile objects in arrays
|
|
166
|
+
if (isBufferDetailedFile(item)) {
|
|
167
|
+
form.append(key, item.value, item.options);
|
|
168
|
+
}
|
|
169
|
+
// Handle ReadStream objects in arrays
|
|
170
|
+
else if (item && typeof item === 'object' && typeof item.pipe === 'function') {
|
|
171
|
+
form.append(key, item);
|
|
172
|
+
}
|
|
173
|
+
// Handle other values
|
|
174
|
+
else {
|
|
175
|
+
form.append(key, item);
|
|
176
|
+
}
|
|
177
|
+
});
|
|
178
|
+
}
|
|
179
|
+
else if (isBufferDetailedFile(obj[key])) {
|
|
139
180
|
form.append(key, obj[key].value, obj[key].options);
|
|
140
181
|
return;
|
|
141
182
|
}
|
|
142
|
-
else if (
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
183
|
+
else if (obj[key] && typeof obj[key] === 'object' && typeof obj[key].pipe === 'function') {
|
|
184
|
+
// Handle ReadStream objects
|
|
185
|
+
form.append(key, obj[key]);
|
|
186
|
+
}
|
|
187
|
+
else {
|
|
147
188
|
const value = (typeof obj[key] !== 'object') ? obj[key].toString(): obj[key];
|
|
148
189
|
form.append(key, value);
|
|
149
190
|
}
|
|
@@ -153,9 +194,13 @@ export const toFormData = (obj: object): any => {
|
|
|
153
194
|
};
|
|
154
195
|
|
|
155
196
|
function isBufferDetailedFile(obj: any): obj is RequestDetailedFile {
|
|
156
|
-
return
|
|
197
|
+
return obj !== null
|
|
198
|
+
&& obj !== undefined
|
|
199
|
+
&& typeof obj === 'object'
|
|
200
|
+
&& (<RequestDetailedFile>obj).value !== undefined
|
|
157
201
|
&& Buffer.isBuffer(obj.value)
|
|
158
202
|
&& (<RequestDetailedFile>obj).options !== undefined
|
|
203
|
+
&& typeof (<RequestDetailedFile>obj).options === 'object'
|
|
159
204
|
&& (<RequestDetailedFile>obj).options?.filename !== undefined
|
|
160
205
|
&& (<RequestDetailedFile>obj).options?.contentType !== undefined
|
|
161
206
|
}
|
package/api/brandingApi.ts
CHANGED
|
@@ -215,6 +215,7 @@ export class BrandingApi {
|
|
|
215
215
|
* @param isDefault
|
|
216
216
|
* @param canHideTagLine
|
|
217
217
|
* @param combineAuditTrail
|
|
218
|
+
* @param combineAttachments
|
|
218
219
|
* @param excludeAuditTrailFromEmail
|
|
219
220
|
* @param emailSignedDocument
|
|
220
221
|
* @param documentTimeZone
|
|
@@ -233,7 +234,7 @@ export class BrandingApi {
|
|
|
233
234
|
* @param customDomainSettingsFromName
|
|
234
235
|
* @param options
|
|
235
236
|
*/
|
|
236
|
-
public async createBrand (brandName: string, brandLogo: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
|
|
237
|
+
public async createBrand (brandName: string, brandLogo: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
|
|
237
238
|
const localVarPath = this.basePath + '/v1/brand/create';
|
|
238
239
|
let localVarQueryParameters: any = {};
|
|
239
240
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -310,6 +311,10 @@ export class BrandingApi {
|
|
|
310
311
|
localVarFormParams['CombineAuditTrail'] = ObjectSerializer.serialize(combineAuditTrail, "boolean");
|
|
311
312
|
}
|
|
312
313
|
|
|
314
|
+
if (combineAttachments !== undefined) {
|
|
315
|
+
localVarFormParams['CombineAttachments'] = ObjectSerializer.serialize(combineAttachments, "boolean");
|
|
316
|
+
}
|
|
317
|
+
|
|
313
318
|
if (excludeAuditTrailFromEmail !== undefined) {
|
|
314
319
|
localVarFormParams['ExcludeAuditTrailFromEmail'] = ObjectSerializer.serialize(excludeAuditTrailFromEmail, "boolean");
|
|
315
320
|
}
|
|
@@ -603,6 +608,7 @@ export class BrandingApi {
|
|
|
603
608
|
* @param isDefault
|
|
604
609
|
* @param canHideTagLine
|
|
605
610
|
* @param combineAuditTrail
|
|
611
|
+
* @param combineAttachments
|
|
606
612
|
* @param excludeAuditTrailFromEmail
|
|
607
613
|
* @param emailSignedDocument
|
|
608
614
|
* @param documentTimeZone
|
|
@@ -621,7 +627,7 @@ export class BrandingApi {
|
|
|
621
627
|
* @param customDomainSettingsFromName
|
|
622
628
|
* @param options
|
|
623
629
|
*/
|
|
624
|
-
public async editBrand (brandId: string, brandName?: string, brandLogo?: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
|
|
630
|
+
public async editBrand (brandId: string, brandName?: string, brandLogo?: RequestFile, backgroundColor?: string, buttonColor?: string, buttonTextColor?: string, emailDisplayName?: string, disclaimerDescription?: string, disclaimerTitle?: string, redirectUrl?: string, isDefault?: boolean, canHideTagLine?: boolean, combineAuditTrail?: boolean, combineAttachments?: boolean, excludeAuditTrailFromEmail?: boolean, emailSignedDocument?: string, documentTimeZone?: string, showBuiltInFormFields?: boolean, allowCustomFieldCreation?: boolean, showSharedCustomFields?: boolean, hideDecline?: boolean, hideSave?: boolean, documentExpirySettingsExpiryDateType?: string, documentExpirySettingsExpiryValue?: number, documentExpirySettingsEnableDefaultExpiryAlert?: boolean, documentExpirySettingsEnableAutoReminder?: boolean, documentExpirySettingsReminderDays?: number, documentExpirySettingsReminderCount?: number, customDomainSettingsDomainName?: string, customDomainSettingsFromName?: string, options: optionsI = {headers: {}}) : Promise<BrandCreated> {
|
|
625
631
|
const localVarPath = this.basePath + '/v1/brand/edit';
|
|
626
632
|
let localVarQueryParameters: any = {};
|
|
627
633
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -697,6 +703,10 @@ export class BrandingApi {
|
|
|
697
703
|
localVarFormParams['CombineAuditTrail'] = ObjectSerializer.serialize(combineAuditTrail, "boolean");
|
|
698
704
|
}
|
|
699
705
|
|
|
706
|
+
if (combineAttachments !== undefined) {
|
|
707
|
+
localVarFormParams['CombineAttachments'] = ObjectSerializer.serialize(combineAttachments, "boolean");
|
|
708
|
+
}
|
|
709
|
+
|
|
700
710
|
if (excludeAuditTrailFromEmail !== undefined) {
|
|
701
711
|
localVarFormParams['ExcludeAuditTrailFromEmail'] = ObjectSerializer.serialize(excludeAuditTrailFromEmail, "boolean");
|
|
702
712
|
}
|
package/api/documentApi.ts
CHANGED
|
@@ -15,7 +15,7 @@ import axios, { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
|
|
|
15
15
|
import {
|
|
16
16
|
ObjectSerializer, Authentication, VoidAuth, Interceptor,
|
|
17
17
|
HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth, RequestFile,
|
|
18
|
-
AccessCodeDetail,AccessCodeDetails,BehalfDocumentRecords,ChangeRecipient,DocumentCreated,DocumentProperties,DocumentRecords,DocumentTags,EmbeddedDocumentRequest,EmbeddedSendCreated,EmbeddedSigningLink,ErrorResult,ExtendExpiry,PrefillFieldRequest,ReminderMessage,RemoveAuthentication,RevokeDocument,SendForSign,TeamDocumentRecords,
|
|
18
|
+
AccessCodeDetail,AccessCodeDetails,BehalfDocumentRecords,ChangeRecipient,DocumentCreated,DocumentEdited,DocumentProperties,DocumentRecords,DocumentTags,EditDocumentRequest,EmbeddedDocumentRequest,EmbeddedSendCreated,EmbeddedSigningLink,ErrorResult,ExtendExpiry,PrefillFieldRequest,ReminderMessage,RemoveAuthentication,RevokeDocument,SendForSign,TeamDocumentRecords,
|
|
19
19
|
} from '../model';
|
|
20
20
|
|
|
21
21
|
import {
|
|
@@ -1498,6 +1498,262 @@ export class DocumentApi {
|
|
|
1498
1498
|
}
|
|
1499
1499
|
|
|
1500
1500
|
|
|
1501
|
+
reject(error);
|
|
1502
|
+
});
|
|
1503
|
+
});
|
|
1504
|
+
});
|
|
1505
|
+
}
|
|
1506
|
+
/**
|
|
1507
|
+
*
|
|
1508
|
+
* @summary Sends a draft-status document out for signature.
|
|
1509
|
+
* @param documentId The ID of the document to be sent.
|
|
1510
|
+
* @param options
|
|
1511
|
+
*/
|
|
1512
|
+
public async draftSend (documentId: string, options: optionsI = {headers: {}}) : Promise<returnTypeI> {
|
|
1513
|
+
const localVarPath = this.basePath + '/v1-beta/document/draftSend';
|
|
1514
|
+
let localVarQueryParameters: any = {};
|
|
1515
|
+
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
1516
|
+
const produces = ['application/json'];
|
|
1517
|
+
// give precedence to 'application/json'
|
|
1518
|
+
if (produces.indexOf('application/json') >= 0) {
|
|
1519
|
+
localVarHeaderParams['content-type'] = 'application/json';
|
|
1520
|
+
} else {
|
|
1521
|
+
localVarHeaderParams['content-type'] = produces.join(',');
|
|
1522
|
+
}
|
|
1523
|
+
let localVarFormParams: any = {};
|
|
1524
|
+
let localVarBodyParams: any = undefined;
|
|
1525
|
+
|
|
1526
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
1527
|
+
if (documentId === null || documentId === undefined) {
|
|
1528
|
+
throw new Error('Required parameter documentId was null or undefined when calling draftSend.');
|
|
1529
|
+
}
|
|
1530
|
+
|
|
1531
|
+
if (documentId !== undefined) {
|
|
1532
|
+
localVarQueryParameters['documentId'] = ObjectSerializer.serialize(documentId, "string");
|
|
1533
|
+
}
|
|
1534
|
+
|
|
1535
|
+
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
1536
|
+
|
|
1537
|
+
let localVarUseFormData = false;
|
|
1538
|
+
|
|
1539
|
+
let data = {};
|
|
1540
|
+
if (localVarUseFormData) {
|
|
1541
|
+
const formData = toFormData(localVarFormParams);
|
|
1542
|
+
data = formData;
|
|
1543
|
+
localVarHeaderParams = {
|
|
1544
|
+
...localVarHeaderParams,
|
|
1545
|
+
...formData.getHeaders(),
|
|
1546
|
+
};
|
|
1547
|
+
}
|
|
1548
|
+
|
|
1549
|
+
let localVarRequestOptions: AxiosRequestConfig = {
|
|
1550
|
+
method: 'POST',
|
|
1551
|
+
params: localVarQueryParameters,
|
|
1552
|
+
headers: localVarHeaderParams,
|
|
1553
|
+
url: localVarPath,
|
|
1554
|
+
paramsSerializer: this._useQuerystring ? queryParamsSerializer : undefined,
|
|
1555
|
+
maxContentLength: Infinity,
|
|
1556
|
+
maxBodyLength: Infinity,
|
|
1557
|
+
responseType: "json",
|
|
1558
|
+
};
|
|
1559
|
+
|
|
1560
|
+
if (localVarRequestOptions.method !== 'GET') {
|
|
1561
|
+
localVarRequestOptions.data = data;
|
|
1562
|
+
}
|
|
1563
|
+
let authenticationPromise = Promise.resolve();
|
|
1564
|
+
|
|
1565
|
+
if (this.authentications["X-API-KEY"].apiKey) {
|
|
1566
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
|
|
1567
|
+
}
|
|
1568
|
+
if (this.authentications["Bearer"].apiKey) {
|
|
1569
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
|
|
1570
|
+
}
|
|
1571
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
1572
|
+
|
|
1573
|
+
let interceptorPromise = authenticationPromise;
|
|
1574
|
+
for (const interceptor of this.interceptors) {
|
|
1575
|
+
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
1576
|
+
}
|
|
1577
|
+
|
|
1578
|
+
return interceptorPromise.then(() => {
|
|
1579
|
+
return new Promise<returnTypeI>((resolve, reject) => {
|
|
1580
|
+
axios.request(localVarRequestOptions)
|
|
1581
|
+
.then((response) => {
|
|
1582
|
+
handleSuccessfulResponse(
|
|
1583
|
+
resolve,
|
|
1584
|
+
reject,
|
|
1585
|
+
response,
|
|
1586
|
+
|
|
1587
|
+
);
|
|
1588
|
+
}, (error: AxiosError) => {
|
|
1589
|
+
if (error.response == null) {
|
|
1590
|
+
reject(error);
|
|
1591
|
+
return;
|
|
1592
|
+
}
|
|
1593
|
+
|
|
1594
|
+
if (handleErrorCodeResponse(
|
|
1595
|
+
reject,
|
|
1596
|
+
error.response,
|
|
1597
|
+
401,
|
|
1598
|
+
"ErrorResult",
|
|
1599
|
+
)) {
|
|
1600
|
+
return;
|
|
1601
|
+
}
|
|
1602
|
+
if (handleErrorCodeResponse(
|
|
1603
|
+
reject,
|
|
1604
|
+
error.response,
|
|
1605
|
+
403,
|
|
1606
|
+
"ErrorResult",
|
|
1607
|
+
)) {
|
|
1608
|
+
return;
|
|
1609
|
+
}
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
reject(error);
|
|
1613
|
+
});
|
|
1614
|
+
});
|
|
1615
|
+
});
|
|
1616
|
+
}
|
|
1617
|
+
/**
|
|
1618
|
+
*
|
|
1619
|
+
* @summary Edit and updates an existing document.
|
|
1620
|
+
* @param documentId Document Id.
|
|
1621
|
+
* @param editDocumentRequest Edit document JSON request.
|
|
1622
|
+
* @param options
|
|
1623
|
+
*/
|
|
1624
|
+
public async editDocument (documentId: string, editDocumentRequest?: EditDocumentRequest, options: optionsI = {headers: {}}) : Promise<DocumentEdited> {
|
|
1625
|
+
editDocumentRequest = deserializeIfNeeded(editDocumentRequest, "EditDocumentRequest");
|
|
1626
|
+
const localVarPath = this.basePath + '/v1-beta/document/edit';
|
|
1627
|
+
let localVarQueryParameters: any = {};
|
|
1628
|
+
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
1629
|
+
const produces = ['application/json'];
|
|
1630
|
+
// give precedence to 'application/json'
|
|
1631
|
+
if (produces.indexOf('application/json') >= 0) {
|
|
1632
|
+
localVarHeaderParams['content-type'] = 'application/json';
|
|
1633
|
+
} else {
|
|
1634
|
+
localVarHeaderParams['content-type'] = produces.join(',');
|
|
1635
|
+
}
|
|
1636
|
+
let localVarFormParams: any = {};
|
|
1637
|
+
let localVarBodyParams: any = undefined;
|
|
1638
|
+
|
|
1639
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
1640
|
+
if (documentId === null || documentId === undefined) {
|
|
1641
|
+
throw new Error('Required parameter documentId was null or undefined when calling editDocument.');
|
|
1642
|
+
}
|
|
1643
|
+
|
|
1644
|
+
if (documentId !== undefined) {
|
|
1645
|
+
localVarQueryParameters['documentId'] = ObjectSerializer.serialize(documentId, "string");
|
|
1646
|
+
}
|
|
1647
|
+
|
|
1648
|
+
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
1649
|
+
|
|
1650
|
+
let localVarUseFormData = false;
|
|
1651
|
+
|
|
1652
|
+
const result = generateFormData(editDocumentRequest, EditDocumentRequest);
|
|
1653
|
+
localVarUseFormData = result.localVarUseFormData;
|
|
1654
|
+
|
|
1655
|
+
let data = {};
|
|
1656
|
+
if (localVarUseFormData) {
|
|
1657
|
+
const formData = toFormData(result.data);
|
|
1658
|
+
data = formData;
|
|
1659
|
+
localVarHeaderParams = {
|
|
1660
|
+
...localVarHeaderParams,
|
|
1661
|
+
...formData.getHeaders(),
|
|
1662
|
+
};
|
|
1663
|
+
} else {
|
|
1664
|
+
data = ObjectSerializer.serialize(
|
|
1665
|
+
editDocumentRequest,
|
|
1666
|
+
"EditDocumentRequest"
|
|
1667
|
+
);
|
|
1668
|
+
}
|
|
1669
|
+
|
|
1670
|
+
let localVarRequestOptions: AxiosRequestConfig = {
|
|
1671
|
+
method: 'PUT',
|
|
1672
|
+
params: localVarQueryParameters,
|
|
1673
|
+
headers: localVarHeaderParams,
|
|
1674
|
+
url: localVarPath,
|
|
1675
|
+
paramsSerializer: this._useQuerystring ? queryParamsSerializer : undefined,
|
|
1676
|
+
maxContentLength: Infinity,
|
|
1677
|
+
maxBodyLength: Infinity,
|
|
1678
|
+
responseType: "json",
|
|
1679
|
+
};
|
|
1680
|
+
|
|
1681
|
+
if (localVarRequestOptions.method !== 'GET') {
|
|
1682
|
+
localVarRequestOptions.data = data;
|
|
1683
|
+
}
|
|
1684
|
+
let authenticationPromise = Promise.resolve();
|
|
1685
|
+
|
|
1686
|
+
if (this.authentications["X-API-KEY"].apiKey) {
|
|
1687
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications["X-API-KEY"].applyToRequest(localVarRequestOptions));
|
|
1688
|
+
}
|
|
1689
|
+
if (this.authentications["Bearer"].apiKey) {
|
|
1690
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications["Bearer"].applyToRequest(localVarRequestOptions));
|
|
1691
|
+
}
|
|
1692
|
+
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
1693
|
+
|
|
1694
|
+
let interceptorPromise = authenticationPromise;
|
|
1695
|
+
for (const interceptor of this.interceptors) {
|
|
1696
|
+
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
1697
|
+
}
|
|
1698
|
+
|
|
1699
|
+
return interceptorPromise.then(() => {
|
|
1700
|
+
return new Promise<DocumentEdited>((resolve, reject) => {
|
|
1701
|
+
axios.request(localVarRequestOptions)
|
|
1702
|
+
.then((response) => {
|
|
1703
|
+
handleSuccessfulResponse<DocumentEdited>(
|
|
1704
|
+
resolve,
|
|
1705
|
+
reject,
|
|
1706
|
+
response,
|
|
1707
|
+
"DocumentEdited",
|
|
1708
|
+
);
|
|
1709
|
+
}, (error: AxiosError) => {
|
|
1710
|
+
if (error.response == null) {
|
|
1711
|
+
reject(error);
|
|
1712
|
+
return;
|
|
1713
|
+
}
|
|
1714
|
+
|
|
1715
|
+
if (handleErrorCodeResponse(
|
|
1716
|
+
reject,
|
|
1717
|
+
error.response,
|
|
1718
|
+
200,
|
|
1719
|
+
"DocumentEdited",
|
|
1720
|
+
)) {
|
|
1721
|
+
return;
|
|
1722
|
+
}
|
|
1723
|
+
if (handleErrorCodeResponse(
|
|
1724
|
+
reject,
|
|
1725
|
+
error.response,
|
|
1726
|
+
401,
|
|
1727
|
+
"ErrorResult",
|
|
1728
|
+
)) {
|
|
1729
|
+
return;
|
|
1730
|
+
}
|
|
1731
|
+
if (handleErrorCodeResponse(
|
|
1732
|
+
reject,
|
|
1733
|
+
error.response,
|
|
1734
|
+
403,
|
|
1735
|
+
"ErrorResult",
|
|
1736
|
+
)) {
|
|
1737
|
+
return;
|
|
1738
|
+
}
|
|
1739
|
+
if (handleErrorCodeResponse(
|
|
1740
|
+
reject,
|
|
1741
|
+
error.response,
|
|
1742
|
+
400,
|
|
1743
|
+
"ErrorResult",
|
|
1744
|
+
)) {
|
|
1745
|
+
return;
|
|
1746
|
+
}
|
|
1747
|
+
if (handleErrorCodeResponse(
|
|
1748
|
+
reject,
|
|
1749
|
+
error.response,
|
|
1750
|
+
422,
|
|
1751
|
+
"ErrorResult",
|
|
1752
|
+
)) {
|
|
1753
|
+
return;
|
|
1754
|
+
}
|
|
1755
|
+
|
|
1756
|
+
|
|
1501
1757
|
reject(error);
|
|
1502
1758
|
});
|
|
1503
1759
|
});
|