boldsign 3.2.0 → 3.3.0
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 +36 -0
- package/README.md +37 -0
- package/WebhookUtility.ts +145 -0
- package/api/apis.ts +1 -1
- package/api/brandingApi.ts +20 -20
- package/api/contactsApi.ts +3 -3
- package/api/customFieldApi.ts +3 -3
- package/api/documentApi.ts +152 -23
- package/api/groupContactsApi.ts +3 -3
- package/api/identityVerificationApi.ts +3 -3
- package/api/senderIdentitiesApi.ts +6 -6
- package/api/teamsApi.ts +1 -1
- package/api/templateApi.ts +142 -13
- package/api/userApi.ts +2 -2
- package/docs/AccessCodeDetail.md +1 -0
- package/docs/BehalfOfWebhookModel.md +12 -0
- package/docs/BrandingApi.md +20 -20
- package/docs/CheckboxValidationSettings.md +13 -0
- package/docs/ContactsApi.md +3 -3
- package/docs/CreateTemplateRequest.md +1 -0
- package/docs/CustomFieldApi.md +3 -3
- package/docs/CustomFormField.md +2 -0
- package/docs/DocumentApi.md +56 -22
- package/docs/DocumentCcWebhookModel.md +12 -0
- package/docs/DocumentEvent.md +37 -0
- package/docs/DocumentGroupSignerWebhookModel.md +18 -0
- package/docs/DocumentProperties.md +1 -0
- package/docs/DocumentSender.md +14 -0
- package/docs/DocumentSigner.md +1 -0
- package/docs/DocumentSignerDetails.md +1 -0
- package/docs/DocumentSignerWebhookModel.md +37 -0
- package/docs/EditDocumentJsonFile.md +14 -0
- package/docs/EditDocumentRequest.md +1 -0
- package/docs/EditDocumentSigner.md +1 -0
- package/docs/EditTemplateRequest.md +1 -0
- package/docs/EmbeddedCloneDocumentJsonRequest.md +22 -0
- package/docs/EmbeddedCloneTemplateJsonRequest.md +22 -0
- package/docs/EmbeddedClonedDocument.md +12 -0
- package/docs/EmbeddedClonedTemplate.md +12 -0
- package/docs/EmbeddedCreateTemplateRequest.md +1 -0
- package/docs/EmbeddedDocumentRequest.md +1 -0
- package/docs/EmbeddedMergeTemplateFormRequest.md +1 -0
- package/docs/EmbeddedSendTemplateFormRequest.md +1 -0
- package/docs/ErrorResponse.md +12 -0
- package/docs/FormFieldPermissionWebhookModel.md +13 -0
- package/docs/GroupContactsApi.md +3 -3
- package/docs/GroupOption.md +12 -0
- package/docs/GroupSignerSettingsWebhookModel.md +12 -0
- package/docs/IWebhookData.md +56 -0
- package/docs/{IdVerification.md → IdVerificationSignerWebhookModel.md} +1 -1
- package/docs/IdentityVerificationApi.md +3 -3
- package/docs/IdentityVerificationEvent.md +17 -0
- package/docs/KbaAuthenticationEvent.md +17 -0
- package/docs/{ProblemDetails.md → KbaDetails.md} +4 -5
- package/docs/KbaSettings.md +13 -0
- package/docs/KbaSignerWebhookModel.md +14 -0
- package/docs/MergeAndSendForSignForm.md +1 -0
- package/docs/PhoneNumberWebhookModel.md +12 -0
- package/docs/Role.md +1 -0
- package/docs/SendForSign.md +1 -0
- package/docs/SendForSignFromTemplateForm.md +1 -0
- package/docs/SenderIdentitiesApi.md +6 -6
- package/docs/SenderIdentityCreator.md +14 -0
- package/docs/SenderIdentityEvent.md +23 -0
- package/docs/SignerAuthenticationWebhookModel.md +12 -0
- package/docs/TeamsApi.md +1 -1
- package/docs/TemplateApi.md +46 -12
- package/docs/TemplateCcWebhookModel.md +13 -0
- package/docs/TemplateEvent.md +36 -0
- package/docs/TemplateFormFields.md +1 -0
- package/docs/TemplateGroupSignerWebhookModel.md +12 -0
- package/docs/TemplateProperties.md +1 -0
- package/docs/TemplateSender.md +15 -0
- package/docs/TemplateShareErrorResponse.md +14 -0
- package/docs/TemplateShareRequest.md +11 -0
- package/docs/TemplateSigner.md +29 -0
- package/docs/TemplateTeamShareRequest.md +13 -0
- package/docs/UserApi.md +2 -2
- package/docs/WebhookActorDetails.md +12 -0
- package/docs/WebhookContext.md +13 -0
- package/docs/WebhookEvent.md +14 -0
- package/docs/WebhookEventMetadata.md +15 -0
- package/model/accessCodeDetail.ts +9 -1
- package/model/auditTrail.ts +7 -1
- package/model/behalfOfWebhookModel.ts +37 -0
- package/model/checkboxValidationSettings.ts +51 -0
- package/model/createTemplateRequest.ts +6 -0
- package/model/customFormField.ts +14 -0
- package/model/documentCcWebhookModel.ts +37 -0
- package/model/documentEvent.ts +213 -0
- package/model/documentGroupSignerWebhookModel.ts +83 -0
- package/model/documentProperties.ts +6 -0
- package/model/documentSender.ts +49 -0
- package/model/documentSigner.ts +9 -1
- package/model/documentSignerDetails.ts +9 -1
- package/model/documentSignerWebhookModel.ts +202 -0
- package/model/editDocumentJsonFile.ts +57 -0
- package/model/editDocumentRequest.ts +6 -0
- package/model/editDocumentSigner.ts +9 -1
- package/model/editTemplateRequest.ts +6 -0
- package/model/embeddedCloneDocumentJsonRequest.ts +126 -0
- package/model/embeddedCloneTemplateJsonRequest.ts +126 -0
- package/model/embeddedClonedDocument.ts +37 -0
- package/model/embeddedClonedTemplate.ts +37 -0
- package/model/embeddedCreateTemplateRequest.ts +6 -0
- package/model/embeddedDocumentRequest.ts +6 -0
- package/model/embeddedMergeTemplateFormRequest.ts +6 -0
- package/model/embeddedSendTemplateFormRequest.ts +6 -0
- package/model/formFieldPermissionWebhookModel.ts +43 -0
- package/model/groupOption.ts +37 -0
- package/model/groupSignerSettingsWebhookModel.ts +37 -0
- package/model/iWebhookData.ts +335 -0
- package/model/{idVerification.ts → idVerificationSignerWebhookModel.ts} +2 -2
- package/model/identityVerificationEvent.ts +80 -0
- package/model/index.ts +129 -0
- package/model/kbaAuthenticationEvent.ts +80 -0
- package/model/{problemDetails.ts → kbaDetails.ts} +11 -17
- package/model/kbaSettings.ts +57 -0
- package/model/kbaSignerWebhookModel.ts +49 -0
- package/model/mergeAndSendForSignForm.ts +6 -0
- package/model/phoneNumberWebhookModel.ts +37 -0
- package/model/role.ts +9 -1
- package/model/roles.ts +2 -1
- package/model/sendForSign.ts +6 -0
- package/model/sendForSignFromTemplateForm.ts +6 -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 +198 -0
- package/model/templateFormFields.ts +6 -0
- package/model/templateGroupSignerWebhookModel.ts +37 -0
- package/model/templateProperties.ts +6 -0
- package/model/templateRole.ts +2 -1
- package/model/templateSender.ts +55 -0
- package/model/templateSigner.ts +151 -0
- package/model/templateSignerDetails.ts +2 -1
- package/model/webhookActorDetails.ts +47 -0
- package/model/webhookContext.ts +82 -0
- package/model/webhookEvent.ts +53 -0
- package/model/webhookEventMetadata.ts +97 -0
- package/package.json +1 -1
- package/dist/api/apis.d.ts +0 -29
- package/dist/api/apis.js +0 -149
- package/dist/api/apis.js.map +0 -1
- package/dist/api/brandingApi.d.ts +0 -29
- package/dist/api/brandingApi.js +0 -776
- package/dist/api/brandingApi.js.map +0 -1
- package/dist/api/contactsApi.d.ts +0 -28
- package/dist/api/contactsApi.js +0 -501
- package/dist/api/contactsApi.js.map +0 -1
- package/dist/api/customFieldApi.d.ts +0 -28
- package/dist/api/customFieldApi.js +0 -519
- package/dist/api/customFieldApi.js.map +0 -1
- package/dist/api/documentApi.d.ts +0 -48
- package/dist/api/documentApi.js +0 -2259
- package/dist/api/documentApi.js.map +0 -1
- package/dist/api/groupContactsApi.d.ts +0 -28
- package/dist/api/groupContactsApi.js +0 -507
- package/dist/api/groupContactsApi.js.map +0 -1
- package/dist/api/identityVerificationApi.d.ts +0 -26
- package/dist/api/identityVerificationApi.js +0 -369
- package/dist/api/identityVerificationApi.js.map +0 -1
- package/dist/api/index.d.ts +0 -14
- package/dist/api/index.js +0 -33
- package/dist/api/index.js.map +0 -1
- package/dist/api/planApi.d.ts +0 -24
- package/dist/api/planApi.js +0 -174
- package/dist/api/planApi.js.map +0 -1
- package/dist/api/senderIdentitiesApi.d.ts +0 -30
- package/dist/api/senderIdentitiesApi.js +0 -663
- package/dist/api/senderIdentitiesApi.js.map +0 -1
- package/dist/api/teamsApi.d.ts +0 -27
- package/dist/api/teamsApi.js +0 -426
- package/dist/api/teamsApi.js.map +0 -1
- package/dist/api/templateApi.d.ts +0 -39
- package/dist/api/templateApi.js +0 -1425
- package/dist/api/templateApi.js.map +0 -1
- package/dist/api/userApi.d.ts +0 -31
- package/dist/api/userApi.js +0 -723
- package/dist/api/userApi.js.map +0 -1
- package/dist/api.d.ts +0 -2
- package/dist/api.js +0 -19
- package/dist/api.js.map +0 -1
- package/dist/model/accessCodeDetail.d.ts +0 -34
- package/dist/model/accessCodeDetail.js +0 -68
- package/dist/model/accessCodeDetail.js.map +0 -1
- package/dist/model/accessCodeDetails.d.ts +0 -17
- package/dist/model/accessCodeDetails.js +0 -28
- package/dist/model/accessCodeDetails.js.map +0 -1
- package/dist/model/added.d.ts +0 -16
- package/dist/model/added.js +0 -28
- package/dist/model/added.js.map +0 -1
- package/dist/model/address.d.ts +0 -19
- package/dist/model/address.js +0 -43
- package/dist/model/address.js.map +0 -1
- package/dist/model/attachmentInfo.d.ts +0 -17
- package/dist/model/attachmentInfo.js +0 -33
- package/dist/model/attachmentInfo.js.map +0 -1
- package/dist/model/auditTrail.d.ts +0 -114
- package/dist/model/auditTrail.js +0 -173
- package/dist/model/auditTrail.js.map +0 -1
- package/dist/model/authenticationSettings.d.ts +0 -22
- package/dist/model/authenticationSettings.js +0 -27
- package/dist/model/authenticationSettings.js.map +0 -1
- package/dist/model/base64File.d.ts +0 -15
- package/dist/model/base64File.js +0 -23
- package/dist/model/base64File.js.map +0 -1
- package/dist/model/behalfDocument.d.ts +0 -47
- package/dist/model/behalfDocument.js +0 -120
- package/dist/model/behalfDocument.js.map +0 -1
- package/dist/model/behalfDocumentRecords.d.ts +0 -17
- package/dist/model/behalfDocumentRecords.js +0 -23
- package/dist/model/behalfDocumentRecords.js.map +0 -1
- package/dist/model/behalfOf.d.ts +0 -15
- package/dist/model/behalfOf.js +0 -23
- package/dist/model/behalfOf.js.map +0 -1
- package/dist/model/billingViewModel.d.ts +0 -14
- package/dist/model/billingViewModel.js +0 -18
- package/dist/model/billingViewModel.js.map +0 -1
- package/dist/model/brandCreated.d.ts +0 -14
- package/dist/model/brandCreated.js +0 -18
- package/dist/model/brandCreated.js.map +0 -1
- package/dist/model/brandCustomFieldDetails.d.ts +0 -20
- package/dist/model/brandCustomFieldDetails.js +0 -46
- package/dist/model/brandCustomFieldDetails.js.map +0 -1
- package/dist/model/brandingMessage.d.ts +0 -14
- package/dist/model/brandingMessage.js +0 -18
- package/dist/model/brandingMessage.js.map +0 -1
- package/dist/model/brandingRecords.d.ts +0 -15
- package/dist/model/brandingRecords.js +0 -18
- package/dist/model/brandingRecords.js.map +0 -1
- package/dist/model/changeRecipient.d.ts +0 -22
- package/dist/model/changeRecipient.js +0 -53
- package/dist/model/changeRecipient.js.map +0 -1
- package/dist/model/changeTeamRequest.d.ts +0 -15
- package/dist/model/changeTeamRequest.js +0 -23
- package/dist/model/changeTeamRequest.js.map +0 -1
- package/dist/model/collaborationSettings.d.ts +0 -17
- package/dist/model/collaborationSettings.js +0 -33
- package/dist/model/collaborationSettings.js.map +0 -1
- package/dist/model/conditionalRule.d.ts +0 -16
- package/dist/model/conditionalRule.js +0 -28
- package/dist/model/conditionalRule.js.map +0 -1
- package/dist/model/contactCreated.d.ts +0 -15
- package/dist/model/contactCreated.js +0 -23
- package/dist/model/contactCreated.js.map +0 -1
- package/dist/model/contactDetails.d.ts +0 -19
- package/dist/model/contactDetails.js +0 -38
- package/dist/model/contactDetails.js.map +0 -1
- package/dist/model/contactPageDetails.d.ts +0 -16
- package/dist/model/contactPageDetails.js +0 -28
- package/dist/model/contactPageDetails.js.map +0 -1
- package/dist/model/contactsDetails.d.ts +0 -20
- package/dist/model/contactsDetails.js +0 -43
- package/dist/model/contactsDetails.js.map +0 -1
- package/dist/model/contactsList.d.ts +0 -17
- package/dist/model/contactsList.js +0 -23
- package/dist/model/contactsList.js.map +0 -1
- package/dist/model/createContactResponse.d.ts +0 -15
- package/dist/model/createContactResponse.js +0 -18
- package/dist/model/createContactResponse.js.map +0 -1
- package/dist/model/createGroupContactResponse.d.ts +0 -15
- package/dist/model/createGroupContactResponse.js +0 -23
- package/dist/model/createGroupContactResponse.js.map +0 -1
- package/dist/model/createSenderIdentityRequest.d.ts +0 -48
- package/dist/model/createSenderIdentityRequest.js +0 -74
- package/dist/model/createSenderIdentityRequest.js.map +0 -1
- package/dist/model/createTeamRequest.d.ts +0 -14
- package/dist/model/createTeamRequest.js +0 -18
- package/dist/model/createTeamRequest.js.map +0 -1
- package/dist/model/createTemplateRequest.d.ts +0 -58
- package/dist/model/createTemplateRequest.js +0 -177
- package/dist/model/createTemplateRequest.js.map +0 -1
- package/dist/model/createUser.d.ts +0 -26
- package/dist/model/createUser.js +0 -41
- package/dist/model/createUser.js.map +0 -1
- package/dist/model/creators.d.ts +0 -15
- package/dist/model/creators.js +0 -23
- package/dist/model/creators.js.map +0 -1
- package/dist/model/customDomainSettings.d.ts +0 -15
- package/dist/model/customDomainSettings.js +0 -23
- package/dist/model/customDomainSettings.js.map +0 -1
- package/dist/model/customFieldCollection.d.ts +0 -15
- package/dist/model/customFieldCollection.js +0 -18
- package/dist/model/customFieldCollection.js.map +0 -1
- package/dist/model/customFieldMessage.d.ts +0 -15
- package/dist/model/customFieldMessage.js +0 -23
- package/dist/model/customFieldMessage.js.map +0 -1
- package/dist/model/customFormField.d.ts +0 -100
- package/dist/model/customFormField.js +0 -246
- package/dist/model/customFormField.js.map +0 -1
- package/dist/model/deleteCustomFieldReply.d.ts +0 -14
- package/dist/model/deleteCustomFieldReply.js +0 -18
- package/dist/model/deleteCustomFieldReply.js.map +0 -1
- package/dist/model/document.d.ts +0 -45
- package/dist/model/document.js +0 -115
- package/dist/model/document.js.map +0 -1
- package/dist/model/documentCC.d.ts +0 -14
- package/dist/model/documentCC.js +0 -18
- package/dist/model/documentCC.js.map +0 -1
- package/dist/model/documentCcDetails.d.ts +0 -15
- package/dist/model/documentCcDetails.js +0 -26
- package/dist/model/documentCcDetails.js.map +0 -1
- package/dist/model/documentCreated.d.ts +0 -14
- package/dist/model/documentCreated.js +0 -18
- package/dist/model/documentCreated.js.map +0 -1
- package/dist/model/documentEdited.d.ts +0 -20
- package/dist/model/documentEdited.js +0 -25
- package/dist/model/documentEdited.js.map +0 -1
- package/dist/model/documentExpirySettings.d.ts +0 -26
- package/dist/model/documentExpirySettings.js +0 -51
- package/dist/model/documentExpirySettings.js.map +0 -1
- package/dist/model/documentFiles.d.ts +0 -19
- package/dist/model/documentFiles.js +0 -43
- package/dist/model/documentFiles.js.map +0 -1
- package/dist/model/documentFormFields.d.ts +0 -89
- package/dist/model/documentFormFields.js +0 -260
- package/dist/model/documentFormFields.js.map +0 -1
- package/dist/model/documentInfo.d.ts +0 -65
- package/dist/model/documentInfo.js +0 -83
- package/dist/model/documentInfo.js.map +0 -1
- package/dist/model/documentProperties.d.ts +0 -119
- package/dist/model/documentProperties.js +0 -298
- package/dist/model/documentProperties.js.map +0 -1
- package/dist/model/documentReassign.d.ts +0 -16
- package/dist/model/documentReassign.js +0 -31
- package/dist/model/documentReassign.js.map +0 -1
- package/dist/model/documentRecords.d.ts +0 -17
- package/dist/model/documentRecords.js +0 -23
- package/dist/model/documentRecords.js.map +0 -1
- package/dist/model/documentSenderDetail.d.ts +0 -17
- package/dist/model/documentSenderDetail.js +0 -36
- package/dist/model/documentSenderDetail.js.map +0 -1
- package/dist/model/documentSigner.d.ts +0 -112
- package/dist/model/documentSigner.js +0 -209
- package/dist/model/documentSigner.js.map +0 -1
- package/dist/model/documentSignerDetails.d.ts +0 -128
- package/dist/model/documentSignerDetails.js +0 -261
- package/dist/model/documentSignerDetails.js.map +0 -1
- package/dist/model/documentTags.d.ts +0 -15
- package/dist/model/documentTags.js +0 -23
- package/dist/model/documentTags.js.map +0 -1
- package/dist/model/downloadImageRequest.d.ts +0 -19
- package/dist/model/downloadImageRequest.js +0 -43
- package/dist/model/downloadImageRequest.js.map +0 -1
- package/dist/model/editDocumentFile.d.ts +0 -25
- package/dist/model/editDocumentFile.js +0 -41
- package/dist/model/editDocumentFile.js.map +0 -1
- package/dist/model/editDocumentRequest.d.ts +0 -71
- package/dist/model/editDocumentRequest.js +0 -187
- package/dist/model/editDocumentRequest.js.map +0 -1
- package/dist/model/editDocumentSigner.d.ts +0 -118
- package/dist/model/editDocumentSigner.js +0 -220
- package/dist/model/editDocumentSigner.js.map +0 -1
- package/dist/model/editFormField.d.ts +0 -116
- package/dist/model/editFormField.js +0 -288
- package/dist/model/editFormField.js.map +0 -1
- package/dist/model/editSenderIdentityRequest.d.ts +0 -46
- package/dist/model/editSenderIdentityRequest.js +0 -64
- package/dist/model/editSenderIdentityRequest.js.map +0 -1
- package/dist/model/editTemplateRequest.d.ts +0 -51
- package/dist/model/editTemplateRequest.js +0 -141
- package/dist/model/editTemplateRequest.js.map +0 -1
- package/dist/model/editableDateFieldSettings.d.ts +0 -17
- package/dist/model/editableDateFieldSettings.js +0 -33
- package/dist/model/editableDateFieldSettings.js.map +0 -1
- package/dist/model/embeddedCreateTemplateRequest.d.ts +0 -96
- package/dist/model/embeddedCreateTemplateRequest.js +0 -269
- package/dist/model/embeddedCreateTemplateRequest.js.map +0 -1
- package/dist/model/embeddedCustomFieldCreated.d.ts +0 -14
- package/dist/model/embeddedCustomFieldCreated.js +0 -18
- package/dist/model/embeddedCustomFieldCreated.js.map +0 -1
- package/dist/model/embeddedDocumentEditJsonRequest.d.ts +0 -51
- package/dist/model/embeddedDocumentEditJsonRequest.js +0 -97
- package/dist/model/embeddedDocumentEditJsonRequest.js.map +0 -1
- package/dist/model/embeddedDocumentEdited.d.ts +0 -14
- package/dist/model/embeddedDocumentEdited.js +0 -18
- package/dist/model/embeddedDocumentEdited.js.map +0 -1
- package/dist/model/embeddedDocumentRequest.d.ts +0 -115
- package/dist/model/embeddedDocumentRequest.js +0 -322
- package/dist/model/embeddedDocumentRequest.js.map +0 -1
- package/dist/model/embeddedFileDetails.d.ts +0 -19
- package/dist/model/embeddedFileDetails.js +0 -43
- package/dist/model/embeddedFileDetails.js.map +0 -1
- package/dist/model/embeddedFileLink.d.ts +0 -14
- package/dist/model/embeddedFileLink.js +0 -18
- package/dist/model/embeddedFileLink.js.map +0 -1
- package/dist/model/embeddedMergeTemplateFormRequest.d.ts +0 -116
- package/dist/model/embeddedMergeTemplateFormRequest.js +0 -311
- package/dist/model/embeddedMergeTemplateFormRequest.js.map +0 -1
- package/dist/model/embeddedSendCreated.d.ts +0 -15
- package/dist/model/embeddedSendCreated.js +0 -23
- package/dist/model/embeddedSendCreated.js.map +0 -1
- package/dist/model/embeddedSendTemplateFormRequest.d.ts +0 -112
- package/dist/model/embeddedSendTemplateFormRequest.js +0 -296
- package/dist/model/embeddedSendTemplateFormRequest.js.map +0 -1
- package/dist/model/embeddedSigningLink.d.ts +0 -14
- package/dist/model/embeddedSigningLink.js +0 -18
- package/dist/model/embeddedSigningLink.js.map +0 -1
- package/dist/model/embeddedTemplateCreated.d.ts +0 -15
- package/dist/model/embeddedTemplateCreated.js +0 -23
- package/dist/model/embeddedTemplateCreated.js.map +0 -1
- package/dist/model/embeddedTemplateEditRequest.d.ts +0 -53
- package/dist/model/embeddedTemplateEditRequest.js +0 -109
- package/dist/model/embeddedTemplateEditRequest.js.map +0 -1
- package/dist/model/embeddedTemplateEdited.d.ts +0 -14
- package/dist/model/embeddedTemplateEdited.js +0 -18
- package/dist/model/embeddedTemplateEdited.js.map +0 -1
- package/dist/model/embeddedTemplatePreview.d.ts +0 -14
- package/dist/model/embeddedTemplatePreview.js +0 -18
- package/dist/model/embeddedTemplatePreview.js.map +0 -1
- package/dist/model/embeddedTemplatePreviewJsonRequest.d.ts +0 -15
- package/dist/model/embeddedTemplatePreviewJsonRequest.js +0 -23
- package/dist/model/embeddedTemplatePreviewJsonRequest.js.map +0 -1
- package/dist/model/errorResponse.d.ts +0 -15
- package/dist/model/errorResponse.js +0 -23
- package/dist/model/errorResponse.js.map +0 -1
- package/dist/model/errorResult.d.ts +0 -14
- package/dist/model/errorResult.js +0 -18
- package/dist/model/errorResult.js.map +0 -1
- package/dist/model/existingFormField.d.ts +0 -18
- package/dist/model/existingFormField.js +0 -38
- package/dist/model/existingFormField.js.map +0 -1
- package/dist/model/extendExpiry.d.ts +0 -17
- package/dist/model/extendExpiry.js +0 -33
- package/dist/model/extendExpiry.js.map +0 -1
- package/dist/model/fileInfo.d.ts +0 -17
- package/dist/model/fileInfo.js +0 -33
- package/dist/model/fileInfo.js.map +0 -1
- package/dist/model/font.d.ts +0 -36
- package/dist/model/font.js +0 -70
- package/dist/model/font.js.map +0 -1
- package/dist/model/formField.d.ts +0 -113
- package/dist/model/formField.js +0 -287
- package/dist/model/formField.js.map +0 -1
- package/dist/model/formFieldPermission.d.ts +0 -16
- package/dist/model/formFieldPermission.js +0 -28
- package/dist/model/formFieldPermission.js.map +0 -1
- package/dist/model/formGroup.d.ts +0 -26
- package/dist/model/formGroup.js +0 -47
- package/dist/model/formGroup.js.map +0 -1
- package/dist/model/formulaFieldSettings.d.ts +0 -15
- package/dist/model/formulaFieldSettings.js +0 -26
- package/dist/model/formulaFieldSettings.js.map +0 -1
- package/dist/model/getGroupContactDetails.d.ts +0 -20
- package/dist/model/getGroupContactDetails.js +0 -38
- package/dist/model/getGroupContactDetails.js.map +0 -1
- package/dist/model/groupContact.d.ts +0 -18
- package/dist/model/groupContact.js +0 -33
- package/dist/model/groupContact.js.map +0 -1
- package/dist/model/groupContactDetails.d.ts +0 -17
- package/dist/model/groupContactDetails.js +0 -28
- package/dist/model/groupContactDetails.js.map +0 -1
- package/dist/model/groupContactsList.d.ts +0 -17
- package/dist/model/groupContactsList.js +0 -23
- package/dist/model/groupContactsList.js.map +0 -1
- package/dist/model/groupSigner.d.ts +0 -30
- package/dist/model/groupSigner.js +0 -59
- package/dist/model/groupSigner.js.map +0 -1
- package/dist/model/groupSignerSettings.d.ts +0 -15
- package/dist/model/groupSignerSettings.js +0 -23
- package/dist/model/groupSignerSettings.js.map +0 -1
- package/dist/model/groupUser.d.ts +0 -15
- package/dist/model/groupUser.js +0 -23
- package/dist/model/groupUser.js.map +0 -1
- package/dist/model/idDocument.d.ts +0 -26
- package/dist/model/idDocument.js +0 -68
- package/dist/model/idDocument.js.map +0 -1
- package/dist/model/idReport.d.ts +0 -18
- package/dist/model/idReport.js +0 -33
- package/dist/model/idReport.js.map +0 -1
- package/dist/model/idVerification.d.ts +0 -22
- package/dist/model/idVerification.js +0 -58
- package/dist/model/idVerification.js.map +0 -1
- package/dist/model/idVerificationDetails.d.ts +0 -23
- package/dist/model/idVerificationDetails.js +0 -63
- package/dist/model/idVerificationDetails.js.map +0 -1
- package/dist/model/identityVerificationSettings.d.ts +0 -37
- package/dist/model/identityVerificationSettings.js +0 -68
- package/dist/model/identityVerificationSettings.js.map +0 -1
- package/dist/model/imageInfo.d.ts +0 -16
- package/dist/model/imageInfo.js +0 -28
- package/dist/model/imageInfo.js.map +0 -1
- package/dist/model/index.d.ts +0 -174
- package/dist/model/index.js +0 -665
- package/dist/model/index.js.map +0 -1
- package/dist/model/mergeAndSendForSignForm.d.ts +0 -79
- package/dist/model/mergeAndSendForSignForm.js +0 -232
- package/dist/model/mergeAndSendForSignForm.js.map +0 -1
- package/dist/model/modelDate.d.ts +0 -16
- package/dist/model/modelDate.js +0 -28
- package/dist/model/modelDate.js.map +0 -1
- package/dist/model/modelError.d.ts +0 -15
- package/dist/model/modelError.js +0 -23
- package/dist/model/modelError.js.map +0 -1
- package/dist/model/models.d.ts +0 -56
- package/dist/model/models.js +0 -212
- package/dist/model/models.js.map +0 -1
- package/dist/model/modificationDetails.d.ts +0 -15
- package/dist/model/modificationDetails.js +0 -23
- package/dist/model/modificationDetails.js.map +0 -1
- package/dist/model/notificationSettings.d.ts +0 -25
- package/dist/model/notificationSettings.js +0 -87
- package/dist/model/notificationSettings.js.map +0 -1
- package/dist/model/pageDetails.d.ts +0 -19
- package/dist/model/pageDetails.js +0 -43
- package/dist/model/pageDetails.js.map +0 -1
- package/dist/model/phoneNumber.d.ts +0 -15
- package/dist/model/phoneNumber.js +0 -23
- package/dist/model/phoneNumber.js.map +0 -1
- package/dist/model/prefillField.d.ts +0 -15
- package/dist/model/prefillField.js +0 -23
- package/dist/model/prefillField.js.map +0 -1
- package/dist/model/prefillFieldRequest.d.ts +0 -16
- package/dist/model/prefillFieldRequest.js +0 -23
- package/dist/model/prefillFieldRequest.js.map +0 -1
- package/dist/model/problemDetails.d.ts +0 -18
- package/dist/model/problemDetails.js +0 -38
- package/dist/model/problemDetails.js.map +0 -1
- package/dist/model/recipientChangeLog.d.ts +0 -17
- package/dist/model/recipientChangeLog.js +0 -23
- package/dist/model/recipientChangeLog.js.map +0 -1
- package/dist/model/recipientNotificationSettings.d.ts +0 -25
- package/dist/model/recipientNotificationSettings.js +0 -86
- package/dist/model/recipientNotificationSettings.js.map +0 -1
- package/dist/model/rectangle.d.ts +0 -17
- package/dist/model/rectangle.js +0 -39
- package/dist/model/rectangle.js.map +0 -1
- package/dist/model/reminderMessage.d.ts +0 -17
- package/dist/model/reminderMessage.js +0 -28
- package/dist/model/reminderMessage.js.map +0 -1
- package/dist/model/reminderSettings.d.ts +0 -16
- package/dist/model/reminderSettings.js +0 -33
- package/dist/model/reminderSettings.js.map +0 -1
- package/dist/model/removeAuthentication.d.ts +0 -18
- package/dist/model/removeAuthentication.js +0 -33
- package/dist/model/removeAuthentication.js.map +0 -1
- package/dist/model/removed.d.ts +0 -16
- package/dist/model/removed.js +0 -28
- package/dist/model/removed.js.map +0 -1
- package/dist/model/revokeDocument.d.ts +0 -15
- package/dist/model/revokeDocument.js +0 -23
- package/dist/model/revokeDocument.js.map +0 -1
- package/dist/model/role.d.ts +0 -114
- package/dist/model/role.js +0 -214
- package/dist/model/role.js.map +0 -1
- package/dist/model/roles.d.ts +0 -113
- package/dist/model/roles.js +0 -219
- package/dist/model/roles.js.map +0 -1
- package/dist/model/sendForSign.d.ts +0 -78
- package/dist/model/sendForSign.js +0 -235
- package/dist/model/sendForSign.js.map +0 -1
- package/dist/model/sendForSignFromTemplateForm.d.ts +0 -75
- package/dist/model/sendForSignFromTemplateForm.js +0 -217
- package/dist/model/sendForSignFromTemplateForm.js.map +0 -1
- package/dist/model/senderIdentityCreated.d.ts +0 -14
- package/dist/model/senderIdentityCreated.js +0 -18
- package/dist/model/senderIdentityCreated.js.map +0 -1
- package/dist/model/senderIdentityList.d.ts +0 -17
- package/dist/model/senderIdentityList.js +0 -23
- package/dist/model/senderIdentityList.js.map +0 -1
- package/dist/model/senderIdentityViewModel.d.ts +0 -27
- package/dist/model/senderIdentityViewModel.js +0 -68
- package/dist/model/senderIdentityViewModel.js.map +0 -1
- package/dist/model/signatureFrameSettings.d.ts +0 -17
- package/dist/model/signatureFrameSettings.js +0 -39
- package/dist/model/signatureFrameSettings.js.map +0 -1
- package/dist/model/signerAuthenticationSettings.d.ts +0 -15
- package/dist/model/signerAuthenticationSettings.js +0 -23
- package/dist/model/signerAuthenticationSettings.js.map +0 -1
- package/dist/model/size.d.ts +0 -15
- package/dist/model/size.js +0 -27
- package/dist/model/size.js.map +0 -1
- package/dist/model/teamCreated.d.ts +0 -14
- package/dist/model/teamCreated.js +0 -18
- package/dist/model/teamCreated.js.map +0 -1
- package/dist/model/teamDocumentRecords.d.ts +0 -17
- package/dist/model/teamDocumentRecords.js +0 -23
- package/dist/model/teamDocumentRecords.js.map +0 -1
- package/dist/model/teamListResponse.d.ts +0 -17
- package/dist/model/teamListResponse.js +0 -23
- package/dist/model/teamListResponse.js.map +0 -1
- package/dist/model/teamPageDetails.d.ts +0 -15
- package/dist/model/teamPageDetails.js +0 -23
- package/dist/model/teamPageDetails.js.map +0 -1
- package/dist/model/teamResponse.d.ts +0 -19
- package/dist/model/teamResponse.js +0 -38
- package/dist/model/teamResponse.js.map +0 -1
- package/dist/model/teamUpdateRequest.d.ts +0 -15
- package/dist/model/teamUpdateRequest.js +0 -23
- package/dist/model/teamUpdateRequest.js.map +0 -1
- package/dist/model/teamUsers.d.ts +0 -31
- package/dist/model/teamUsers.js +0 -57
- package/dist/model/teamUsers.js.map +0 -1
- package/dist/model/teams.d.ts +0 -17
- package/dist/model/teams.js +0 -33
- package/dist/model/teams.js.map +0 -1
- package/dist/model/template.d.ts +0 -52
- package/dist/model/template.js +0 -129
- package/dist/model/template.js.map +0 -1
- package/dist/model/templateCC.d.ts +0 -15
- package/dist/model/templateCC.js +0 -23
- package/dist/model/templateCC.js.map +0 -1
- package/dist/model/templateCreated.d.ts +0 -14
- package/dist/model/templateCreated.js +0 -18
- package/dist/model/templateCreated.js.map +0 -1
- package/dist/model/templateFiles.d.ts +0 -17
- package/dist/model/templateFiles.js +0 -33
- package/dist/model/templateFiles.js.map +0 -1
- package/dist/model/templateFormFields.d.ts +0 -88
- package/dist/model/templateFormFields.js +0 -260
- package/dist/model/templateFormFields.js.map +0 -1
- package/dist/model/templateGroupSigner.d.ts +0 -15
- package/dist/model/templateGroupSigner.js +0 -23
- package/dist/model/templateGroupSigner.js.map +0 -1
- package/dist/model/templateProperties.d.ts +0 -68
- package/dist/model/templateProperties.js +0 -186
- package/dist/model/templateProperties.js.map +0 -1
- package/dist/model/templateRecords.d.ts +0 -17
- package/dist/model/templateRecords.js +0 -23
- package/dist/model/templateRecords.js.map +0 -1
- package/dist/model/templateRole.d.ts +0 -106
- package/dist/model/templateRole.js +0 -189
- package/dist/model/templateRole.js.map +0 -1
- package/dist/model/templateSenderDetail.d.ts +0 -15
- package/dist/model/templateSenderDetail.js +0 -23
- package/dist/model/templateSenderDetail.js.map +0 -1
- package/dist/model/templateSenderDetails.d.ts +0 -16
- package/dist/model/templateSenderDetails.js +0 -28
- package/dist/model/templateSenderDetails.js.map +0 -1
- package/dist/model/templateShareErrorResponse.d.ts +0 -17
- package/dist/model/templateShareErrorResponse.js +0 -33
- package/dist/model/templateShareErrorResponse.js.map +0 -1
- package/dist/model/templateShareRequest.d.ts +0 -15
- package/dist/model/templateShareRequest.js +0 -18
- package/dist/model/templateShareRequest.js.map +0 -1
- package/dist/model/templateSharedTemplateDetail.d.ts +0 -21
- package/dist/model/templateSharedTemplateDetail.js +0 -30
- package/dist/model/templateSharedTemplateDetail.js.map +0 -1
- package/dist/model/templateSharing.d.ts +0 -15
- package/dist/model/templateSharing.js +0 -18
- package/dist/model/templateSharing.js.map +0 -1
- package/dist/model/templateSignerDetails.d.ts +0 -66
- package/dist/model/templateSignerDetails.js +0 -149
- package/dist/model/templateSignerDetails.js.map +0 -1
- package/dist/model/templateTag.d.ts +0 -17
- package/dist/model/templateTag.js +0 -33
- package/dist/model/templateTag.js.map +0 -1
- package/dist/model/templateTeamShare.d.ts +0 -22
- package/dist/model/templateTeamShare.js +0 -31
- package/dist/model/templateTeamShare.js.map +0 -1
- package/dist/model/templateTeamShareRequest.d.ts +0 -26
- package/dist/model/templateTeamShareRequest.js +0 -40
- package/dist/model/templateTeamShareRequest.js.map +0 -1
- package/dist/model/textTagDefinition.d.ts +0 -91
- package/dist/model/textTagDefinition.js +0 -221
- package/dist/model/textTagDefinition.js.map +0 -1
- package/dist/model/textTagOffset.d.ts +0 -15
- package/dist/model/textTagOffset.js +0 -23
- package/dist/model/textTagOffset.js.map +0 -1
- package/dist/model/updateGroupContact.d.ts +0 -17
- package/dist/model/updateGroupContact.js +0 -28
- package/dist/model/updateGroupContact.js.map +0 -1
- package/dist/model/updateUser.d.ts +0 -28
- package/dist/model/updateUser.js +0 -46
- package/dist/model/updateUser.js.map +0 -1
- package/dist/model/updateUserMetaData.d.ts +0 -17
- package/dist/model/updateUserMetaData.js +0 -23
- package/dist/model/updateUserMetaData.js.map +0 -1
- package/dist/model/userPageDetails.d.ts +0 -15
- package/dist/model/userPageDetails.js +0 -23
- package/dist/model/userPageDetails.js.map +0 -1
- package/dist/model/userProperties.d.ts +0 -26
- package/dist/model/userProperties.js +0 -68
- package/dist/model/userProperties.js.map +0 -1
- package/dist/model/userRecords.d.ts +0 -17
- package/dist/model/userRecords.js +0 -23
- package/dist/model/userRecords.js.map +0 -1
- package/dist/model/usersDetails.d.ts +0 -26
- package/dist/model/usersDetails.js +0 -68
- package/dist/model/usersDetails.js.map +0 -1
- package/dist/model/validation.d.ts +0 -25
- package/dist/model/validation.js +0 -38
- package/dist/model/validation.js.map +0 -1
- package/dist/model/verificationDataRequest.d.ts +0 -18
- package/dist/model/verificationDataRequest.js +0 -38
- package/dist/model/verificationDataRequest.js.map +0 -1
- package/dist/model/viewBrandDetails.d.ts +0 -48
- package/dist/model/viewBrandDetails.js +0 -150
- package/dist/model/viewBrandDetails.js.map +0 -1
- package/dist/model/viewCustomFieldDetails.d.ts +0 -21
- package/dist/model/viewCustomFieldDetails.js +0 -48
- package/dist/model/viewCustomFieldDetails.js.map +0 -1
package/docs/BrandingApi.md
CHANGED
|
@@ -74,14 +74,14 @@ Create the brand.
|
|
|
74
74
|
| **showBuiltInFormFields** | **boolean**| | [optional] [default to true] |
|
|
75
75
|
| **allowCustomFieldCreation** | **boolean**| | [optional] [default to false] |
|
|
76
76
|
| **showSharedCustomFields** | **boolean**| | [optional] [default to false] |
|
|
77
|
-
| **hideDecline** | **boolean**|
|
|
78
|
-
| **hideSave** | **boolean**|
|
|
79
|
-
| **documentExpirySettingsExpiryDateType** | **string**|
|
|
80
|
-
| **documentExpirySettingsExpiryValue** | **number**|
|
|
81
|
-
| **documentExpirySettingsEnableDefaultExpiryAlert** | **boolean**|
|
|
82
|
-
| **documentExpirySettingsEnableAutoReminder** | **boolean**|
|
|
83
|
-
| **documentExpirySettingsReminderDays** | **number**|
|
|
84
|
-
| **documentExpirySettingsReminderCount** | **number**|
|
|
77
|
+
| **hideDecline** | **boolean**| This option prevents signers to decline the document during the signing process. | [optional] |
|
|
78
|
+
| **hideSave** | **boolean**| This option prevents signers to save their changes during the signing process and continue signing later. | [optional] |
|
|
79
|
+
| **documentExpirySettingsExpiryDateType** | **string**| This property represents the type for the expiry date | [optional] |
|
|
80
|
+
| **documentExpirySettingsExpiryValue** | **number**| This property is used to set the expiry value based on the expiry type | [optional] |
|
|
81
|
+
| **documentExpirySettingsEnableDefaultExpiryAlert** | **boolean**| This property will send the expiry alert email before the day of expiry for the pending signers. | [optional] |
|
|
82
|
+
| **documentExpirySettingsEnableAutoReminder** | **boolean**| When auto reminder is enabled, you can select how often to remind in terms of days and select the maximum number of reminders. | [optional] |
|
|
83
|
+
| **documentExpirySettingsReminderDays** | **number**| Remind in terms of days. | [optional] |
|
|
84
|
+
| **documentExpirySettingsReminderCount** | **number**| Number of reminder count. | [optional] |
|
|
85
85
|
| **customDomainSettingsDomainName** | **string**| | [optional] |
|
|
86
86
|
| **customDomainSettingsFromName** | **string**| | [optional] |
|
|
87
87
|
| **signatureFrameSettingsEnableSignatureFrame** | **boolean**| | [optional] [default to false] |
|
|
@@ -119,7 +119,7 @@ Delete the brand.
|
|
|
119
119
|
|
|
120
120
|
|Name | Type | Description | Notes |
|
|
121
121
|
| ------------- | ------------- | ------------- | ------------- |
|
|
122
|
-
| **brandId** | **string**|
|
|
122
|
+
| **brandId** | **string**| | |
|
|
123
123
|
|
|
124
124
|
### Return type
|
|
125
125
|
|
|
@@ -151,7 +151,7 @@ Edit the brand.
|
|
|
151
151
|
|
|
152
152
|
|Name | Type | Description | Notes |
|
|
153
153
|
| ------------- | ------------- | ------------- | ------------- |
|
|
154
|
-
| **brandId** | **string**|
|
|
154
|
+
| **brandId** | **string**| | |
|
|
155
155
|
| **brandName** | **string**| | [optional] |
|
|
156
156
|
| **brandLogo** | **RequestFile****RequestFile**| | [optional] |
|
|
157
157
|
| **backgroundColor** | **string**| | [optional] |
|
|
@@ -171,14 +171,14 @@ Edit the brand.
|
|
|
171
171
|
| **showBuiltInFormFields** | **boolean**| | [optional] [default to true] |
|
|
172
172
|
| **allowCustomFieldCreation** | **boolean**| | [optional] [default to false] |
|
|
173
173
|
| **showSharedCustomFields** | **boolean**| | [optional] [default to false] |
|
|
174
|
-
| **hideDecline** | **boolean**|
|
|
175
|
-
| **hideSave** | **boolean**|
|
|
176
|
-
| **documentExpirySettingsExpiryDateType** | **string**|
|
|
177
|
-
| **documentExpirySettingsExpiryValue** | **number**|
|
|
178
|
-
| **documentExpirySettingsEnableDefaultExpiryAlert** | **boolean**|
|
|
179
|
-
| **documentExpirySettingsEnableAutoReminder** | **boolean**|
|
|
180
|
-
| **documentExpirySettingsReminderDays** | **number**|
|
|
181
|
-
| **documentExpirySettingsReminderCount** | **number**|
|
|
174
|
+
| **hideDecline** | **boolean**| This option prevents signers to decline the document during the signing process. | [optional] |
|
|
175
|
+
| **hideSave** | **boolean**| This option prevents signers to save their changes during the signing process and continue signing later. | [optional] |
|
|
176
|
+
| **documentExpirySettingsExpiryDateType** | **string**| This property represents the type for the expiry date | [optional] |
|
|
177
|
+
| **documentExpirySettingsExpiryValue** | **number**| This property is used to set the expiry value based on the expiry type | [optional] |
|
|
178
|
+
| **documentExpirySettingsEnableDefaultExpiryAlert** | **boolean**| This property will send the expiry alert email before the day of expiry for the pending signers. | [optional] |
|
|
179
|
+
| **documentExpirySettingsEnableAutoReminder** | **boolean**| When auto reminder is enabled, you can select how often to remind in terms of days and select the maximum number of reminders. | [optional] |
|
|
180
|
+
| **documentExpirySettingsReminderDays** | **number**| Remind in terms of days. | [optional] |
|
|
181
|
+
| **documentExpirySettingsReminderCount** | **number**| Number of reminder count. | [optional] |
|
|
182
182
|
| **customDomainSettingsDomainName** | **string**| | [optional] |
|
|
183
183
|
| **customDomainSettingsFromName** | **string**| | [optional] |
|
|
184
184
|
| **signatureFrameSettingsEnableSignatureFrame** | **boolean**| | [optional] [default to false] |
|
|
@@ -216,7 +216,7 @@ Get the specific brand details.
|
|
|
216
216
|
|
|
217
217
|
|Name | Type | Description | Notes |
|
|
218
218
|
| ------------- | ------------- | ------------- | ------------- |
|
|
219
|
-
| **brandId** | **string**|
|
|
219
|
+
| **brandId** | **string**| | |
|
|
220
220
|
|
|
221
221
|
### Return type
|
|
222
222
|
|
|
@@ -248,7 +248,7 @@ Reset default brand.
|
|
|
248
248
|
|
|
249
249
|
|Name | Type | Description | Notes |
|
|
250
250
|
| ------------- | ------------- | ------------- | ------------- |
|
|
251
|
-
| **brandId** | **string**|
|
|
251
|
+
| **brandId** | **string**| | |
|
|
252
252
|
|
|
253
253
|
### Return type
|
|
254
254
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# # CheckboxValidationSettings
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `validationType` | ```string``` | | |
|
|
10
|
+
| `minSelection` | ```number``` | | |
|
|
11
|
+
| `maxSelection` | ```number``` | | |
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
package/docs/ContactsApi.md
CHANGED
|
@@ -91,7 +91,7 @@ Deletes a contact.
|
|
|
91
91
|
|
|
92
92
|
|Name | Type | Description | Notes |
|
|
93
93
|
| ------------- | ------------- | ------------- | ------------- |
|
|
94
|
-
| **id** | **string**|
|
|
94
|
+
| **id** | **string**| | |
|
|
95
95
|
|
|
96
96
|
### Return type
|
|
97
97
|
|
|
@@ -123,7 +123,7 @@ Get summary of the contact.
|
|
|
123
123
|
|
|
124
124
|
|Name | Type | Description | Notes |
|
|
125
125
|
| ------------- | ------------- | ------------- | ------------- |
|
|
126
|
-
| **id** | **string**|
|
|
126
|
+
| **id** | **string**| | |
|
|
127
127
|
|
|
128
128
|
### Return type
|
|
129
129
|
|
|
@@ -155,7 +155,7 @@ Update the contact.
|
|
|
155
155
|
|
|
156
156
|
|Name | Type | Description | Notes |
|
|
157
157
|
| ------------- | ------------- | ------------- | ------------- |
|
|
158
|
-
| **id** | **string**|
|
|
158
|
+
| **id** | **string**| | [optional] |
|
|
159
159
|
| **contactDetails** | [**ContactDetails**](../docs/ContactDetails.md)| The contact details. | [optional] |
|
|
160
160
|
|
|
161
161
|
### Return type
|
|
@@ -35,5 +35,6 @@ Name | Type | Description | Notes
|
|
|
35
35
|
| `formFieldPermission` | [```FormFieldPermission```](FormFieldPermission.md) | | |
|
|
36
36
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
37
37
|
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
38
|
+
| `documentTimeZone` | ```string``` | | |
|
|
38
39
|
|
|
39
40
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
package/docs/CustomFieldApi.md
CHANGED
|
@@ -56,7 +56,7 @@ List the custom fields respective to the brand id.
|
|
|
56
56
|
|
|
57
57
|
|Name | Type | Description | Notes |
|
|
58
58
|
| ------------- | ------------- | ------------- | ------------- |
|
|
59
|
-
| **brandId** | **string**|
|
|
59
|
+
| **brandId** | **string**| | |
|
|
60
60
|
|
|
61
61
|
### Return type
|
|
62
62
|
|
|
@@ -88,7 +88,7 @@ Delete the custom field.
|
|
|
88
88
|
|
|
89
89
|
|Name | Type | Description | Notes |
|
|
90
90
|
| ------------- | ------------- | ------------- | ------------- |
|
|
91
|
-
| **customFieldId** | **string**|
|
|
91
|
+
| **customFieldId** | **string**| | |
|
|
92
92
|
|
|
93
93
|
### Return type
|
|
94
94
|
|
|
@@ -120,7 +120,7 @@ Edit the custom field.
|
|
|
120
120
|
|
|
121
121
|
|Name | Type | Description | Notes |
|
|
122
122
|
| ------------- | ------------- | ------------- | ------------- |
|
|
123
|
-
| **customFieldId** | **string**|
|
|
123
|
+
| **customFieldId** | **string**| | |
|
|
124
124
|
| **brandCustomFieldDetails** | [**BrandCustomFieldDetails**](../docs/BrandCustomFieldDetails.md)| The custom field details. | |
|
|
125
125
|
|
|
126
126
|
### Return type
|
package/docs/CustomFormField.md
CHANGED
|
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
|
|
|
14
14
|
| `value` | ```string``` | | |
|
|
15
15
|
| `fontSize` | ```number``` | | [default to 13] |
|
|
16
16
|
| `font` | ```string``` | | |
|
|
17
|
+
| `groupOptions` | [```Array<GroupOption>```](GroupOption.md) | | |
|
|
18
|
+
| `checkboxValidationSettings` | [```CheckboxValidationSettings```](CheckboxValidationSettings.md) | | |
|
|
17
19
|
| `fontHexColor` | ```string``` | | |
|
|
18
20
|
| `isBoldFont` | ```boolean``` | | |
|
|
19
21
|
| `isItalicFont` | ```boolean``` | | |
|
package/docs/DocumentApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to https://api.boldsign.com.
|
|
|
10
10
|
| [**cancelEditing()**](DocumentApi.md#cancelEditing) | **POST** /v1/document/cancelEditing | Cancels editing for a document that is currently in edit-mode. |
|
|
11
11
|
| [**changeAccessCode()**](DocumentApi.md#changeAccessCode) | **PATCH** /v1/document/changeAccessCode | Changes the access code for the given document signer. |
|
|
12
12
|
| [**changeRecipient()**](DocumentApi.md#changeRecipient) | **PATCH** /v1/document/changeRecipient | Change recipient details of a document. |
|
|
13
|
+
| [**createEmbeddedDocumentCloneUrl()**](DocumentApi.md#createEmbeddedDocumentCloneUrl) | **POST** /v1/document/createEmbeddedCloneUrl | Generates a URL to embeds Clone document process into your application. |
|
|
13
14
|
| [**createEmbeddedEditUrl()**](DocumentApi.md#createEmbeddedEditUrl) | **POST** /v1/document/createEmbeddedEditUrl | Generates an embedded edit URL that allows the document editing process to be integrated into your application. |
|
|
14
15
|
| [**createEmbeddedRequestUrlDocument()**](DocumentApi.md#createEmbeddedRequestUrlDocument) | **POST** /v1/document/createEmbeddedRequestUrl | Generates a send URL which embeds document sending process into your application. |
|
|
15
16
|
| [**deleteDocument()**](DocumentApi.md#deleteDocument) | **DELETE** /v1/document/delete | Delete the document. |
|
|
@@ -44,7 +45,7 @@ The add authentication to recipient.
|
|
|
44
45
|
|
|
45
46
|
|Name | Type | Description | Notes |
|
|
46
47
|
| ------------- | ------------- | ------------- | ------------- |
|
|
47
|
-
| **documentId** | **string**|
|
|
48
|
+
| **documentId** | **string**| | |
|
|
48
49
|
| **accessCodeDetail** | [**AccessCodeDetail**](../docs/AccessCodeDetail.md)| Access code details. | [optional] |
|
|
49
50
|
|
|
50
51
|
### Return type
|
|
@@ -152,8 +153,8 @@ Cancels editing for a document that is currently in edit-mode.
|
|
|
152
153
|
|
|
153
154
|
|Name | Type | Description | Notes |
|
|
154
155
|
| ------------- | ------------- | ------------- | ------------- |
|
|
155
|
-
| **documentId** | **string**|
|
|
156
|
-
| **onBehalfOf** | **string**|
|
|
156
|
+
| **documentId** | **string**| | |
|
|
157
|
+
| **onBehalfOf** | **string**| | [optional] |
|
|
157
158
|
|
|
158
159
|
### Return type
|
|
159
160
|
|
|
@@ -220,7 +221,7 @@ Change recipient details of a document.
|
|
|
220
221
|
|
|
221
222
|
|Name | Type | Description | Notes |
|
|
222
223
|
| ------------- | ------------- | ------------- | ------------- |
|
|
223
|
-
| **documentId** | **string**|
|
|
224
|
+
| **documentId** | **string**| | |
|
|
224
225
|
| **changeRecipient** | [**ChangeRecipient**](../docs/ChangeRecipient.md)| The new recipient details. | |
|
|
225
226
|
|
|
226
227
|
### Return type
|
|
@@ -240,6 +241,39 @@ void (empty response body)
|
|
|
240
241
|
[[Back to Model list]](../README.md#models)
|
|
241
242
|
[[Back to README]](../README.md)
|
|
242
243
|
|
|
244
|
+
## `createEmbeddedDocumentCloneUrl()`
|
|
245
|
+
|
|
246
|
+
```typescript
|
|
247
|
+
createEmbeddedDocumentCloneUrl(documentId: string, embeddedCloneDocumentJsonRequest: EmbeddedCloneDocumentJsonRequest): EmbeddedClonedDocument
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
Generates a URL to embeds Clone document process into your application.
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
### Parameters
|
|
254
|
+
|
|
255
|
+
|Name | Type | Description | Notes |
|
|
256
|
+
| ------------- | ------------- | ------------- | ------------- |
|
|
257
|
+
| **documentId** | **string**| | |
|
|
258
|
+
| **embeddedCloneDocumentJsonRequest** | [**EmbeddedCloneDocumentJsonRequest**](../docs/EmbeddedCloneDocumentJsonRequest.md)| The embedded clone document request body. | [optional] |
|
|
259
|
+
|
|
260
|
+
### Return type
|
|
261
|
+
|
|
262
|
+
[**EmbeddedClonedDocument**](../docs/EmbeddedClonedDocument.md)
|
|
263
|
+
|
|
264
|
+
### Authorization
|
|
265
|
+
|
|
266
|
+
[X-API-KEY](../README.md#X-API-KEY), [Bearer](../README.md#Bearer)
|
|
267
|
+
|
|
268
|
+
### HTTP request headers
|
|
269
|
+
|
|
270
|
+
- **Content-Type**: `application/json`, `multipart/form-data`, `application/x-www-form-urlencoded`
|
|
271
|
+
- **Accept**: `application/json`
|
|
272
|
+
|
|
273
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints)
|
|
274
|
+
[[Back to Model list]](../README.md#models)
|
|
275
|
+
[[Back to README]](../README.md)
|
|
276
|
+
|
|
243
277
|
## `createEmbeddedEditUrl()`
|
|
244
278
|
|
|
245
279
|
```typescript
|
|
@@ -253,7 +287,7 @@ Generates an embedded edit URL that allows the document editing process to be in
|
|
|
253
287
|
|
|
254
288
|
|Name | Type | Description | Notes |
|
|
255
289
|
| ------------- | ------------- | ------------- | ------------- |
|
|
256
|
-
| **documentId** | **string**|
|
|
290
|
+
| **documentId** | **string**| | |
|
|
257
291
|
| **embeddedDocumentEditJsonRequest** | [**EmbeddedDocumentEditJsonRequest**](../docs/EmbeddedDocumentEditJsonRequest.md)| The embedded edit document request body. | [optional] |
|
|
258
292
|
|
|
259
293
|
### Return type
|
|
@@ -318,8 +352,8 @@ Delete the document.
|
|
|
318
352
|
|
|
319
353
|
|Name | Type | Description | Notes |
|
|
320
354
|
| ------------- | ------------- | ------------- | ------------- |
|
|
321
|
-
| **documentId** | **string**|
|
|
322
|
-
| **deletePermanently** | **boolean**|
|
|
355
|
+
| **documentId** | **string**| | |
|
|
356
|
+
| **deletePermanently** | **boolean**| | [optional] [default to false] |
|
|
323
357
|
|
|
324
358
|
### Return type
|
|
325
359
|
|
|
@@ -383,9 +417,9 @@ Download the Attachment.
|
|
|
383
417
|
|
|
384
418
|
|Name | Type | Description | Notes |
|
|
385
419
|
| ------------- | ------------- | ------------- | ------------- |
|
|
386
|
-
| **documentId** | **string**|
|
|
387
|
-
| **attachmentId** | **string**|
|
|
388
|
-
| **onBehalfOf** | **string**|
|
|
420
|
+
| **documentId** | **string**| | |
|
|
421
|
+
| **attachmentId** | **string**| | |
|
|
422
|
+
| **onBehalfOf** | **string**| | [optional] |
|
|
389
423
|
|
|
390
424
|
### Return type
|
|
391
425
|
|
|
@@ -417,8 +451,8 @@ Download the audit trail document.
|
|
|
417
451
|
|
|
418
452
|
|Name | Type | Description | Notes |
|
|
419
453
|
| ------------- | ------------- | ------------- | ------------- |
|
|
420
|
-
| **documentId** | **string**|
|
|
421
|
-
| **onBehalfOf** | **string**|
|
|
454
|
+
| **documentId** | **string**| | |
|
|
455
|
+
| **onBehalfOf** | **string**| | [optional] |
|
|
422
456
|
|
|
423
457
|
### Return type
|
|
424
458
|
|
|
@@ -450,8 +484,8 @@ Download the document.
|
|
|
450
484
|
|
|
451
485
|
|Name | Type | Description | Notes |
|
|
452
486
|
| ------------- | ------------- | ------------- | ------------- |
|
|
453
|
-
| **documentId** | **string**|
|
|
454
|
-
| **onBehalfOf** | **string**|
|
|
487
|
+
| **documentId** | **string**| | |
|
|
488
|
+
| **onBehalfOf** | **string**| | [optional] |
|
|
455
489
|
|
|
456
490
|
### Return type
|
|
457
491
|
|
|
@@ -483,7 +517,7 @@ Sends a draft-status document out for signature.
|
|
|
483
517
|
|
|
484
518
|
|Name | Type | Description | Notes |
|
|
485
519
|
| ------------- | ------------- | ------------- | ------------- |
|
|
486
|
-
| **documentId** | **string**|
|
|
520
|
+
| **documentId** | **string**| | |
|
|
487
521
|
|
|
488
522
|
### Return type
|
|
489
523
|
|
|
@@ -515,7 +549,7 @@ Edit and updates an existing document.
|
|
|
515
549
|
|
|
516
550
|
|Name | Type | Description | Notes |
|
|
517
551
|
| ------------- | ------------- | ------------- | ------------- |
|
|
518
|
-
| **documentId** | **string**|
|
|
552
|
+
| **documentId** | **string**| | |
|
|
519
553
|
| **editDocumentRequest** | [**EditDocumentRequest**](../docs/EditDocumentRequest.md)| Edit document JSON request. | [optional] |
|
|
520
554
|
|
|
521
555
|
### Return type
|
|
@@ -548,7 +582,7 @@ Extends the expiration date of the document.
|
|
|
548
582
|
|
|
549
583
|
|Name | Type | Description | Notes |
|
|
550
584
|
| ------------- | ------------- | ------------- | ------------- |
|
|
551
|
-
| **documentId** | **string**|
|
|
585
|
+
| **documentId** | **string**| | |
|
|
552
586
|
| **extendExpiry** | [**ExtendExpiry**](../docs/ExtendExpiry.md)| The new expiry value should be specified in yyyy-MM-dd format for days type, ISO date time format for specific date time and integer for hours type. | [optional] |
|
|
553
587
|
|
|
554
588
|
### Return type
|
|
@@ -581,7 +615,7 @@ Get summary of the document.
|
|
|
581
615
|
|
|
582
616
|
|Name | Type | Description | Notes |
|
|
583
617
|
| ------------- | ------------- | ------------- | ------------- |
|
|
584
|
-
| **documentId** | **string**|
|
|
618
|
+
| **documentId** | **string**| | |
|
|
585
619
|
|
|
586
620
|
### Return type
|
|
587
621
|
|
|
@@ -694,7 +728,7 @@ Updates the value (prefill) of the fields in the document.
|
|
|
694
728
|
|
|
695
729
|
|Name | Type | Description | Notes |
|
|
696
730
|
| ------------- | ------------- | ------------- | ------------- |
|
|
697
|
-
| **documentId** | **string**|
|
|
731
|
+
| **documentId** | **string**| | |
|
|
698
732
|
| **prefillFieldRequest** | [**PrefillFieldRequest**](../docs/PrefillFieldRequest.md)| The prefill field request. | |
|
|
699
733
|
|
|
700
734
|
### Return type
|
|
@@ -727,8 +761,8 @@ Send reminder to pending signers.
|
|
|
727
761
|
|
|
728
762
|
|Name | Type | Description | Notes |
|
|
729
763
|
| ------------- | ------------- | ------------- | ------------- |
|
|
730
|
-
| **documentId** | **string**|
|
|
731
|
-
| **receiverEmails** | [**Array<string>**](../docs/string.md)|
|
|
764
|
+
| **documentId** | **string**| | |
|
|
765
|
+
| **receiverEmails** | [**Array<string>**](../docs/string.md)| | [optional] |
|
|
732
766
|
| **reminderMessage** | [**ReminderMessage**](../docs/ReminderMessage.md)| Reminder Message for signers. | [optional] |
|
|
733
767
|
|
|
734
768
|
### Return type
|
|
@@ -794,7 +828,7 @@ Revoke the document.
|
|
|
794
828
|
|
|
795
829
|
|Name | Type | Description | Notes |
|
|
796
830
|
| ------------- | ------------- | ------------- | ------------- |
|
|
797
|
-
| **documentId** | **string**|
|
|
831
|
+
| **documentId** | **string**| | |
|
|
798
832
|
| **revokeDocument** | [**RevokeDocument**](../docs/RevokeDocument.md)| RevokeDetails. | |
|
|
799
833
|
|
|
800
834
|
### Return type
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# # DocumentCcWebhookModel
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `emailAddress` | ```string``` | | |
|
|
10
|
+
| `id` | ```string``` | | |
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# # DocumentEvent
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `object` | ```string``` | | |
|
|
10
|
+
| `documentId` | ```string``` | | |
|
|
11
|
+
| `messageTitle` | ```string``` | | |
|
|
12
|
+
| `documentDescription` | ```string``` | | |
|
|
13
|
+
| `status` | ```string``` | | |
|
|
14
|
+
| `senderDetail` | [```DocumentSender```](DocumentSender.md) | | |
|
|
15
|
+
| `signerDetails` | [```Array<DocumentSignerWebhookModel>```](DocumentSignerWebhookModel.md) | | |
|
|
16
|
+
| `ccDetails` | [```Array<DocumentCcWebhookModel>```](DocumentCcWebhookModel.md) | | |
|
|
17
|
+
| `onBehalfOf` | ```string``` | | |
|
|
18
|
+
| `createdDate` | ```Date``` | | |
|
|
19
|
+
| `expiryDate` | ```Date``` | | |
|
|
20
|
+
| `enableSigningOrder` | ```boolean``` | | |
|
|
21
|
+
| `disableEmails` | ```boolean``` | | |
|
|
22
|
+
| `revokeMessage` | ```string``` | | |
|
|
23
|
+
| `errorMessage` | ```string``` | | |
|
|
24
|
+
| `labels` | ```Array<string>``` | | |
|
|
25
|
+
| `isCombinedAudit` | ```boolean``` | | |
|
|
26
|
+
| `isCombinedAttachment` | ```boolean``` | | |
|
|
27
|
+
| `brandId` | ```string``` | | |
|
|
28
|
+
| `documentDownloadOption` | ```string``` | | |
|
|
29
|
+
| `metaData` | ```{ [key: string]: string | null; }``` | | |
|
|
30
|
+
| `failedDeliveryMode` | ```string``` | | |
|
|
31
|
+
| `behalfOf` | [```BehalfOfWebhookModel```](BehalfOfWebhookModel.md) | | |
|
|
32
|
+
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
33
|
+
| `groupSignerSettings` | [```GroupSignerSettingsWebhookModel```](GroupSignerSettingsWebhookModel.md) | | |
|
|
34
|
+
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
35
|
+
| `documentTimeZone` | ```string``` | | |
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# # DocumentGroupSignerWebhookModel
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `id` | ```string``` | | |
|
|
10
|
+
| `signerEmail` | ```string``` | | |
|
|
11
|
+
| `signerName` | ```string``` | | |
|
|
12
|
+
| `status` | ```string``` | | |
|
|
13
|
+
| `isViewed` | ```boolean``` | | |
|
|
14
|
+
| `isDeliveryFailed` | ```boolean``` | | |
|
|
15
|
+
| `isAuthenticationFailed` | ```boolean``` | | |
|
|
16
|
+
| `lastReminderSentOn` | ```Date``` | | |
|
|
17
|
+
|
|
18
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -53,5 +53,6 @@ Name | Type | Description | Notes
|
|
|
53
53
|
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
54
54
|
| `isCombinedAudit` | ```boolean``` | | |
|
|
55
55
|
| `isCombinedAttachment` | ```boolean``` | | |
|
|
56
|
+
| `documentTimeZone` | ```string``` | | |
|
|
56
57
|
|
|
57
58
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# # DocumentSender
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `name` | ```string``` | | |
|
|
10
|
+
| `emailAddress` | ```string``` | | |
|
|
11
|
+
| `userId` | ```string``` | | |
|
|
12
|
+
| `teamId` | ```string``` | | |
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
package/docs/DocumentSigner.md
CHANGED
|
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
| `deliveryMode` | ```string``` | | |
|
|
16
16
|
| `authenticationCode` | ```string``` | | |
|
|
17
17
|
| `identityVerificationSettings` | [```IdentityVerificationSettings```](IdentityVerificationSettings.md) | | |
|
|
18
|
+
| `kbaSettings` | [```KbaSettings```](KbaSettings.md) | | |
|
|
18
19
|
| `signerOrder` | ```number``` | | |
|
|
19
20
|
| `enableEmailOTP` | ```boolean``` | | |
|
|
20
21
|
| `signerType` | ```string``` | | |
|
|
@@ -31,6 +31,7 @@ Name | Type | Description | Notes
|
|
|
31
31
|
| `groupId` | ```string``` | | |
|
|
32
32
|
| `phoneNumber` | [```PhoneNumber```](PhoneNumber.md) | | |
|
|
33
33
|
| `idVerification` | [```IdVerificationDetails```](IdVerificationDetails.md) | | |
|
|
34
|
+
| `kba` | [```KbaDetails```](KbaDetails.md) | | |
|
|
34
35
|
| `recipientNotificationSettings` | [```RecipientNotificationSettings```](RecipientNotificationSettings.md) | | |
|
|
35
36
|
| `authenticationRetryCount` | ```number``` | | |
|
|
36
37
|
| `enableQes` | ```boolean``` | | |
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# # DocumentSignerWebhookModel
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `signerName` | ```string``` | | |
|
|
10
|
+
| `signerRole` | ```string``` | | |
|
|
11
|
+
| `signerEmail` | ```string``` | | |
|
|
12
|
+
| `id` | ```string``` | | |
|
|
13
|
+
| `groupSigners` | [```Array<DocumentGroupSignerWebhookModel>```](DocumentGroupSignerWebhookModel.md) | | |
|
|
14
|
+
| `phoneNumber` | [```PhoneNumberWebhookModel```](PhoneNumberWebhookModel.md) | | |
|
|
15
|
+
| `status` | ```string``` | | |
|
|
16
|
+
| `enableAccessCode` | ```boolean``` | | |
|
|
17
|
+
| `isAuthenticationFailed` | ```boolean``` | | |
|
|
18
|
+
| `enableEmailOTP` | ```boolean``` | | |
|
|
19
|
+
| `isDeliveryFailed` | ```boolean``` | | |
|
|
20
|
+
| `isViewed` | ```boolean``` | | |
|
|
21
|
+
| `order` | ```number``` | | |
|
|
22
|
+
| `signerType` | ```string``` | | |
|
|
23
|
+
| `signType` | ```string``` | | |
|
|
24
|
+
| `groupId` | ```string``` | | |
|
|
25
|
+
| `isReassigned` | ```boolean``` | | |
|
|
26
|
+
| `reassignMessage` | ```string``` | | |
|
|
27
|
+
| `declineMessage` | ```string``` | | |
|
|
28
|
+
| `lastActivityDate` | ```Date``` | | |
|
|
29
|
+
| `authenticationType` | ```string``` | | |
|
|
30
|
+
| `idVerification` | [```IdVerificationSignerWebhookModel```](IdVerificationSignerWebhookModel.md) | | |
|
|
31
|
+
| `kba` | [```KbaSignerWebhookModel```](KbaSignerWebhookModel.md) | | |
|
|
32
|
+
| `allowFieldConfiguration` | ```boolean``` | | |
|
|
33
|
+
| `lastReminderSentOn` | ```Date``` | | |
|
|
34
|
+
| `authenticationRetryCount` | ```number``` | | |
|
|
35
|
+
| `authenticationSettings` | [```SignerAuthenticationWebhookModel```](SignerAuthenticationWebhookModel.md) | | |
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# # EditDocumentJsonFile
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `editAction`<sup>*_required_</sup> | ```string``` | | |
|
|
10
|
+
| `file` | [```Base64File```](Base64File.md) | | |
|
|
11
|
+
| `fileUrl` | ```string``` | | |
|
|
12
|
+
| `id` | ```string``` | | |
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -37,5 +37,6 @@ Name | Type | Description | Notes
|
|
|
37
37
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
38
38
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
39
39
|
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
40
|
+
| `documentTimeZone` | ```string``` | | |
|
|
40
41
|
|
|
41
42
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
| `deliveryMode` | ```string``` | | |
|
|
17
17
|
| `authenticationCode` | ```string``` | | |
|
|
18
18
|
| `identityVerificationSettings` | [```IdentityVerificationSettings```](IdentityVerificationSettings.md) | | |
|
|
19
|
+
| `kbaSettings` | [```KbaSettings```](KbaSettings.md) | | |
|
|
19
20
|
| `signerOrder` | ```number``` | | |
|
|
20
21
|
| `enableEmailOTP` | ```boolean``` | | |
|
|
21
22
|
| `signerType` | ```string``` | | |
|
|
@@ -30,5 +30,6 @@ Name | Type | Description | Notes
|
|
|
30
30
|
| `formFieldPermission` | [```FormFieldPermission```](FormFieldPermission.md) | | |
|
|
31
31
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
32
32
|
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
33
|
+
| `documentTimeZone` | ```string``` | | |
|
|
33
34
|
|
|
34
35
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# # EmbeddedCloneDocumentJsonRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `redirectUrl` | ```string``` | | |
|
|
10
|
+
| `viewOption` | ```string``` | | [default to ViewOptionEnum.PreparePage] |
|
|
11
|
+
| `showSaveButton` | ```boolean``` | | [default to true] |
|
|
12
|
+
| `showPreviewButton` | ```boolean``` | | [default to true] |
|
|
13
|
+
| `showNavigationButtons` | ```boolean``` | | [default to true] |
|
|
14
|
+
| `linkValidTill` | ```Date``` | | |
|
|
15
|
+
| `includeFormFieldValues` | ```boolean``` | | [default to false] |
|
|
16
|
+
| `locale` | ```string``` | | [default to LocaleEnum.En] |
|
|
17
|
+
| `showSendButton` | ```boolean``` | | [default to true] |
|
|
18
|
+
| `showToolbar` | ```boolean``` | | [default to false] |
|
|
19
|
+
| `showTooltip` | ```boolean``` | | [default to false] |
|
|
20
|
+
| `onBehalfOf` | ```string``` | | |
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# # EmbeddedCloneTemplateJsonRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `redirectUrl` | ```string``` | | |
|
|
10
|
+
| `viewOption` | ```string``` | | [default to ViewOptionEnum.PreparePage] |
|
|
11
|
+
| `showSaveButton` | ```boolean``` | | [default to true] |
|
|
12
|
+
| `showPreviewButton` | ```boolean``` | | [default to true] |
|
|
13
|
+
| `showNavigationButtons` | ```boolean``` | | [default to true] |
|
|
14
|
+
| `linkValidTill` | ```Date``` | | |
|
|
15
|
+
| `includeFormFieldValues` | ```boolean``` | | [default to false] |
|
|
16
|
+
| `locale` | ```string``` | | [default to LocaleEnum.En] |
|
|
17
|
+
| `showCreateButton` | ```boolean``` | | [default to true] |
|
|
18
|
+
| `showToolbar` | ```boolean``` | | [default to false] |
|
|
19
|
+
| `showTooltip` | ```boolean``` | | [default to false] |
|
|
20
|
+
| `onBehalfOf` | ```string``` | | |
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# # EmbeddedClonedDocument
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `documentId` | ```string``` | | |
|
|
10
|
+
| `embedUrl` | ```string``` | | |
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# # EmbeddedClonedTemplate
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `templateId` | ```string``` | | |
|
|
10
|
+
| `embedUrl` | ```string``` | | |
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -46,5 +46,6 @@ Name | Type | Description | Notes
|
|
|
46
46
|
| `formFieldPermission` | [```FormFieldPermission```](FormFieldPermission.md) | | |
|
|
47
47
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
48
48
|
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
49
|
+
| `documentTimeZone` | ```string``` | | |
|
|
49
50
|
|
|
50
51
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -54,5 +54,6 @@ Name | Type | Description | Notes
|
|
|
54
54
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
55
55
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
56
56
|
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
57
|
+
| `documentTimeZone` | ```string``` | | |
|
|
57
58
|
|
|
58
59
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -55,5 +55,6 @@ Name | Type | Description | Notes
|
|
|
55
55
|
| `allowedSignatureTypes` | ```Array<string>``` | | |
|
|
56
56
|
| `groupSignerSettings` | [```GroupSignerSettings```](GroupSignerSettings.md) | | |
|
|
57
57
|
| `enableAllowSignEverywhere` | ```boolean``` | | |
|
|
58
|
+
| `documentTimeZone` | ```string``` | | |
|
|
58
59
|
|
|
59
60
|
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|