boldsign 3.0.3 → 3.1.0-beta.1
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 +45 -1
- package/README.md +55 -3
- package/api/apis.ts +15 -2
- package/api/brandingApi.ts +2 -42
- package/api/documentApi.ts +408 -2
- package/api/groupContactsApi.ts +779 -0
- package/api/index.ts +3 -1
- package/api/templateApi.ts +143 -1
- package/api/userApi.ts +1 -1
- package/auth/OAuthClient.ts +137 -0
- package/auth/OAuthToken.ts +17 -0
- package/auth/PKCEHelper.ts +36 -0
- package/boldsign-3.1.0-beta.1.tgz +0 -0
- package/dist/api/apis.d.ts +1 -1
- package/dist/api/apis.js +13 -1
- package/dist/api/apis.js.map +1 -1
- package/dist/api/brandingApi.d.ts +2 -2
- package/dist/api/brandingApi.js +4 -28
- package/dist/api/brandingApi.js.map +1 -1
- package/dist/api/documentApi.d.ts +4 -1
- package/dist/api/documentApi.js +259 -1
- package/dist/api/documentApi.js.map +1 -1
- package/dist/api/groupContactsApi.d.ts +28 -0
- package/dist/api/groupContactsApi.js +507 -0
- package/dist/api/groupContactsApi.js.map +1 -0
- package/dist/api/index.d.ts +3 -2
- package/dist/api/index.js +4 -2
- package/dist/api/index.js.map +1 -1
- package/dist/api/templateApi.d.ts +2 -1
- package/dist/api/templateApi.js +90 -0
- package/dist/api/templateApi.js.map +1 -1
- package/dist/api/userApi.js +1 -1
- 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/TemplateShare.js +34 -0
- package/dist/examples/TemplateShare.js.map +1 -0
- package/dist/examples/contactGroupDelete.js +27 -0
- package/dist/examples/contactGroupDelete.js.map +1 -0
- package/dist/examples/contactGroupGet.js +27 -0
- package/dist/examples/contactGroupGet.js.map +1 -0
- package/dist/examples/contactGroupList.d.ts +1 -0
- package/dist/examples/contactGroupList.js +29 -0
- package/dist/examples/contactGroupList.js.map +1 -0
- package/dist/examples/contactGroupUpdate.d.ts +1 -0
- package/dist/examples/contactGroupUpdate.js +34 -0
- package/dist/examples/contactGroupUpdate.js.map +1 -0
- package/dist/examples/contactGroupsCreate.d.ts +1 -0
- package/dist/examples/contactGroupsCreate.js +35 -0
- package/dist/examples/contactGroupsCreate.js.map +1 -0
- package/dist/examples/documentCancelEditing.d.ts +1 -0
- package/dist/examples/{draftSend.js → documentCancelEditing.js} +6 -6
- package/dist/examples/documentCancelEditing.js.map +1 -0
- package/dist/examples/documentCreateEmbeddedEditUrl.d.ts +1 -0
- package/dist/examples/documentCreateEmbeddedEditUrl.js +32 -0
- package/dist/examples/documentCreateEmbeddedEditUrl.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/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.js +4 -4
- package/dist/examples/senderIdentityProperties.js.map +1 -1
- package/dist/examples/templateCreateEmbeddedPreviewUrl.d.ts +1 -0
- package/dist/examples/{embeddedCreatePreviewUrl.js → templateCreateEmbeddedPreviewUrl.js} +6 -5
- package/dist/examples/templateCreateEmbeddedPreviewUrl.js.map +1 -0
- package/dist/examples/templateDownload.js +1 -1
- package/dist/examples/templateDownload.js.map +1 -1
- package/dist/model/auditTrail.d.ts +0 -4
- package/dist/model/auditTrail.js +0 -20
- package/dist/model/auditTrail.js.map +1 -1
- package/dist/model/{signatureFrameSettings.d.ts → behalfOfWebhookModel.d.ts} +3 -5
- 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/{problemDetails.d.ts → createGroupContactResponse.d.ts} +3 -6
- package/dist/model/createGroupContactResponse.js +23 -0
- package/dist/model/createGroupContactResponse.js.map +1 -0
- package/dist/model/creators.d.ts +15 -0
- package/dist/model/creators.js +23 -0
- package/dist/model/creators.js.map +1 -0
- package/dist/model/document.d.ts +0 -2
- package/dist/model/document.js +0 -10
- package/dist/model/document.js.map +1 -1
- package/dist/model/documentCcWebhookModel.d.ts +15 -0
- package/dist/model/documentCcWebhookModel.js +23 -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 +66 -0
- package/dist/model/documentEvent.js +162 -0
- package/dist/model/documentEvent.js.map +1 -0
- package/dist/model/documentGroupSignerWebhookModel.d.ts +31 -0
- package/dist/model/documentGroupSignerWebhookModel.js +64 -0
- package/dist/model/documentGroupSignerWebhookModel.js.map +1 -0
- package/dist/model/documentProperties.d.ts +0 -2
- package/dist/model/documentProperties.js +0 -10
- package/dist/model/documentProperties.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/documentSignerWebhookModel.d.ts +53 -0
- package/dist/model/documentSignerWebhookModel.js +154 -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/editDocumentRequest.d.ts +72 -0
- package/dist/model/editDocumentRequest.js +184 -0
- package/dist/model/editDocumentRequest.js.map +1 -0
- package/dist/model/editDocumentSigner.d.ts +121 -0
- package/dist/model/editDocumentSigner.js +223 -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/embeddedDocumentEditJsonRequest.d.ts +51 -0
- package/dist/model/embeddedDocumentEditJsonRequest.js +97 -0
- package/dist/model/embeddedDocumentEditJsonRequest.js.map +1 -0
- package/dist/model/embeddedDocumentEdited.d.ts +14 -0
- package/dist/model/embeddedDocumentEdited.js +18 -0
- package/dist/model/embeddedDocumentEdited.js.map +1 -0
- package/dist/model/errorResponse.d.ts +15 -0
- package/dist/model/errorResponse.js +23 -0
- package/dist/model/errorResponse.js.map +1 -0
- 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/getGroupContactDetails.d.ts +20 -0
- package/dist/model/getGroupContactDetails.js +38 -0
- package/dist/model/getGroupContactDetails.js.map +1 -0
- package/dist/model/groupContact.d.ts +18 -0
- package/dist/model/groupContact.js +33 -0
- package/dist/model/groupContact.js.map +1 -0
- package/dist/model/groupContactDetails.d.ts +17 -0
- package/dist/model/groupContactDetails.js +28 -0
- package/dist/model/groupContactDetails.js.map +1 -0
- package/dist/model/groupContactsList.d.ts +17 -0
- package/dist/model/groupContactsList.js +23 -0
- package/dist/model/groupContactsList.js.map +1 -0
- package/dist/model/groupSignerSettingsWebhookModel.d.ts +15 -0
- package/dist/model/groupSignerSettingsWebhookModel.js +23 -0
- package/dist/model/groupSignerSettingsWebhookModel.js.map +1 -0
- package/dist/model/groupUser.d.ts +15 -0
- package/dist/model/groupUser.js +23 -0
- package/dist/model/groupUser.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/idVerificationSignerWebhookModel.d.ts +22 -0
- package/dist/model/idVerificationSignerWebhookModel.js +58 -0
- package/dist/model/idVerificationSignerWebhookModel.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/index.d.ts +45 -2
- package/dist/model/index.js +174 -7
- package/dist/model/index.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/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 +29 -0
- package/dist/model/senderIdentityEvent.js +78 -0
- package/dist/model/senderIdentityEvent.js.map +1 -0
- package/dist/model/signerAuthenticationWebhookModel.d.ts +15 -0
- package/dist/model/signerAuthenticationWebhookModel.js +23 -0
- package/dist/model/signerAuthenticationWebhookModel.js.map +1 -0
- package/dist/model/templateCcWebhookModel.d.ts +16 -0
- package/dist/model/templateCcWebhookModel.js +28 -0
- package/dist/model/templateCcWebhookModel.js.map +1 -0
- package/dist/model/templateEvent.d.ts +54 -0
- package/dist/model/templateEvent.js +148 -0
- package/dist/model/templateEvent.js.map +1 -0
- package/dist/model/templateGroupSignerWebhookModel.d.ts +15 -0
- package/dist/model/templateGroupSignerWebhookModel.js +23 -0
- package/dist/model/templateGroupSignerWebhookModel.js.map +1 -0
- 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/templateShareErrorResponse.d.ts +17 -0
- package/dist/model/templateShareErrorResponse.js +33 -0
- package/dist/model/templateShareErrorResponse.js.map +1 -0
- package/dist/model/templateShareRequest.d.ts +15 -0
- package/dist/model/templateShareRequest.js +18 -0
- package/dist/model/templateShareRequest.js.map +1 -0
- package/dist/model/templateSigner.d.ts +44 -0
- package/dist/model/templateSigner.js +119 -0
- package/dist/model/templateSigner.js.map +1 -0
- package/dist/model/templateSignerDetails.d.ts +0 -2
- package/dist/model/templateSignerDetails.js +0 -5
- package/dist/model/templateSignerDetails.js.map +1 -1
- package/dist/model/templateTeamShareRequest.d.ts +26 -0
- package/dist/model/templateTeamShareRequest.js +40 -0
- package/dist/model/templateTeamShareRequest.js.map +1 -0
- package/dist/model/updateGroupContact.d.ts +17 -0
- package/dist/model/updateGroupContact.js +28 -0
- package/dist/model/updateGroupContact.js.map +1 -0
- package/dist/model/viewBrandDetails.d.ts +0 -2
- package/dist/model/viewBrandDetails.js +0 -5
- package/dist/model/viewBrandDetails.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 +21 -0
- package/dist/model/webhookEvent.js +33 -0
- package/dist/model/webhookEvent.js.map +1 -0
- package/dist/model/webhookEventData.d.ts +88 -0
- package/dist/model/webhookEventData.js +260 -0
- package/dist/model/webhookEventData.js.map +1 -0
- package/dist/model/webhookEventMetadata.d.ts +56 -0
- package/dist/model/webhookEventMetadata.js +78 -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/AuditTrail.md +0 -4
- package/docs/{ProblemDetails.md → BehalfOfWebhookModel.md} +3 -6
- package/docs/BrandCreated.md +1 -0
- package/docs/BrandingApi.md +2 -10
- package/docs/CreateGroupContactResponse.md +12 -0
- package/docs/Creators.md +12 -0
- package/docs/Document.md +0 -2
- package/docs/DocumentApi.md +103 -1
- package/docs/DocumentCcWebhookModel.md +12 -0
- package/docs/DocumentEdited.md +11 -0
- package/docs/DocumentEvent.md +35 -0
- package/docs/DocumentGroupSignerWebhookModel.md +18 -0
- package/docs/DocumentProperties.md +0 -2
- package/docs/DocumentSender.md +14 -0
- package/docs/DocumentSignerWebhookModel.md +36 -0
- package/docs/EditDocumentFile.md +14 -0
- package/docs/EditDocumentRequest.md +40 -0
- package/docs/EditDocumentSigner.md +35 -0
- package/docs/EditFormField.md +53 -0
- package/docs/EmbeddedDocumentEditJsonRequest.md +19 -0
- package/docs/EmbeddedDocumentEdited.md +11 -0
- package/docs/ErrorResponse.md +12 -0
- package/docs/FormFieldPermissionWebhookModel.md +13 -0
- package/docs/GetGroupContactDetails.md +15 -0
- package/docs/GroupContact.md +14 -0
- package/docs/GroupContactDetails.md +13 -0
- package/docs/GroupContactsApi.md +177 -0
- package/docs/GroupContactsList.md +12 -0
- package/docs/GroupSignerSettingsWebhookModel.md +12 -0
- package/docs/GroupUser.md +12 -0
- package/docs/IWebhookData.md +11 -0
- package/docs/IdVerificationSignerWebhookModel.md +19 -0
- package/docs/IdentityVerificationEvent.md +17 -0
- package/docs/PhoneNumberWebhookModel.md +12 -0
- package/docs/SenderIdentityCreator.md +14 -0
- package/docs/SenderIdentityEvent.md +23 -0
- package/docs/SignerAuthenticationWebhookModel.md +12 -0
- package/docs/TemplateApi.md +34 -0
- package/docs/TemplateCcWebhookModel.md +13 -0
- package/docs/TemplateEvent.md +34 -0
- package/docs/TemplateGroupSignerWebhookModel.md +12 -0
- package/docs/TemplateSender.md +14 -0
- package/docs/TemplateShareErrorResponse.md +14 -0
- package/docs/TemplateShareRequest.md +11 -0
- package/docs/TemplateSigner.md +29 -0
- package/docs/TemplateSignerDetails.md +0 -1
- package/docs/TemplateTeamShareRequest.md +13 -0
- package/docs/UpdateGroupContact.md +13 -0
- package/docs/UserApi.md +1 -1
- package/docs/ViewBrandDetails.md +0 -1
- package/docs/WebhookActorDetails.md +12 -0
- package/docs/WebhookContext.md +13 -0
- package/docs/WebhookEvent.md +14 -0
- package/docs/WebhookEventData.md +54 -0
- package/docs/WebhookEventMetadata.md +15 -0
- package/examples/TemplateShare.ts +23 -0
- package/examples/contactGroupDelete.ts +14 -0
- package/examples/contactGroupGet.ts +14 -0
- package/examples/contactGroupList.ts +16 -0
- package/examples/contactGroupUpdate.ts +21 -0
- package/examples/contactGroupsCreate.ts +24 -0
- package/examples/{draftSend.ts → documentCancelEditing.ts} +7 -5
- package/examples/documentCreateEmbeddedEditUrl.ts +19 -0
- package/examples/documentDraftSend.ts +16 -0
- package/examples/documentEdit.ts +43 -0
- package/examples/oAuthAuthorizationFlow.ts +45 -0
- package/examples/oAuthClientCredentialFlow.ts +34 -0
- package/examples/senderIdentityProperties.ts +6 -6
- package/examples/templateCreateEmbeddedPreviewUrl.ts +17 -0
- package/examples/templateDownload.ts +1 -1
- package/model/auditTrail.ts +0 -24
- package/model/behalfOfWebhookModel.ts +37 -0
- package/model/brandCreated.ts +6 -0
- package/model/createGroupContactResponse.ts +37 -0
- package/model/creators.ts +37 -0
- package/model/document.ts +0 -12
- package/model/documentCcWebhookModel.ts +37 -0
- package/model/documentEdited.ts +37 -0
- package/model/documentEvent.ts +201 -0
- package/model/documentGroupSignerWebhookModel.ts +83 -0
- package/model/documentProperties.ts +0 -12
- package/model/{problemDetails.ts → documentSender.ts} +14 -20
- package/model/documentSignerWebhookModel.ts +195 -0
- package/model/editDocumentFile.ts +56 -0
- package/model/editDocumentRequest.ts +232 -0
- package/model/editDocumentSigner.ts +258 -0
- package/model/editFormField.ts +348 -0
- package/model/embeddedDocumentEditJsonRequest.ts +108 -0
- package/model/embeddedDocumentEdited.ts +31 -0
- package/model/errorResponse.ts +37 -0
- package/model/{signatureFrameSettings.ts → formFieldPermissionWebhookModel.ts} +11 -17
- package/model/getGroupContactDetails.ts +57 -0
- package/model/groupContact.ts +50 -0
- package/model/groupContactDetails.ts +44 -0
- package/model/groupContactsList.ts +39 -0
- package/model/groupSignerSettingsWebhookModel.ts +37 -0
- package/model/groupUser.ts +37 -0
- package/model/iWebhookData.ts +31 -0
- package/model/idVerificationSignerWebhookModel.ts +79 -0
- package/model/identityVerificationEvent.ts +80 -0
- package/model/index.ts +170 -3
- package/model/phoneNumberWebhookModel.ts +37 -0
- package/model/senderIdentityCreator.ts +49 -0
- package/model/senderIdentityEvent.ts +104 -0
- package/model/signerAuthenticationWebhookModel.ts +37 -0
- package/model/templateCcWebhookModel.ts +43 -0
- package/model/templateEvent.ts +186 -0
- package/model/templateGroupSignerWebhookModel.ts +37 -0
- package/model/templateSender.ts +49 -0
- package/model/templateShareErrorResponse.ts +49 -0
- package/model/templateShareRequest.ts +32 -0
- package/model/templateSigner.ts +151 -0
- package/model/templateSignerDetails.ts +0 -7
- package/model/templateTeamShareRequest.ts +53 -0
- package/model/updateGroupContact.ts +44 -0
- package/model/viewBrandDetails.ts +0 -7
- package/model/webhookActorDetails.ts +47 -0
- package/model/webhookContext.ts +78 -0
- package/model/webhookEvent.ts +53 -0
- package/model/webhookEventData.ts +322 -0
- package/model/webhookEventMetadata.ts +93 -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-3.0.3.tgz +0 -0
- package/dist/examples/draftSend.js.map +0 -1
- package/dist/examples/embeddedCreatePreviewUrl.js.map +0 -1
- package/dist/model/problemDetails.js +0 -38
- package/dist/model/problemDetails.js.map +0 -1
- package/dist/model/signatureFrameSettings.js +0 -39
- package/dist/model/signatureFrameSettings.js.map +0 -1
- package/dist/tests/performance/performanceApiTest.spec.js +0 -368
- package/dist/tests/performance/performanceApiTest.spec.js.map +0 -1
- package/docs/SignatureFrameSettings.md +0 -14
- package/examples/embeddedCreatePreviewUrl.ts +0 -15
- package/tests/performance/performanceApiTest.spec.ts +0 -362
- /package/dist/examples/{draftSend.d.ts → TemplateShare.d.ts} +0 -0
- /package/dist/examples/{embeddedCreatePreviewUrl.d.ts → contactGroupDelete.d.ts} +0 -0
- /package/dist/{tests/performance/performanceApiTest.spec.d.ts → examples/contactGroupGet.d.ts} +0 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -7,6 +7,7 @@ api/brandingApi.ts
|
|
|
7
7
|
api/contactsApi.ts
|
|
8
8
|
api/customFieldApi.ts
|
|
9
9
|
api/documentApi.ts
|
|
10
|
+
api/groupContactsApi.ts
|
|
10
11
|
api/identityVerificationApi.ts
|
|
11
12
|
api/index.ts
|
|
12
13
|
api/planApi.ts
|
|
@@ -26,6 +27,7 @@ model/base64File.ts
|
|
|
26
27
|
model/behalfDocument.ts
|
|
27
28
|
model/behalfDocumentRecords.ts
|
|
28
29
|
model/behalfOf.ts
|
|
30
|
+
model/behalfOfWebhookModel.ts
|
|
29
31
|
model/billingViewModel.ts
|
|
30
32
|
model/brandCreated.ts
|
|
31
33
|
model/brandCustomFieldDetails.ts
|
|
@@ -41,10 +43,12 @@ model/contactPageDetails.ts
|
|
|
41
43
|
model/contactsDetails.ts
|
|
42
44
|
model/contactsList.ts
|
|
43
45
|
model/createContactResponse.ts
|
|
46
|
+
model/createGroupContactResponse.ts
|
|
44
47
|
model/createSenderIdentityRequest.ts
|
|
45
48
|
model/createTeamRequest.ts
|
|
46
49
|
model/createTemplateRequest.ts
|
|
47
50
|
model/createUser.ts
|
|
51
|
+
model/creators.ts
|
|
48
52
|
model/customDomainSettings.ts
|
|
49
53
|
model/customFieldCollection.ts
|
|
50
54
|
model/customFieldMessage.ts
|
|
@@ -53,24 +57,36 @@ model/deleteCustomFieldReply.ts
|
|
|
53
57
|
model/document.ts
|
|
54
58
|
model/documentCC.ts
|
|
55
59
|
model/documentCcDetails.ts
|
|
60
|
+
model/documentCcWebhookModel.ts
|
|
56
61
|
model/documentCreated.ts
|
|
62
|
+
model/documentEdited.ts
|
|
63
|
+
model/documentEvent.ts
|
|
57
64
|
model/documentExpirySettings.ts
|
|
58
65
|
model/documentFiles.ts
|
|
59
66
|
model/documentFormFields.ts
|
|
67
|
+
model/documentGroupSignerWebhookModel.ts
|
|
60
68
|
model/documentInfo.ts
|
|
61
69
|
model/documentProperties.ts
|
|
62
70
|
model/documentReassign.ts
|
|
63
71
|
model/documentRecords.ts
|
|
72
|
+
model/documentSender.ts
|
|
64
73
|
model/documentSenderDetail.ts
|
|
65
74
|
model/documentSigner.ts
|
|
66
75
|
model/documentSignerDetails.ts
|
|
76
|
+
model/documentSignerWebhookModel.ts
|
|
67
77
|
model/documentTags.ts
|
|
68
78
|
model/downloadImageRequest.ts
|
|
79
|
+
model/editDocumentFile.ts
|
|
80
|
+
model/editDocumentRequest.ts
|
|
81
|
+
model/editDocumentSigner.ts
|
|
82
|
+
model/editFormField.ts
|
|
69
83
|
model/editSenderIdentityRequest.ts
|
|
70
84
|
model/editTemplateRequest.ts
|
|
71
85
|
model/editableDateFieldSettings.ts
|
|
72
86
|
model/embeddedCreateTemplateRequest.ts
|
|
73
87
|
model/embeddedCustomFieldCreated.ts
|
|
88
|
+
model/embeddedDocumentEditJsonRequest.ts
|
|
89
|
+
model/embeddedDocumentEdited.ts
|
|
74
90
|
model/embeddedDocumentRequest.ts
|
|
75
91
|
model/embeddedFileDetails.ts
|
|
76
92
|
model/embeddedFileLink.ts
|
|
@@ -83,6 +99,7 @@ model/embeddedTemplateEditRequest.ts
|
|
|
83
99
|
model/embeddedTemplateEdited.ts
|
|
84
100
|
model/embeddedTemplatePreview.ts
|
|
85
101
|
model/embeddedTemplatePreviewJsonRequest.ts
|
|
102
|
+
model/errorResponse.ts
|
|
86
103
|
model/errorResult.ts
|
|
87
104
|
model/existingFormField.ts
|
|
88
105
|
model/extendExpiry.ts
|
|
@@ -90,13 +107,23 @@ model/fileInfo.ts
|
|
|
90
107
|
model/font.ts
|
|
91
108
|
model/formField.ts
|
|
92
109
|
model/formFieldPermission.ts
|
|
110
|
+
model/formFieldPermissionWebhookModel.ts
|
|
93
111
|
model/formGroup.ts
|
|
94
112
|
model/formulaFieldSettings.ts
|
|
113
|
+
model/getGroupContactDetails.ts
|
|
114
|
+
model/groupContact.ts
|
|
115
|
+
model/groupContactDetails.ts
|
|
116
|
+
model/groupContactsList.ts
|
|
95
117
|
model/groupSigner.ts
|
|
96
118
|
model/groupSignerSettings.ts
|
|
119
|
+
model/groupSignerSettingsWebhookModel.ts
|
|
120
|
+
model/groupUser.ts
|
|
121
|
+
model/iWebhookData.ts
|
|
97
122
|
model/idDocument.ts
|
|
98
123
|
model/idReport.ts
|
|
99
124
|
model/idVerificationDetails.ts
|
|
125
|
+
model/idVerificationSignerWebhookModel.ts
|
|
126
|
+
model/identityVerificationEvent.ts
|
|
100
127
|
model/identityVerificationSettings.ts
|
|
101
128
|
model/imageInfo.ts
|
|
102
129
|
model/index.ts
|
|
@@ -108,6 +135,7 @@ model/modificationDetails.ts
|
|
|
108
135
|
model/notificationSettings.ts
|
|
109
136
|
model/pageDetails.ts
|
|
110
137
|
model/phoneNumber.ts
|
|
138
|
+
model/phoneNumberWebhookModel.ts
|
|
111
139
|
model/prefillField.ts
|
|
112
140
|
model/prefillFieldRequest.ts
|
|
113
141
|
model/recipientChangeLog.ts
|
|
@@ -123,10 +151,12 @@ model/roles.ts
|
|
|
123
151
|
model/sendForSign.ts
|
|
124
152
|
model/sendForSignFromTemplateForm.ts
|
|
125
153
|
model/senderIdentityCreated.ts
|
|
154
|
+
model/senderIdentityCreator.ts
|
|
155
|
+
model/senderIdentityEvent.ts
|
|
126
156
|
model/senderIdentityList.ts
|
|
127
157
|
model/senderIdentityViewModel.ts
|
|
128
|
-
model/signatureFrameSettings.ts
|
|
129
158
|
model/signerAuthenticationSettings.ts
|
|
159
|
+
model/signerAuthenticationWebhookModel.ts
|
|
130
160
|
model/size.ts
|
|
131
161
|
model/teamCreated.ts
|
|
132
162
|
model/teamDocumentRecords.ts
|
|
@@ -138,22 +168,31 @@ model/teamUsers.ts
|
|
|
138
168
|
model/teams.ts
|
|
139
169
|
model/template.ts
|
|
140
170
|
model/templateCC.ts
|
|
171
|
+
model/templateCcWebhookModel.ts
|
|
141
172
|
model/templateCreated.ts
|
|
173
|
+
model/templateEvent.ts
|
|
142
174
|
model/templateFiles.ts
|
|
143
175
|
model/templateFormFields.ts
|
|
144
176
|
model/templateGroupSigner.ts
|
|
177
|
+
model/templateGroupSignerWebhookModel.ts
|
|
145
178
|
model/templateProperties.ts
|
|
146
179
|
model/templateRecords.ts
|
|
147
180
|
model/templateRole.ts
|
|
181
|
+
model/templateSender.ts
|
|
148
182
|
model/templateSenderDetail.ts
|
|
149
183
|
model/templateSenderDetails.ts
|
|
184
|
+
model/templateShareErrorResponse.ts
|
|
185
|
+
model/templateShareRequest.ts
|
|
150
186
|
model/templateSharedTemplateDetail.ts
|
|
151
187
|
model/templateSharing.ts
|
|
188
|
+
model/templateSigner.ts
|
|
152
189
|
model/templateSignerDetails.ts
|
|
153
190
|
model/templateTag.ts
|
|
154
191
|
model/templateTeamShare.ts
|
|
192
|
+
model/templateTeamShareRequest.ts
|
|
155
193
|
model/textTagDefinition.ts
|
|
156
194
|
model/textTagOffset.ts
|
|
195
|
+
model/updateGroupContact.ts
|
|
157
196
|
model/updateUser.ts
|
|
158
197
|
model/updateUserMetaData.ts
|
|
159
198
|
model/userPageDetails.ts
|
|
@@ -164,5 +203,10 @@ model/validation.ts
|
|
|
164
203
|
model/verificationDataRequest.ts
|
|
165
204
|
model/viewBrandDetails.ts
|
|
166
205
|
model/viewCustomFieldDetails.ts
|
|
206
|
+
model/webhookActorDetails.ts
|
|
207
|
+
model/webhookContext.ts
|
|
208
|
+
model/webhookEvent.ts
|
|
209
|
+
model/webhookEventData.ts
|
|
210
|
+
model/webhookEventMetadata.ts
|
|
167
211
|
package.json
|
|
168
212
|
tsconfig.json
|
package/README.md
CHANGED
|
@@ -85,15 +85,18 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
85
85
|
| *DocumentApi* | [**addAuthentication**](./docs/DocumentApi.md#addauthentication) | **PATCH** /v1/document/addAuthentication | The add authentication to recipient. |
|
|
86
86
|
| *DocumentApi* | [**addTag**](./docs/DocumentApi.md#addtag) | **PATCH** /v1/document/addTags | Add the Tags in Documents. |
|
|
87
87
|
| *DocumentApi* | [**behalfDocuments**](./docs/DocumentApi.md#behalfdocuments) | **GET** /v1/document/behalfList | Gets the behalf documents. |
|
|
88
|
+
| *DocumentApi* | [**cancelEditing**](./docs/DocumentApi.md#cancelediting) | **POST** /v1-beta/document/cancelEditing | Cancels editing for a document that is currently in edit-mode. |
|
|
88
89
|
| *DocumentApi* | [**changeAccessCode**](./docs/DocumentApi.md#changeaccesscode) | **PATCH** /v1/document/changeAccessCode | Changes the access code for the given document signer. |
|
|
89
90
|
| *DocumentApi* | [**changeRecipient**](./docs/DocumentApi.md#changerecipient) | **PATCH** /v1/document/changeRecipient | Change recipient details of a document. |
|
|
91
|
+
| *DocumentApi* | [**createEmbeddedEditUrl**](./docs/DocumentApi.md#createembeddedediturl) | **POST** /v1-beta/document/createEmbeddedEditUrl | Generates an embedded edit URL that allows the document editing process to be integrated into your application. |
|
|
90
92
|
| *DocumentApi* | [**createEmbeddedRequestUrlDocument**](./docs/DocumentApi.md#createembeddedrequesturldocument) | **POST** /v1/document/createEmbeddedRequestUrl | Generates a send URL which embeds document sending process into your application. |
|
|
91
93
|
| *DocumentApi* | [**deleteDocument**](./docs/DocumentApi.md#deletedocument) | **DELETE** /v1/document/delete | Delete the document. |
|
|
92
94
|
| *DocumentApi* | [**deleteTag**](./docs/DocumentApi.md#deletetag) | **DELETE** /v1/document/deleteTags | Delete the Tags in Documents. |
|
|
93
95
|
| *DocumentApi* | [**downloadAttachment**](./docs/DocumentApi.md#downloadattachment) | **GET** /v1/document/downloadAttachment | Download the Attachment. |
|
|
94
96
|
| *DocumentApi* | [**downloadAuditLog**](./docs/DocumentApi.md#downloadauditlog) | **GET** /v1/document/downloadAuditLog | Download the audit trail document. |
|
|
95
97
|
| *DocumentApi* | [**downloadDocument**](./docs/DocumentApi.md#downloaddocument) | **GET** /v1/document/download | Download the document. |
|
|
96
|
-
| *DocumentApi* | [**draftSend**](./docs/DocumentApi.md#draftsend) | **POST** /v1/document/draftSend | Sends a draft-status document out for signature. |
|
|
98
|
+
| *DocumentApi* | [**draftSend**](./docs/DocumentApi.md#draftsend) | **POST** /v1-beta/document/draftSend | Sends a draft-status document out for signature. |
|
|
99
|
+
| *DocumentApi* | [**editDocument**](./docs/DocumentApi.md#editdocument) | **PUT** /v1-beta/document/edit | Edit and updates an existing document. |
|
|
97
100
|
| *DocumentApi* | [**extendExpiry**](./docs/DocumentApi.md#extendexpiry) | **PATCH** /v1/document/extendExpiry | Extends the expiration date of the document. |
|
|
98
101
|
| *DocumentApi* | [**getProperties**](./docs/DocumentApi.md#getproperties) | **GET** /v1/document/properties | Get summary of the document. |
|
|
99
102
|
| *DocumentApi* | [**getEmbeddedSignLink**](./docs/DocumentApi.md#getembeddedsignlink) | **GET** /v1/document/getEmbeddedSignLink | Get sign link for Embedded Sign. |
|
|
@@ -104,6 +107,11 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
104
107
|
| *DocumentApi* | [**revokeDocument**](./docs/DocumentApi.md#revokedocument) | **POST** /v1/document/revoke | Revoke the document. |
|
|
105
108
|
| *DocumentApi* | [**sendDocument**](./docs/DocumentApi.md#senddocument) | **POST** /v1/document/send | Sends the document for sign. |
|
|
106
109
|
| *DocumentApi* | [**teamDocuments**](./docs/DocumentApi.md#teamdocuments) | **GET** /v1/document/teamlist | Get user Team documents. |
|
|
110
|
+
| *GroupContactsApi* | [**createGroupContact**](./docs/GroupContactsApi.md#creategroupcontact) | **POST** /v1-beta/contactGroups/create | Create a new Group Contact. |
|
|
111
|
+
| *GroupContactsApi* | [**deleteGroupContact**](./docs/GroupContactsApi.md#deletegroupcontact) | **DELETE** /v1-beta/contactGroups/delete | Deletes a Group Contact. |
|
|
112
|
+
| *GroupContactsApi* | [**getGroupContact**](./docs/GroupContactsApi.md#getgroupcontact) | **GET** /v1-beta/contactGroups/get | Get Summary of the Group Contact. |
|
|
113
|
+
| *GroupContactsApi* | [**groupContactList**](./docs/GroupContactsApi.md#groupcontactlist) | **GET** /v1-beta/contactGroups/list | List Group Contacts. |
|
|
114
|
+
| *GroupContactsApi* | [**updateGroupContact**](./docs/GroupContactsApi.md#updategroupcontact) | **PUT** /v1-beta/contactGroups/update | Update the Group Contact. |
|
|
107
115
|
| *IdentityVerificationApi* | [**createEmbeddedVerificationUrl**](./docs/IdentityVerificationApi.md#createembeddedverificationurl) | **POST** /v1/identityVerification/createEmbeddedVerificationUrl | Generate a URL that embeds manual ID verification for the specified document signer into your application. |
|
|
108
116
|
| *IdentityVerificationApi* | [**image**](./docs/IdentityVerificationApi.md#image) | **POST** /v1/identityVerification/image | Retrieve the uploaded ID verification document or selfie image for the specified document signer using the file ID. |
|
|
109
117
|
| *IdentityVerificationApi* | [**report**](./docs/IdentityVerificationApi.md#report) | **POST** /v1/identityVerification/report | Retrieve the ID verification report for the specified document signer. |
|
|
@@ -134,8 +142,9 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
134
142
|
| *TemplateApi* | [**mergeAndSend**](./docs/TemplateApi.md#mergeandsend) | **POST** /v1/template/mergeAndSend | Send the document by merging multiple templates. |
|
|
135
143
|
| *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. |
|
|
136
144
|
| *TemplateApi* | [**sendUsingTemplate**](./docs/TemplateApi.md#sendusingtemplate) | **POST** /v1/template/send | Send a document for signature using a Template. |
|
|
145
|
+
| *TemplateApi* | [**shareTemplate**](./docs/TemplateApi.md#sharetemplate) | **PATCH** /v1-beta/template/share | Share a template with teams and manage permissions. |
|
|
137
146
|
| *UserApi* | [**cancelInvitation**](./docs/UserApi.md#cancelinvitation) | **POST** /v1/users/cancelInvitation | Cancel the users invitation. |
|
|
138
|
-
| *UserApi* | [**changeTeam**](./docs/UserApi.md#changeteam) | **PUT** /v1/users/changeTeam | Change users to other team. |
|
|
147
|
+
| *UserApi* | [**changeTeam**](./docs/UserApi.md#changeteam) | **PUT** /v1-beta/users/changeTeam | Change users to other team. |
|
|
139
148
|
| *UserApi* | [**createUser**](./docs/UserApi.md#createuser) | **POST** /v1/users/create | Create the user. |
|
|
140
149
|
| *UserApi* | [**getUser**](./docs/UserApi.md#getuser) | **GET** /v1/users/get | Get summary of the user. |
|
|
141
150
|
| *UserApi* | [**listUsers**](./docs/UserApi.md#listusers) | **GET** /v1/users/list | List user documents. |
|
|
@@ -156,6 +165,7 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
156
165
|
- [BehalfDocument](./docs/BehalfDocument.md)
|
|
157
166
|
- [BehalfDocumentRecords](./docs/BehalfDocumentRecords.md)
|
|
158
167
|
- [BehalfOf](./docs/BehalfOf.md)
|
|
168
|
+
- [BehalfOfWebhookModel](./docs/BehalfOfWebhookModel.md)
|
|
159
169
|
- [BillingViewModel](./docs/BillingViewModel.md)
|
|
160
170
|
- [BrandCreated](./docs/BrandCreated.md)
|
|
161
171
|
- [BrandCustomFieldDetails](./docs/BrandCustomFieldDetails.md)
|
|
@@ -171,10 +181,12 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
171
181
|
- [ContactsDetails](./docs/ContactsDetails.md)
|
|
172
182
|
- [ContactsList](./docs/ContactsList.md)
|
|
173
183
|
- [CreateContactResponse](./docs/CreateContactResponse.md)
|
|
184
|
+
- [CreateGroupContactResponse](./docs/CreateGroupContactResponse.md)
|
|
174
185
|
- [CreateSenderIdentityRequest](./docs/CreateSenderIdentityRequest.md)
|
|
175
186
|
- [CreateTeamRequest](./docs/CreateTeamRequest.md)
|
|
176
187
|
- [CreateTemplateRequest](./docs/CreateTemplateRequest.md)
|
|
177
188
|
- [CreateUser](./docs/CreateUser.md)
|
|
189
|
+
- [Creators](./docs/Creators.md)
|
|
178
190
|
- [CustomDomainSettings](./docs/CustomDomainSettings.md)
|
|
179
191
|
- [CustomFieldCollection](./docs/CustomFieldCollection.md)
|
|
180
192
|
- [CustomFieldMessage](./docs/CustomFieldMessage.md)
|
|
@@ -183,24 +195,36 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
183
195
|
- [Document](./docs/Document.md)
|
|
184
196
|
- [DocumentCC](./docs/DocumentCC.md)
|
|
185
197
|
- [DocumentCcDetails](./docs/DocumentCcDetails.md)
|
|
198
|
+
- [DocumentCcWebhookModel](./docs/DocumentCcWebhookModel.md)
|
|
186
199
|
- [DocumentCreated](./docs/DocumentCreated.md)
|
|
200
|
+
- [DocumentEdited](./docs/DocumentEdited.md)
|
|
201
|
+
- [DocumentEvent](./docs/DocumentEvent.md)
|
|
187
202
|
- [DocumentExpirySettings](./docs/DocumentExpirySettings.md)
|
|
188
203
|
- [DocumentFiles](./docs/DocumentFiles.md)
|
|
189
204
|
- [DocumentFormFields](./docs/DocumentFormFields.md)
|
|
205
|
+
- [DocumentGroupSignerWebhookModel](./docs/DocumentGroupSignerWebhookModel.md)
|
|
190
206
|
- [DocumentInfo](./docs/DocumentInfo.md)
|
|
191
207
|
- [DocumentProperties](./docs/DocumentProperties.md)
|
|
192
208
|
- [DocumentReassign](./docs/DocumentReassign.md)
|
|
193
209
|
- [DocumentRecords](./docs/DocumentRecords.md)
|
|
210
|
+
- [DocumentSender](./docs/DocumentSender.md)
|
|
194
211
|
- [DocumentSenderDetail](./docs/DocumentSenderDetail.md)
|
|
195
212
|
- [DocumentSigner](./docs/DocumentSigner.md)
|
|
196
213
|
- [DocumentSignerDetails](./docs/DocumentSignerDetails.md)
|
|
214
|
+
- [DocumentSignerWebhookModel](./docs/DocumentSignerWebhookModel.md)
|
|
197
215
|
- [DocumentTags](./docs/DocumentTags.md)
|
|
198
216
|
- [DownloadImageRequest](./docs/DownloadImageRequest.md)
|
|
217
|
+
- [EditDocumentFile](./docs/EditDocumentFile.md)
|
|
218
|
+
- [EditDocumentRequest](./docs/EditDocumentRequest.md)
|
|
219
|
+
- [EditDocumentSigner](./docs/EditDocumentSigner.md)
|
|
220
|
+
- [EditFormField](./docs/EditFormField.md)
|
|
199
221
|
- [EditSenderIdentityRequest](./docs/EditSenderIdentityRequest.md)
|
|
200
222
|
- [EditTemplateRequest](./docs/EditTemplateRequest.md)
|
|
201
223
|
- [EditableDateFieldSettings](./docs/EditableDateFieldSettings.md)
|
|
202
224
|
- [EmbeddedCreateTemplateRequest](./docs/EmbeddedCreateTemplateRequest.md)
|
|
203
225
|
- [EmbeddedCustomFieldCreated](./docs/EmbeddedCustomFieldCreated.md)
|
|
226
|
+
- [EmbeddedDocumentEditJsonRequest](./docs/EmbeddedDocumentEditJsonRequest.md)
|
|
227
|
+
- [EmbeddedDocumentEdited](./docs/EmbeddedDocumentEdited.md)
|
|
204
228
|
- [EmbeddedDocumentRequest](./docs/EmbeddedDocumentRequest.md)
|
|
205
229
|
- [EmbeddedFileDetails](./docs/EmbeddedFileDetails.md)
|
|
206
230
|
- [EmbeddedFileLink](./docs/EmbeddedFileLink.md)
|
|
@@ -213,6 +237,7 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
213
237
|
- [EmbeddedTemplateEdited](./docs/EmbeddedTemplateEdited.md)
|
|
214
238
|
- [EmbeddedTemplatePreview](./docs/EmbeddedTemplatePreview.md)
|
|
215
239
|
- [EmbeddedTemplatePreviewJsonRequest](./docs/EmbeddedTemplatePreviewJsonRequest.md)
|
|
240
|
+
- [ErrorResponse](./docs/ErrorResponse.md)
|
|
216
241
|
- [ErrorResult](./docs/ErrorResult.md)
|
|
217
242
|
- [ExistingFormField](./docs/ExistingFormField.md)
|
|
218
243
|
- [ExtendExpiry](./docs/ExtendExpiry.md)
|
|
@@ -220,13 +245,23 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
220
245
|
- [Font](./docs/Font.md)
|
|
221
246
|
- [FormField](./docs/FormField.md)
|
|
222
247
|
- [FormFieldPermission](./docs/FormFieldPermission.md)
|
|
248
|
+
- [FormFieldPermissionWebhookModel](./docs/FormFieldPermissionWebhookModel.md)
|
|
223
249
|
- [FormGroup](./docs/FormGroup.md)
|
|
224
250
|
- [FormulaFieldSettings](./docs/FormulaFieldSettings.md)
|
|
251
|
+
- [GetGroupContactDetails](./docs/GetGroupContactDetails.md)
|
|
252
|
+
- [GroupContact](./docs/GroupContact.md)
|
|
253
|
+
- [GroupContactDetails](./docs/GroupContactDetails.md)
|
|
254
|
+
- [GroupContactsList](./docs/GroupContactsList.md)
|
|
225
255
|
- [GroupSigner](./docs/GroupSigner.md)
|
|
226
256
|
- [GroupSignerSettings](./docs/GroupSignerSettings.md)
|
|
257
|
+
- [GroupSignerSettingsWebhookModel](./docs/GroupSignerSettingsWebhookModel.md)
|
|
258
|
+
- [GroupUser](./docs/GroupUser.md)
|
|
259
|
+
- [IWebhookData](./docs/IWebhookData.md)
|
|
227
260
|
- [IdDocument](./docs/IdDocument.md)
|
|
228
261
|
- [IdReport](./docs/IdReport.md)
|
|
229
262
|
- [IdVerificationDetails](./docs/IdVerificationDetails.md)
|
|
263
|
+
- [IdVerificationSignerWebhookModel](./docs/IdVerificationSignerWebhookModel.md)
|
|
264
|
+
- [IdentityVerificationEvent](./docs/IdentityVerificationEvent.md)
|
|
230
265
|
- [IdentityVerificationSettings](./docs/IdentityVerificationSettings.md)
|
|
231
266
|
- [ImageInfo](./docs/ImageInfo.md)
|
|
232
267
|
- [MergeAndSendForSignForm](./docs/MergeAndSendForSignForm.md)
|
|
@@ -236,6 +271,7 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
236
271
|
- [NotificationSettings](./docs/NotificationSettings.md)
|
|
237
272
|
- [PageDetails](./docs/PageDetails.md)
|
|
238
273
|
- [PhoneNumber](./docs/PhoneNumber.md)
|
|
274
|
+
- [PhoneNumberWebhookModel](./docs/PhoneNumberWebhookModel.md)
|
|
239
275
|
- [PrefillField](./docs/PrefillField.md)
|
|
240
276
|
- [PrefillFieldRequest](./docs/PrefillFieldRequest.md)
|
|
241
277
|
- [RecipientChangeLog](./docs/RecipientChangeLog.md)
|
|
@@ -251,10 +287,12 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
251
287
|
- [SendForSign](./docs/SendForSign.md)
|
|
252
288
|
- [SendForSignFromTemplateForm](./docs/SendForSignFromTemplateForm.md)
|
|
253
289
|
- [SenderIdentityCreated](./docs/SenderIdentityCreated.md)
|
|
290
|
+
- [SenderIdentityCreator](./docs/SenderIdentityCreator.md)
|
|
291
|
+
- [SenderIdentityEvent](./docs/SenderIdentityEvent.md)
|
|
254
292
|
- [SenderIdentityList](./docs/SenderIdentityList.md)
|
|
255
293
|
- [SenderIdentityViewModel](./docs/SenderIdentityViewModel.md)
|
|
256
|
-
- [SignatureFrameSettings](./docs/SignatureFrameSettings.md)
|
|
257
294
|
- [SignerAuthenticationSettings](./docs/SignerAuthenticationSettings.md)
|
|
295
|
+
- [SignerAuthenticationWebhookModel](./docs/SignerAuthenticationWebhookModel.md)
|
|
258
296
|
- [Size](./docs/Size.md)
|
|
259
297
|
- [TeamCreated](./docs/TeamCreated.md)
|
|
260
298
|
- [TeamDocumentRecords](./docs/TeamDocumentRecords.md)
|
|
@@ -266,22 +304,31 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
266
304
|
- [Teams](./docs/Teams.md)
|
|
267
305
|
- [Template](./docs/Template.md)
|
|
268
306
|
- [TemplateCC](./docs/TemplateCC.md)
|
|
307
|
+
- [TemplateCcWebhookModel](./docs/TemplateCcWebhookModel.md)
|
|
269
308
|
- [TemplateCreated](./docs/TemplateCreated.md)
|
|
309
|
+
- [TemplateEvent](./docs/TemplateEvent.md)
|
|
270
310
|
- [TemplateFiles](./docs/TemplateFiles.md)
|
|
271
311
|
- [TemplateFormFields](./docs/TemplateFormFields.md)
|
|
272
312
|
- [TemplateGroupSigner](./docs/TemplateGroupSigner.md)
|
|
313
|
+
- [TemplateGroupSignerWebhookModel](./docs/TemplateGroupSignerWebhookModel.md)
|
|
273
314
|
- [TemplateProperties](./docs/TemplateProperties.md)
|
|
274
315
|
- [TemplateRecords](./docs/TemplateRecords.md)
|
|
275
316
|
- [TemplateRole](./docs/TemplateRole.md)
|
|
317
|
+
- [TemplateSender](./docs/TemplateSender.md)
|
|
276
318
|
- [TemplateSenderDetail](./docs/TemplateSenderDetail.md)
|
|
277
319
|
- [TemplateSenderDetails](./docs/TemplateSenderDetails.md)
|
|
320
|
+
- [TemplateShareErrorResponse](./docs/TemplateShareErrorResponse.md)
|
|
321
|
+
- [TemplateShareRequest](./docs/TemplateShareRequest.md)
|
|
278
322
|
- [TemplateSharedTemplateDetail](./docs/TemplateSharedTemplateDetail.md)
|
|
279
323
|
- [TemplateSharing](./docs/TemplateSharing.md)
|
|
324
|
+
- [TemplateSigner](./docs/TemplateSigner.md)
|
|
280
325
|
- [TemplateSignerDetails](./docs/TemplateSignerDetails.md)
|
|
281
326
|
- [TemplateTag](./docs/TemplateTag.md)
|
|
282
327
|
- [TemplateTeamShare](./docs/TemplateTeamShare.md)
|
|
328
|
+
- [TemplateTeamShareRequest](./docs/TemplateTeamShareRequest.md)
|
|
283
329
|
- [TextTagDefinition](./docs/TextTagDefinition.md)
|
|
284
330
|
- [TextTagOffset](./docs/TextTagOffset.md)
|
|
331
|
+
- [UpdateGroupContact](./docs/UpdateGroupContact.md)
|
|
285
332
|
- [UpdateUser](./docs/UpdateUser.md)
|
|
286
333
|
- [UpdateUserMetaData](./docs/UpdateUserMetaData.md)
|
|
287
334
|
- [UserPageDetails](./docs/UserPageDetails.md)
|
|
@@ -292,6 +339,11 @@ All URIs are relative to *https://api.boldsign.com*
|
|
|
292
339
|
- [VerificationDataRequest](./docs/VerificationDataRequest.md)
|
|
293
340
|
- [ViewBrandDetails](./docs/ViewBrandDetails.md)
|
|
294
341
|
- [ViewCustomFieldDetails](./docs/ViewCustomFieldDetails.md)
|
|
342
|
+
- [WebhookActorDetails](./docs/WebhookActorDetails.md)
|
|
343
|
+
- [WebhookContext](./docs/WebhookContext.md)
|
|
344
|
+
- [WebhookEvent](./docs/WebhookEvent.md)
|
|
345
|
+
- [WebhookEventData](./docs/WebhookEventData.md)
|
|
346
|
+
- [WebhookEventMetadata](./docs/WebhookEventMetadata.md)
|
|
295
347
|
|
|
296
348
|
## Authorization
|
|
297
349
|
|
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/3.0.
|
|
27
|
+
export const USER_AGENT = "boldsign-node-sdk/3.1.0-beta.1";
|
|
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) => {
|
|
@@ -120,7 +133,7 @@ export const generateFormData = (
|
|
|
120
133
|
});
|
|
121
134
|
return;
|
|
122
135
|
}
|
|
123
|
-
|
|
136
|
+
|
|
124
137
|
/**
|
|
125
138
|
* Everything else that is not binary data (file uploads) can be
|
|
126
139
|
* serialized to JSON and sent over. This helps reduce complexity
|
package/api/brandingApi.ts
CHANGED
|
@@ -232,13 +232,9 @@ export class BrandingApi {
|
|
|
232
232
|
* @param documentExpirySettingsReminderCount
|
|
233
233
|
* @param customDomainSettingsDomainName
|
|
234
234
|
* @param customDomainSettingsFromName
|
|
235
|
-
* @param signatureFrameSettingsEnableSignatureFrame
|
|
236
|
-
* @param signatureFrameSettingsShowRecipientName
|
|
237
|
-
* @param signatureFrameSettingsShowRecipientEmail
|
|
238
|
-
* @param signatureFrameSettingsShowTimeStamp
|
|
239
235
|
* @param options
|
|
240
236
|
*/
|
|
241
|
-
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,
|
|
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> {
|
|
242
238
|
const localVarPath = this.basePath + '/v1/brand/create';
|
|
243
239
|
let localVarQueryParameters: any = {};
|
|
244
240
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -383,22 +379,6 @@ export class BrandingApi {
|
|
|
383
379
|
localVarFormParams['CustomDomainSettings.FromName'] = ObjectSerializer.serialize(customDomainSettingsFromName, "string");
|
|
384
380
|
}
|
|
385
381
|
|
|
386
|
-
if (signatureFrameSettingsEnableSignatureFrame !== undefined) {
|
|
387
|
-
localVarFormParams['SignatureFrameSettings.EnableSignatureFrame'] = ObjectSerializer.serialize(signatureFrameSettingsEnableSignatureFrame, "boolean");
|
|
388
|
-
}
|
|
389
|
-
|
|
390
|
-
if (signatureFrameSettingsShowRecipientName !== undefined) {
|
|
391
|
-
localVarFormParams['SignatureFrameSettings.ShowRecipientName'] = ObjectSerializer.serialize(signatureFrameSettingsShowRecipientName, "boolean");
|
|
392
|
-
}
|
|
393
|
-
|
|
394
|
-
if (signatureFrameSettingsShowRecipientEmail !== undefined) {
|
|
395
|
-
localVarFormParams['SignatureFrameSettings.ShowRecipientEmail'] = ObjectSerializer.serialize(signatureFrameSettingsShowRecipientEmail, "boolean");
|
|
396
|
-
}
|
|
397
|
-
|
|
398
|
-
if (signatureFrameSettingsShowTimeStamp !== undefined) {
|
|
399
|
-
localVarFormParams['SignatureFrameSettings.ShowTimeStamp'] = ObjectSerializer.serialize(signatureFrameSettingsShowTimeStamp, "boolean");
|
|
400
|
-
}
|
|
401
|
-
|
|
402
382
|
let data = {};
|
|
403
383
|
if (localVarUseFormData) {
|
|
404
384
|
const formData = toFormData(localVarFormParams);
|
|
@@ -645,13 +625,9 @@ export class BrandingApi {
|
|
|
645
625
|
* @param documentExpirySettingsReminderCount
|
|
646
626
|
* @param customDomainSettingsDomainName
|
|
647
627
|
* @param customDomainSettingsFromName
|
|
648
|
-
* @param signatureFrameSettingsEnableSignatureFrame
|
|
649
|
-
* @param signatureFrameSettingsShowRecipientName
|
|
650
|
-
* @param signatureFrameSettingsShowRecipientEmail
|
|
651
|
-
* @param signatureFrameSettingsShowTimeStamp
|
|
652
628
|
* @param options
|
|
653
629
|
*/
|
|
654
|
-
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,
|
|
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> {
|
|
655
631
|
const localVarPath = this.basePath + '/v1/brand/edit';
|
|
656
632
|
let localVarQueryParameters: any = {};
|
|
657
633
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -795,22 +771,6 @@ export class BrandingApi {
|
|
|
795
771
|
localVarFormParams['CustomDomainSettings.FromName'] = ObjectSerializer.serialize(customDomainSettingsFromName, "string");
|
|
796
772
|
}
|
|
797
773
|
|
|
798
|
-
if (signatureFrameSettingsEnableSignatureFrame !== undefined) {
|
|
799
|
-
localVarFormParams['SignatureFrameSettings.EnableSignatureFrame'] = ObjectSerializer.serialize(signatureFrameSettingsEnableSignatureFrame, "boolean");
|
|
800
|
-
}
|
|
801
|
-
|
|
802
|
-
if (signatureFrameSettingsShowRecipientName !== undefined) {
|
|
803
|
-
localVarFormParams['SignatureFrameSettings.ShowRecipientName'] = ObjectSerializer.serialize(signatureFrameSettingsShowRecipientName, "boolean");
|
|
804
|
-
}
|
|
805
|
-
|
|
806
|
-
if (signatureFrameSettingsShowRecipientEmail !== undefined) {
|
|
807
|
-
localVarFormParams['SignatureFrameSettings.ShowRecipientEmail'] = ObjectSerializer.serialize(signatureFrameSettingsShowRecipientEmail, "boolean");
|
|
808
|
-
}
|
|
809
|
-
|
|
810
|
-
if (signatureFrameSettingsShowTimeStamp !== undefined) {
|
|
811
|
-
localVarFormParams['SignatureFrameSettings.ShowTimeStamp'] = ObjectSerializer.serialize(signatureFrameSettingsShowTimeStamp, "boolean");
|
|
812
|
-
}
|
|
813
|
-
|
|
814
774
|
let data = {};
|
|
815
775
|
if (localVarUseFormData) {
|
|
816
776
|
const formData = toFormData(localVarFormParams);
|