boldsign 1.0.3 → 2.0.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 +157 -156
- package/.openapi-generator/VERSION +1 -1
- package/.openapi-generator-ignore +23 -23
- package/LICENSE +21 -21
- package/README.md +307 -306
- package/api/apis.ts +163 -163
- package/api/brandingApi.ts +1193 -1183
- package/api/contactsApi.ts +772 -772
- package/api/customFieldApi.ts +817 -817
- package/api/documentApi.ts +2953 -2953
- package/api/identityVerificationApi.ts +586 -586
- package/api/index.ts +36 -36
- package/api/planApi.ts +274 -274
- package/api/senderIdentitiesApi.ts +898 -898
- package/api/teamsApi.ts +661 -661
- package/api/templateApi.ts +1915 -1915
- package/api/userApi.ts +968 -968
- package/api.ts +3 -3
- package/boldsign-2.0.0.tgz +0 -0
- package/dist/api/apis.d.ts +1 -1
- package/dist/api/apis.js +1 -1
- package/dist/api/brandingApi.d.ts +2 -2
- package/dist/api/brandingApi.js +10 -4
- package/dist/api/brandingApi.js.map +1 -1
- package/dist/model/auditTrail.d.ts +3 -1
- package/dist/model/auditTrail.js +2 -0
- package/dist/model/auditTrail.js.map +1 -1
- package/dist/model/collaborationSettings.d.ts +17 -0
- package/dist/model/collaborationSettings.js +33 -0
- package/dist/model/collaborationSettings.js.map +1 -0
- package/dist/model/createTemplateRequest.d.ts +1 -1
- package/dist/model/createTemplateRequest.js +5 -5
- package/dist/model/createTemplateRequest.js.map +1 -1
- package/dist/model/documentFiles.d.ts +1 -0
- package/dist/model/documentFiles.js +5 -0
- package/dist/model/documentFiles.js.map +1 -1
- package/dist/model/documentFormFields.d.ts +4 -0
- package/dist/model/documentFormFields.js +15 -0
- package/dist/model/documentFormFields.js.map +1 -1
- package/dist/model/documentSigner.d.ts +1 -0
- package/dist/model/documentSigner.js +5 -0
- package/dist/model/documentSigner.js.map +1 -1
- package/dist/model/documentSignerDetails.d.ts +1 -0
- package/dist/model/documentSignerDetails.js +5 -0
- package/dist/model/documentSignerDetails.js.map +1 -1
- package/dist/model/embeddedCreateTemplateRequest.d.ts +1 -1
- package/dist/model/embeddedCreateTemplateRequest.js +5 -5
- package/dist/model/embeddedCreateTemplateRequest.js.map +1 -1
- package/dist/model/embeddedDocumentRequest.d.ts +1 -1
- package/dist/model/embeddedDocumentRequest.js +5 -5
- package/dist/model/embeddedDocumentRequest.js.map +1 -1
- package/dist/model/embeddedMergeTemplateFormRequest.d.ts +1 -1
- package/dist/model/embeddedMergeTemplateFormRequest.js +5 -5
- package/dist/model/embeddedMergeTemplateFormRequest.js.map +1 -1
- package/dist/model/embeddedSendTemplateFormRequest.d.ts +1 -1
- package/dist/model/embeddedSendTemplateFormRequest.js +5 -5
- package/dist/model/embeddedSendTemplateFormRequest.js.map +1 -1
- package/dist/model/formField.d.ts +2 -0
- package/dist/model/formField.js +5 -0
- package/dist/model/formField.js.map +1 -1
- package/dist/model/index.d.ts +2 -1
- package/dist/model/index.js +6 -3
- package/dist/model/index.js.map +1 -1
- package/dist/model/mergeAndSendForSignForm.d.ts +1 -1
- package/dist/model/mergeAndSendForSignForm.js +5 -5
- package/dist/model/mergeAndSendForSignForm.js.map +1 -1
- package/dist/model/sendForSign.d.ts +1 -1
- package/dist/model/sendForSign.js +5 -5
- package/dist/model/sendForSign.js.map +1 -1
- package/dist/model/sendForSignFromTemplateForm.d.ts +1 -1
- package/dist/model/sendForSignFromTemplateForm.js +5 -5
- package/dist/model/sendForSignFromTemplateForm.js.map +1 -1
- package/dist/model/templateFormFields.d.ts +2 -0
- package/dist/model/templateFormFields.js +5 -0
- package/dist/model/templateFormFields.js.map +1 -1
- package/dist/model/textTagDefinition.d.ts +2 -0
- package/dist/model/textTagDefinition.js +5 -0
- package/dist/model/textTagDefinition.js.map +1 -1
- package/dist/model/viewBrandDetails.d.ts +1 -0
- package/dist/model/viewBrandDetails.js +5 -0
- package/dist/model/viewBrandDetails.js.map +1 -1
- package/dist/tests/config.d.ts +5 -0
- package/dist/tests/config.js +43 -0
- package/dist/tests/config.js.map +1 -0
- package/dist/tests/integration/BrandingApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/BrandingApiTest.spec.js +310 -0
- package/dist/tests/integration/BrandingApiTest.spec.js.map +1 -0
- package/dist/tests/integration/ContactsApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/ContactsApiTest.spec.js +249 -0
- package/dist/tests/integration/ContactsApiTest.spec.js.map +1 -0
- package/dist/tests/integration/CustomFieldApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/CustomFieldApiTest.spec.js +289 -0
- package/dist/tests/integration/CustomFieldApiTest.spec.js.map +1 -0
- package/dist/tests/integration/DocumentApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/DocumentApiTest.spec.js +1710 -0
- package/dist/tests/integration/DocumentApiTest.spec.js.map +1 -0
- package/dist/tests/integration/IdentityVerificationApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/IdentityVerificationApiTest.spec.js +160 -0
- package/dist/tests/integration/IdentityVerificationApiTest.spec.js.map +1 -0
- package/dist/tests/integration/TemplateApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/TemplateApiTest.spec.js +1518 -0
- package/dist/tests/integration/TemplateApiTest.spec.js.map +1 -0
- package/dist/tests/integration/planApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/planApiTest.spec.js +41 -0
- package/dist/tests/integration/planApiTest.spec.js.map +1 -0
- package/dist/tests/integration/senderIdentity.spec.d.ts +1 -0
- package/dist/tests/integration/senderIdentity.spec.js +481 -0
- package/dist/tests/integration/senderIdentity.spec.js.map +1 -0
- package/dist/tests/integration/teamsApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/teamsApiTest.spec.js +230 -0
- package/dist/tests/integration/teamsApiTest.spec.js.map +1 -0
- package/dist/tests/integration/usersApiTest.spec.d.ts +1 -0
- package/dist/tests/integration/usersApiTest.spec.js +290 -0
- package/dist/tests/integration/usersApiTest.spec.js.map +1 -0
- package/dist/tests/performance/performanceApiTest.spec.d.ts +1 -0
- package/dist/tests/performance/performanceApiTest.spec.js +368 -0
- package/dist/tests/performance/performanceApiTest.spec.js.map +1 -0
- package/dist/tests/unit/brandingApi.spec.d.ts +1 -0
- package/dist/tests/unit/brandingApi.spec.js +174 -0
- package/dist/tests/unit/brandingApi.spec.js.map +1 -0
- package/dist/tests/unit/contactsApi.spec.d.ts +1 -0
- package/dist/tests/unit/contactsApi.spec.js +154 -0
- package/dist/tests/unit/contactsApi.spec.js.map +1 -0
- package/dist/tests/unit/customFieldApi.spec.d.ts +1 -0
- package/dist/tests/unit/customFieldApi.spec.js +140 -0
- package/dist/tests/unit/customFieldApi.spec.js.map +1 -0
- package/dist/tests/unit/documentApi.spec.d.ts +1 -0
- package/dist/tests/unit/documentApi.spec.js +476 -0
- package/dist/tests/unit/documentApi.spec.js.map +1 -0
- package/dist/tests/unit/planApi.spec.d.ts +1 -0
- package/dist/tests/unit/planApi.spec.js +69 -0
- package/dist/tests/unit/planApi.spec.js.map +1 -0
- package/dist/tests/unit/senderIdentitiesApi.spec.d.ts +1 -0
- package/dist/tests/unit/senderIdentitiesApi.spec.js +148 -0
- package/dist/tests/unit/senderIdentitiesApi.spec.js.map +1 -0
- package/dist/tests/unit/teamApi.spec.d.ts +1 -0
- package/dist/tests/unit/teamApi.spec.js +116 -0
- package/dist/tests/unit/teamApi.spec.js.map +1 -0
- package/dist/tests/unit/templateApi.spec.d.ts +1 -0
- package/dist/tests/unit/templateApi.spec.js +285 -0
- package/dist/tests/unit/templateApi.spec.js.map +1 -0
- package/dist/tests/unit/userApi.spec.d.ts +1 -0
- package/dist/tests/unit/userApi.spec.js +163 -0
- package/dist/tests/unit/userApi.spec.js.map +1 -0
- package/docs/AccessCodeDetail.md +19 -19
- package/docs/AccessCodeDetails.md +13 -13
- package/docs/Added.md +13 -13
- package/docs/Address.md +16 -16
- package/docs/AttachmentInfo.md +14 -14
- package/docs/AuditTrail.md +21 -21
- package/docs/AuthenticationSettings.md +11 -11
- package/docs/Base64File.md +12 -12
- package/docs/BehalfDocument.md +27 -27
- package/docs/BehalfDocumentRecords.md +12 -12
- package/docs/BehalfOf.md +12 -12
- package/docs/BillingViewModel.md +11 -11
- package/docs/BrandCreated.md +11 -11
- package/docs/BrandCustomFieldDetails.md +16 -16
- package/docs/BrandingApi.md +260 -258
- package/docs/BrandingMessage.md +11 -11
- package/docs/BrandingRecords.md +11 -11
- package/docs/ChangeRecipient.md +18 -18
- package/docs/CollaborationSettings.md +14 -0
- package/docs/ConditionalRule.md +13 -13
- package/docs/ContactCreated.md +12 -12
- package/docs/ContactDetails.md +15 -15
- package/docs/ContactPageDetails.md +13 -13
- package/docs/ContactsApi.md +176 -176
- package/docs/ContactsDetails.md +16 -16
- package/docs/ContactsList.md +12 -12
- package/docs/CreateContactResponse.md +11 -11
- package/docs/CreateSenderIdentityRequest.md +16 -16
- package/docs/CreateTeamRequest.md +11 -11
- package/docs/CreateTemplateRequest.md +35 -35
- package/docs/CreateUser.md +14 -14
- package/docs/CustomDomainSettings.md +12 -12
- package/docs/CustomFieldApi.md +174 -174
- package/docs/CustomFieldCollection.md +11 -11
- package/docs/CustomFieldMessage.md +12 -12
- package/docs/CustomFormField.md +43 -43
- package/docs/Date.md +13 -13
- package/docs/DeleteCustomFieldReply.md +11 -11
- package/docs/Document.md +26 -26
- package/docs/DocumentApi.md +756 -756
- package/docs/DocumentCC.md +11 -11
- package/docs/DocumentCcDetails.md +12 -12
- package/docs/DocumentCreated.md +11 -11
- package/docs/DocumentExpirySettings.md +16 -16
- package/docs/DocumentFiles.md +14 -13
- package/docs/DocumentFormFields.md +52 -49
- package/docs/DocumentInfo.md +14 -14
- package/docs/DocumentProperties.md +50 -50
- package/docs/DocumentReassign.md +13 -13
- package/docs/DocumentRecords.md +12 -12
- package/docs/DocumentSenderDetail.md +14 -14
- package/docs/DocumentSigner.md +32 -31
- package/docs/DocumentSignerDetails.md +38 -37
- package/docs/DocumentTags.md +12 -12
- package/docs/DownloadImageRequest.md +16 -16
- package/docs/EditSenderIdentityRequest.md +14 -14
- package/docs/EditTemplateRequest.md +29 -29
- package/docs/EditableDateFieldSettings.md +13 -13
- package/docs/EmbeddedCreateTemplateRequest.md +46 -46
- package/docs/EmbeddedCustomFieldCreated.md +11 -11
- package/docs/EmbeddedDocumentRequest.md +55 -55
- package/docs/EmbeddedFileDetails.md +16 -16
- package/docs/EmbeddedFileLink.md +11 -11
- package/docs/EmbeddedMergeTemplateFormRequest.md +56 -56
- package/docs/EmbeddedSendCreated.md +12 -12
- package/docs/EmbeddedSendTemplateFormRequest.md +53 -53
- package/docs/EmbeddedSigningLink.md +11 -11
- package/docs/EmbeddedTemplateCreated.md +12 -12
- package/docs/EmbeddedTemplateEditRequest.md +21 -21
- package/docs/EmbeddedTemplateEdited.md +11 -11
- package/docs/Error.md +12 -12
- package/docs/ErrorResult.md +11 -11
- package/docs/ExistingFormField.md +15 -15
- package/docs/ExtendExpiry.md +14 -14
- package/docs/FileInfo.md +14 -14
- package/docs/Font.md +18 -18
- package/docs/FormField.md +51 -50
- package/docs/FormGroup.md +15 -15
- package/docs/FormulaFieldSettings.md +12 -12
- package/docs/IdDocument.md +21 -21
- package/docs/IdReport.md +14 -14
- package/docs/IdVerification.md +18 -18
- package/docs/IdentityVerificationApi.md +109 -109
- package/docs/IdentityVerificationSettings.md +16 -16
- package/docs/ImageInfo.md +13 -13
- package/docs/MergeAndSendForSignForm.md +46 -46
- package/docs/ModificationDetails.md +12 -12
- package/docs/NotificationSettings.md +22 -22
- package/docs/PageDetails.md +16 -16
- package/docs/PhoneNumber.md +12 -12
- package/docs/PlanApi.md +38 -38
- package/docs/PrefillField.md +12 -12
- package/docs/PrefillFieldRequest.md +12 -12
- package/docs/ProblemDetails.md +15 -15
- package/docs/RecipientChangeLog.md +12 -12
- package/docs/RecipientNotificationSettings.md +22 -22
- package/docs/Rectangle.md +14 -14
- package/docs/ReminderMessage.md +13 -13
- package/docs/ReminderSettings.md +13 -13
- package/docs/RemoveAuthentication.md +14 -14
- package/docs/Removed.md +13 -13
- package/docs/RevokeDocument.md +12 -12
- package/docs/Role.md +33 -33
- package/docs/Roles.md +33 -33
- package/docs/SendForSign.md +45 -45
- package/docs/SendForSignFromTemplateForm.md +43 -43
- package/docs/SenderIdentitiesApi.md +209 -209
- package/docs/SenderIdentityCreated.md +11 -11
- package/docs/SenderIdentityList.md +12 -12
- package/docs/SenderIdentityViewModel.md +19 -19
- package/docs/SignerAuthenticationSettings.md +12 -12
- package/docs/Size.md +12 -12
- package/docs/TeamCreated.md +11 -11
- package/docs/TeamDocumentRecords.md +12 -12
- package/docs/TeamListResponse.md +12 -12
- package/docs/TeamPageDetails.md +12 -12
- package/docs/TeamResponse.md +15 -15
- package/docs/TeamUpdateRequest.md +12 -12
- package/docs/TeamUsers.md +16 -16
- package/docs/Teams.md +14 -14
- package/docs/TeamsApi.md +141 -141
- package/docs/Template.md +29 -29
- package/docs/TemplateApi.md +484 -484
- package/docs/TemplateCC.md +12 -12
- package/docs/TemplateCreated.md +11 -11
- package/docs/TemplateFormFields.md +51 -50
- package/docs/TemplateProperties.md +37 -37
- package/docs/TemplateRecords.md +12 -12
- package/docs/TemplateRole.md +28 -28
- package/docs/TemplateSenderDetail.md +12 -12
- package/docs/TemplateSenderDetails.md +13 -13
- package/docs/TemplateSharedTemplateDetail.md +12 -12
- package/docs/TemplateSignerDetails.md +27 -27
- package/docs/TemplateTag.md +14 -14
- package/docs/TextTagDefinition.md +41 -40
- package/docs/TextTagOffset.md +12 -12
- package/docs/UpdateUser.md +14 -14
- package/docs/UpdateUserMetaData.md +12 -12
- package/docs/UserApi.md +240 -240
- package/docs/UserPageDetails.md +12 -12
- package/docs/UserProperties.md +21 -21
- package/docs/UserRecords.md +12 -12
- package/docs/UsersDetails.md +21 -21
- package/docs/Validation.md +13 -13
- package/docs/VerificationDataRequest.md +15 -15
- package/docs/ViewBrandDetails.md +35 -34
- package/docs/ViewCustomFieldDetails.md +17 -17
- package/examples/DocumentProperties.ts +14 -14
- package/examples/brandCreate.ts +28 -28
- package/examples/brandDelete.ts +14 -14
- package/examples/brandGet.ts +14 -14
- package/examples/brandList.ts +13 -13
- package/examples/brandResetDefault.ts +14 -14
- package/examples/brandUpdate.ts +20 -20
- package/examples/contactCreate.ts +25 -25
- package/examples/contactDelete.ts +14 -14
- package/examples/contactGet.ts +14 -14
- package/examples/contactList.ts +15 -15
- package/examples/contactUpdate.ts +25 -25
- package/examples/customFieldCreate.ts +27 -27
- package/examples/customFieldDelete.ts +14 -14
- package/examples/customFieldEdit.ts +29 -29
- package/examples/customFieldEmbeddedCreateUrl.ts +18 -18
- package/examples/customFieldList.ts +14 -14
- package/examples/documentAddAuthentication.ts +19 -19
- package/examples/documentAddTags.ts +18 -18
- package/examples/documentChangeAccessCode.ts +19 -19
- package/examples/documentChangeRecipients.ts +21 -21
- package/examples/documentDelete.ts +15 -15
- package/examples/documentDeleteTags.ts +18 -18
- package/examples/documentDownload.ts +15 -15
- package/examples/documentDownloadAttachment.ts +16 -16
- package/examples/documentDownloadAuditTrial.ts +15 -15
- package/examples/documentEmbeddedRequestLink.ts +48 -48
- package/examples/documentEmbeddedSignLink.ts +22 -22
- package/examples/documentExtendExpiry.ts +19 -19
- package/examples/documentList.ts +18 -18
- package/examples/documentListBehalf.ts +14 -14
- package/examples/documentListTeam.ts +14 -14
- package/examples/documentPrefillFieldCheckBox.ts +22 -22
- package/examples/documentPrefillFieldDropDown.ts +22 -22
- package/examples/documentPrefillFieldEditableDate.ts +22 -22
- package/examples/documentPrefillFieldImage.ts +22 -22
- package/examples/documentPrefillFieldRadioButton.ts +22 -22
- package/examples/documentPrefillFieldTextBox.ts +22 -22
- package/examples/documentRemoveAuthentication.ts +18 -18
- package/examples/documentRevoke.ts +18 -18
- package/examples/documentSend.ts +46 -46
- package/examples/documentSendOnBehalf.ts +52 -52
- package/examples/documentSendReminder.ts +19 -19
- package/examples/embeddedManualVerification.ts +22 -22
- package/examples/identityVerificationImage.ts +23 -23
- package/examples/identityVerificationReport.ts +21 -21
- package/examples/listTemplate.ts +15 -15
- package/examples/plan.ts +13 -13
- package/examples/senderIdentityCreate.ts +20 -20
- package/examples/senderIdentityDelete.ts +14 -14
- package/examples/senderIdentityList.ts +15 -15
- package/examples/senderIdentityRerequest.ts +14 -14
- package/examples/senderIdentityResendInvitation.ts +14 -14
- package/examples/senderIdentityUpdate.ts +19 -19
- package/examples/teamCreate.ts +17 -17
- package/examples/teamGet.ts +14 -14
- package/examples/teamList.ts +15 -15
- package/examples/teamUpdate.ts +18 -18
- package/examples/templateAddTag.ts +19 -19
- package/examples/templateCreate.ts +28 -28
- package/examples/templateDelete.ts +14 -14
- package/examples/templateDeleteTag.ts +19 -19
- package/examples/templateDetails.ts +14 -14
- package/examples/templateDownload.ts +14 -14
- package/examples/templateEdit.ts +21 -21
- package/examples/templateEmbeddedCreate.ts +28 -28
- package/examples/templateEmbeddedEdit.ts +23 -23
- package/examples/templateEmbeddedRequestLink.ts +33 -33
- package/examples/templateMergerEmbeddedRequestUrl.ts +36 -36
- package/examples/templateSendDocument.ts +59 -59
- package/examples/templateSendDocumentUsingMultipleTemplate.ts +39 -39
- package/examples/userCreate.ts +19 -19
- package/examples/userGet.ts +14 -14
- package/examples/userInvitationCancel.ts +14 -14
- package/examples/userList.ts +15 -15
- package/examples/userResendInvitation.ts +14 -14
- package/examples/userUpdateRole.ts +18 -18
- package/git_push.sh +57 -57
- package/model/accessCodeDetail.ts +91 -91
- package/model/accessCodeDetails.ts +44 -44
- package/model/added.ts +43 -43
- package/model/address.ts +61 -61
- package/model/attachmentInfo.ts +49 -49
- package/model/auditTrail.ts +177 -175
- package/model/authenticationSettings.ts +40 -40
- package/model/base64File.ts +37 -37
- package/model/behalfDocument.ts +142 -142
- package/model/behalfDocumentRecords.ts +39 -39
- package/model/behalfOf.ts +37 -37
- package/model/billingViewModel.ts +31 -31
- package/model/brandCreated.ts +31 -31
- package/model/brandCustomFieldDetails.ts +62 -62
- package/model/brandingMessage.ts +31 -31
- package/model/brandingRecords.ts +32 -32
- package/model/changeRecipient.ts +74 -74
- package/model/collaborationSettings.ts +49 -0
- package/model/conditionalRule.ts +43 -43
- package/model/contactCreated.ts +37 -37
- package/model/contactDetails.ts +56 -56
- package/model/contactPageDetails.ts +43 -43
- package/model/contactsDetails.ts +62 -62
- package/model/contactsList.ts +39 -39
- package/model/createContactResponse.ts +32 -32
- package/model/createSenderIdentityRequest.ts +62 -62
- package/model/createTeamRequest.ts +31 -31
- package/model/createTemplateRequest.ts +181 -181
- package/model/createUser.ts +56 -56
- package/model/customDomainSettings.ts +37 -37
- package/model/customFieldCollection.ts +32 -32
- package/model/customFieldMessage.ts +37 -37
- package/model/customFormField.ts +275 -275
- package/model/deleteCustomFieldReply.ts +31 -31
- package/model/document.ts +135 -135
- package/model/documentCC.ts +31 -31
- package/model/documentCcDetails.ts +37 -37
- package/model/documentCreated.ts +31 -31
- package/model/documentExpirySettings.ts +69 -69
- package/model/documentFiles.ts +49 -43
- package/model/documentFormFields.ts +311 -292
- package/model/documentInfo.ts +90 -90
- package/model/documentProperties.ts +316 -316
- package/model/documentReassign.ts +43 -43
- package/model/documentRecords.ts +39 -39
- package/model/documentSenderDetail.ts +49 -49
- package/model/documentSigner.ts +221 -215
- package/model/documentSignerDetails.ts +265 -259
- package/model/documentTags.ts +37 -37
- package/model/downloadImageRequest.ts +61 -61
- package/model/editSenderIdentityRequest.ts +50 -50
- package/model/editTemplateRequest.ts +144 -144
- package/model/editableDateFieldSettings.ts +43 -43
- package/model/embeddedCreateTemplateRequest.ts +271 -271
- package/model/embeddedCustomFieldCreated.ts +31 -31
- package/model/embeddedDocumentRequest.ts +337 -337
- package/model/embeddedFileDetails.ts +61 -61
- package/model/embeddedFileLink.ts +31 -31
- package/model/embeddedMergeTemplateFormRequest.ts +343 -343
- package/model/embeddedSendCreated.ts +37 -37
- package/model/embeddedSendTemplateFormRequest.ts +324 -324
- package/model/embeddedSigningLink.ts +31 -31
- package/model/embeddedTemplateCreated.ts +37 -37
- package/model/embeddedTemplateEditRequest.ts +115 -115
- package/model/embeddedTemplateEdited.ts +31 -31
- package/model/errorResult.ts +31 -31
- package/model/existingFormField.ts +55 -55
- package/model/extendExpiry.ts +49 -49
- package/model/fileInfo.ts +49 -49
- package/model/font.ts +89 -89
- package/model/formField.ts +327 -320
- package/model/formGroup.ts +63 -63
- package/model/formulaFieldSettings.ts +37 -37
- package/model/idDocument.ts +93 -93
- package/model/idReport.ts +50 -50
- package/model/idVerification.ts +73 -73
- package/model/identityVerificationSettings.ts +75 -75
- package/model/imageInfo.ts +43 -43
- package/model/index.ts +546 -543
- package/model/mergeAndSendForSignForm.ts +261 -261
- package/model/modelDate.ts +43 -43
- package/model/modelError.ts +37 -37
- package/model/models.ts +244 -244
- package/model/modificationDetails.ts +37 -37
- package/model/notificationSettings.ts +97 -97
- package/model/pageDetails.ts +61 -61
- package/model/phoneNumber.ts +37 -37
- package/model/prefillField.ts +37 -37
- package/model/prefillFieldRequest.ts +38 -38
- package/model/problemDetails.ts +55 -55
- package/model/recipientChangeLog.ts +39 -39
- package/model/recipientNotificationSettings.ts +97 -97
- package/model/rectangle.ts +49 -49
- package/model/reminderMessage.ts +44 -44
- package/model/reminderSettings.ts +43 -43
- package/model/removeAuthentication.ts +50 -50
- package/model/removed.ts +43 -43
- package/model/revokeDocument.ts +37 -37
- package/model/role.ts +229 -229
- package/model/roles.ts +225 -225
- package/model/sendForSign.ts +255 -255
- package/model/sendForSignFromTemplateForm.ts +242 -242
- package/model/senderIdentityCreated.ts +31 -31
- package/model/senderIdentityList.ts +39 -39
- package/model/senderIdentityViewModel.ts +80 -80
- package/model/signerAuthenticationSettings.ts +37 -37
- package/model/size.ts +37 -37
- package/model/teamCreated.ts +31 -31
- package/model/teamDocumentRecords.ts +39 -39
- package/model/teamListResponse.ts +39 -39
- package/model/teamPageDetails.ts +37 -37
- package/model/teamResponse.ts +56 -56
- package/model/teamUpdateRequest.ts +37 -37
- package/model/teamUsers.ts +73 -73
- package/model/teams.ts +49 -49
- package/model/template.ts +159 -159
- package/model/templateCC.ts +37 -37
- package/model/templateCreated.ts +31 -31
- package/model/templateFormFields.ts +304 -297
- package/model/templateProperties.ts +202 -202
- package/model/templateRecords.ts +39 -39
- package/model/templateRole.ts +195 -195
- package/model/templateSenderDetail.ts +37 -37
- package/model/templateSenderDetails.ts +43 -43
- package/model/templateSharedTemplateDetail.ts +43 -43
- package/model/templateSignerDetails.ts +160 -160
- package/model/templateTag.ts +49 -49
- package/model/textTagDefinition.ts +255 -248
- package/model/textTagOffset.ts +37 -37
- package/model/updateUser.ts +60 -60
- package/model/updateUserMetaData.ts +37 -37
- package/model/userPageDetails.ts +37 -37
- package/model/userProperties.ts +91 -91
- package/model/userRecords.ts +39 -39
- package/model/usersDetails.ts +91 -91
- package/model/validation.ts +52 -52
- package/model/verificationDataRequest.ts +55 -55
- package/model/viewBrandDetails.ts +183 -177
- package/model/viewCustomFieldDetails.ts +68 -68
- package/package.json +52 -52
- package/tests/config.ts +20 -0
- package/tests/documents/agreement.pdf +0 -0
- package/tests/documents/logo.jpg +0 -0
- package/tests/integration/BrandingApiTest.spec.ts +254 -0
- package/tests/integration/ContactsApiTest.spec.ts +222 -0
- package/tests/integration/CustomFieldApiTest.spec.ts +231 -0
- package/tests/integration/DocumentApiTest.spec.ts +1624 -0
- package/tests/integration/IdentityVerificationApiTest.spec.ts +114 -0
- package/tests/integration/TemplateApiTest.spec.ts +1420 -0
- package/tests/integration/planApiTest.spec.ts +26 -0
- package/tests/integration/senderIdentity.spec.ts +397 -0
- package/tests/integration/teamsApiTest.spec.ts +226 -0
- package/tests/integration/usersApiTest.spec.ts +251 -0
- package/tests/performance/performanceApiTest.spec.ts +362 -0
- package/tests/unit/brandingApi.spec.ts +163 -0
- package/tests/unit/contactsApi.spec.ts +143 -0
- package/tests/unit/customFieldApi.spec.ts +123 -0
- package/tests/unit/documentApi.spec.ts +545 -0
- package/tests/unit/planApi.spec.ts +34 -0
- package/tests/unit/senderIdentitiesApi.spec.ts +148 -0
- package/tests/unit/teamApi.spec.ts +94 -0
- package/tests/unit/templateApi.spec.ts +307 -0
- package/tests/unit/userApi.spec.ts +162 -0
- package/tsconfig.json +24 -24
package/docs/Validation.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
# # Validation
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
| `type`<sup>*_required_</sup> | ```string``` | | |
|
|
10
|
-
| `regex` | ```string``` | | |
|
|
11
|
-
| `regexMessage` | ```string``` | | |
|
|
12
|
-
|
|
13
|
-
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
1
|
+
# # Validation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `type`<sup>*_required_</sup> | ```string``` | | |
|
|
10
|
+
| `regex` | ```string``` | | |
|
|
11
|
+
| `regexMessage` | ```string``` | | |
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
# # VerificationDataRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
| `emailId` | ```string``` | | |
|
|
10
|
-
| `countryCode` | ```string``` | | |
|
|
11
|
-
| `phoneNumber` | ```string``` | | |
|
|
12
|
-
| `order` | ```number``` | | |
|
|
13
|
-
| `onBehalfOf` | ```string``` | | |
|
|
14
|
-
|
|
15
|
-
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
1
|
+
# # VerificationDataRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `emailId` | ```string``` | | |
|
|
10
|
+
| `countryCode` | ```string``` | | |
|
|
11
|
+
| `phoneNumber` | ```string``` | | |
|
|
12
|
+
| `order` | ```number``` | | |
|
|
13
|
+
| `onBehalfOf` | ```string``` | | |
|
|
14
|
+
|
|
15
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
package/docs/ViewBrandDetails.md
CHANGED
|
@@ -1,34 +1,35 @@
|
|
|
1
|
-
# # ViewBrandDetails
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
| `brandId` | ```string``` | | |
|
|
10
|
-
| `brandLogo` | ```string``` | | |
|
|
11
|
-
| `brandName` | ```string``` | | |
|
|
12
|
-
| `backgroundColor` | ```string``` | | |
|
|
13
|
-
| `buttonColor` | ```string``` | | |
|
|
14
|
-
| `buttonTextColor` | ```string``` | | |
|
|
15
|
-
| `emailDisplayName` | ```string``` | | |
|
|
16
|
-
| `disclaimerTitle` | ```string``` | | |
|
|
17
|
-
| `disclaimerDescription` | ```string``` | | |
|
|
18
|
-
| `redirectUrl` | ```string``` | | |
|
|
19
|
-
| `isDefault` | ```boolean``` | | |
|
|
20
|
-
| `canHideTagLine` | ```boolean``` | | |
|
|
21
|
-
| `combineAuditTrail` | ```boolean``` | | |
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
|
|
34
|
-
|
|
1
|
+
# # ViewBrandDetails
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `brandId` | ```string``` | | |
|
|
10
|
+
| `brandLogo` | ```string``` | | |
|
|
11
|
+
| `brandName` | ```string``` | | |
|
|
12
|
+
| `backgroundColor` | ```string``` | | |
|
|
13
|
+
| `buttonColor` | ```string``` | | |
|
|
14
|
+
| `buttonTextColor` | ```string``` | | |
|
|
15
|
+
| `emailDisplayName` | ```string``` | | |
|
|
16
|
+
| `disclaimerTitle` | ```string``` | | |
|
|
17
|
+
| `disclaimerDescription` | ```string``` | | |
|
|
18
|
+
| `redirectUrl` | ```string``` | | |
|
|
19
|
+
| `isDefault` | ```boolean``` | | |
|
|
20
|
+
| `canHideTagLine` | ```boolean``` | | |
|
|
21
|
+
| `combineAuditTrail` | ```boolean``` | | |
|
|
22
|
+
| `combineAttachments` | ```boolean``` | | |
|
|
23
|
+
| `excludeAuditTrailFromEmail` | ```boolean``` | | |
|
|
24
|
+
| `emailSignedDocument` | ```string``` | | |
|
|
25
|
+
| `documentTimeZone` | ```string``` | | |
|
|
26
|
+
| `showBuiltInFormFields` | ```boolean``` | | |
|
|
27
|
+
| `allowCustomFieldCreation` | ```boolean``` | | |
|
|
28
|
+
| `showSharedCustomFields` | ```boolean``` | | |
|
|
29
|
+
| `hideDecline` | ```boolean``` | | |
|
|
30
|
+
| `hideSave` | ```boolean``` | | |
|
|
31
|
+
| `documentExpirySettings` | [```DocumentExpirySettings```](DocumentExpirySettings.md) | | |
|
|
32
|
+
| `customDomainSettings` | [```CustomDomainSettings```](CustomDomainSettings.md) | | |
|
|
33
|
+
| `isDomainVerified` | ```boolean``` | | |
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,17 +1,17 @@
|
|
|
1
|
-
# # ViewCustomFieldDetails
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
| `customFieldId` | ```string``` | | |
|
|
10
|
-
| `fieldName` | ```string``` | | |
|
|
11
|
-
| `fieldDescription` | ```string``` | | |
|
|
12
|
-
| `fieldOrder` | ```number``` | | |
|
|
13
|
-
| `brandId` | ```string``` | | |
|
|
14
|
-
| `sharedField` | ```boolean``` | | |
|
|
15
|
-
| `formField` | [```CustomFormField```](CustomFormField.md) | | |
|
|
16
|
-
|
|
17
|
-
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
1
|
+
# # ViewCustomFieldDetails
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
| `customFieldId` | ```string``` | | |
|
|
10
|
+
| `fieldName` | ```string``` | | |
|
|
11
|
+
| `fieldDescription` | ```string``` | | |
|
|
12
|
+
| `fieldOrder` | ```number``` | | |
|
|
13
|
+
| `brandId` | ```string``` | | |
|
|
14
|
+
| `sharedField` | ```boolean``` | | |
|
|
15
|
+
| `formField` | [```CustomFormField```](CustomFormField.md) | | |
|
|
16
|
+
|
|
17
|
+
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { DocumentApi } from '../api/documentApi';
|
|
2
|
-
|
|
3
|
-
const documentApi = new DocumentApi();
|
|
4
|
-
documentApi.setApiKey("YOUR_API_KEY");
|
|
5
|
-
|
|
6
|
-
var documentId = "YOUR_DOCUMENT_ID";
|
|
7
|
-
async function getDocumentProperties() {
|
|
8
|
-
try {
|
|
9
|
-
var getPropertiesResponse = await documentApi.getProperties(documentId);
|
|
10
|
-
console.log("Document Properties:", getPropertiesResponse);
|
|
11
|
-
} catch (error:any) {
|
|
12
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
-
}
|
|
14
|
-
}
|
|
1
|
+
import { DocumentApi } from '../api/documentApi';
|
|
2
|
+
|
|
3
|
+
const documentApi = new DocumentApi();
|
|
4
|
+
documentApi.setApiKey("YOUR_API_KEY");
|
|
5
|
+
|
|
6
|
+
var documentId = "YOUR_DOCUMENT_ID";
|
|
7
|
+
async function getDocumentProperties() {
|
|
8
|
+
try {
|
|
9
|
+
var getPropertiesResponse = await documentApi.getProperties(documentId);
|
|
10
|
+
console.log("Document Properties:", getPropertiesResponse);
|
|
11
|
+
} catch (error:any) {
|
|
12
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
15
|
getDocumentProperties();
|
package/examples/brandCreate.ts
CHANGED
|
@@ -1,29 +1,29 @@
|
|
|
1
|
-
|
|
2
|
-
import { BrandingApi } from '../api/brandingApi';
|
|
3
|
-
import * as fs from 'fs';
|
|
4
|
-
|
|
5
|
-
const createBrandApi = new BrandingApi();
|
|
6
|
-
createBrandApi.setApiKey("YOUR_API_KEY");
|
|
7
|
-
const brandName = "NodeSDK";
|
|
8
|
-
const logoFilePath = "YOUR_FILE_PATH";
|
|
9
|
-
const brandLogo = fs.createReadStream(logoFilePath);
|
|
10
|
-
const backgroundColor = "Blue";
|
|
11
|
-
const buttonColor = "Black";
|
|
12
|
-
const buttonTextColor = "White";
|
|
13
|
-
const emailDisplayName = "{SenderName} from Syncfusion";
|
|
14
|
-
async function createBrand() {
|
|
15
|
-
try {
|
|
16
|
-
const createBrandApiResponse = await createBrandApi.createBrand(
|
|
17
|
-
brandName,
|
|
18
|
-
brandLogo,
|
|
19
|
-
backgroundColor,
|
|
20
|
-
buttonColor,
|
|
21
|
-
buttonTextColor,
|
|
22
|
-
emailDisplayName
|
|
23
|
-
);
|
|
24
|
-
console.log("Brand created successfully:", createBrandApiResponse.brandId);
|
|
25
|
-
} catch (error:any) {
|
|
26
|
-
console.error("Error occurred while creating the brand:", error.message);
|
|
27
|
-
}
|
|
28
|
-
}
|
|
1
|
+
|
|
2
|
+
import { BrandingApi } from '../api/brandingApi';
|
|
3
|
+
import * as fs from 'fs';
|
|
4
|
+
|
|
5
|
+
const createBrandApi = new BrandingApi();
|
|
6
|
+
createBrandApi.setApiKey("YOUR_API_KEY");
|
|
7
|
+
const brandName = "NodeSDK";
|
|
8
|
+
const logoFilePath = "YOUR_FILE_PATH";
|
|
9
|
+
const brandLogo = fs.createReadStream(logoFilePath);
|
|
10
|
+
const backgroundColor = "Blue";
|
|
11
|
+
const buttonColor = "Black";
|
|
12
|
+
const buttonTextColor = "White";
|
|
13
|
+
const emailDisplayName = "{SenderName} from Syncfusion";
|
|
14
|
+
async function createBrand() {
|
|
15
|
+
try {
|
|
16
|
+
const createBrandApiResponse = await createBrandApi.createBrand(
|
|
17
|
+
brandName,
|
|
18
|
+
brandLogo,
|
|
19
|
+
backgroundColor,
|
|
20
|
+
buttonColor,
|
|
21
|
+
buttonTextColor,
|
|
22
|
+
emailDisplayName
|
|
23
|
+
);
|
|
24
|
+
console.log("Brand created successfully:", createBrandApiResponse.brandId);
|
|
25
|
+
} catch (error:any) {
|
|
26
|
+
console.error("Error occurred while creating the brand:", error.message);
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
29
|
createBrand();
|
package/examples/brandDelete.ts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
-
|
|
3
|
-
const brandingApi = new BrandingApi();
|
|
4
|
-
brandingApi.setApiKey("YOUR_API_KEY");
|
|
5
|
-
|
|
6
|
-
var brandId = "YOUR_BRAND_ID";
|
|
7
|
-
async function deleteBrand() {
|
|
8
|
-
try {
|
|
9
|
-
await brandingApi.deleteBrand(brandId);
|
|
10
|
-
console.log("Brand deleted successfully!");
|
|
11
|
-
} catch (error:any) {
|
|
12
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
-
}
|
|
14
|
-
}
|
|
1
|
+
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
+
|
|
3
|
+
const brandingApi = new BrandingApi();
|
|
4
|
+
brandingApi.setApiKey("YOUR_API_KEY");
|
|
5
|
+
|
|
6
|
+
var brandId = "YOUR_BRAND_ID";
|
|
7
|
+
async function deleteBrand() {
|
|
8
|
+
try {
|
|
9
|
+
await brandingApi.deleteBrand(brandId);
|
|
10
|
+
console.log("Brand deleted successfully!");
|
|
11
|
+
} catch (error:any) {
|
|
12
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
15
|
deleteBrand();
|
package/examples/brandGet.ts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
-
|
|
3
|
-
const brandingApi = new BrandingApi();
|
|
4
|
-
brandingApi.setApiKey("YOUR_API_KEY");
|
|
5
|
-
|
|
6
|
-
var brandId = "YOUR_BRAND_ID";
|
|
7
|
-
async function getBrandDetails() {
|
|
8
|
-
try {
|
|
9
|
-
var brandDetailsResponse = await brandingApi.getBrand(brandId);
|
|
10
|
-
console.log("Brand Details:", brandDetailsResponse);
|
|
11
|
-
} catch (error:any) {
|
|
12
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
-
}
|
|
14
|
-
}
|
|
1
|
+
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
+
|
|
3
|
+
const brandingApi = new BrandingApi();
|
|
4
|
+
brandingApi.setApiKey("YOUR_API_KEY");
|
|
5
|
+
|
|
6
|
+
var brandId = "YOUR_BRAND_ID";
|
|
7
|
+
async function getBrandDetails() {
|
|
8
|
+
try {
|
|
9
|
+
var brandDetailsResponse = await brandingApi.getBrand(brandId);
|
|
10
|
+
console.log("Brand Details:", brandDetailsResponse);
|
|
11
|
+
} catch (error:any) {
|
|
12
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
15
|
getBrandDetails();
|
package/examples/brandList.ts
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
-
|
|
3
|
-
const brandingApi = new BrandingApi();
|
|
4
|
-
brandingApi.setApiKey("YOUR_API_KEY");
|
|
5
|
-
|
|
6
|
-
async function getBrandList() {
|
|
7
|
-
try {
|
|
8
|
-
var brandListResponse = await brandingApi.brandList();
|
|
9
|
-
console.log("Brand List:", brandListResponse);
|
|
10
|
-
} catch (error:any) {
|
|
11
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
12
|
-
}
|
|
13
|
-
}
|
|
1
|
+
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
+
|
|
3
|
+
const brandingApi = new BrandingApi();
|
|
4
|
+
brandingApi.setApiKey("YOUR_API_KEY");
|
|
5
|
+
|
|
6
|
+
async function getBrandList() {
|
|
7
|
+
try {
|
|
8
|
+
var brandListResponse = await brandingApi.brandList();
|
|
9
|
+
console.log("Brand List:", brandListResponse);
|
|
10
|
+
} catch (error:any) {
|
|
11
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
14
|
getBrandList();
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
-
|
|
3
|
-
const brandingApi = new BrandingApi();
|
|
4
|
-
brandingApi.setApiKey("YOUR_API_KEY");
|
|
5
|
-
|
|
6
|
-
var brandId = "YOUR_BRAND_ID";
|
|
7
|
-
async function resetDefaultBrand() {
|
|
8
|
-
try {
|
|
9
|
-
await brandingApi.resetDefaultBrand(brandId);
|
|
10
|
-
console.log("Brand reset as default successfully!");
|
|
11
|
-
} catch (error:any) {
|
|
12
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
-
}
|
|
14
|
-
}
|
|
1
|
+
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
+
|
|
3
|
+
const brandingApi = new BrandingApi();
|
|
4
|
+
brandingApi.setApiKey("YOUR_API_KEY");
|
|
5
|
+
|
|
6
|
+
var brandId = "YOUR_BRAND_ID";
|
|
7
|
+
async function resetDefaultBrand() {
|
|
8
|
+
try {
|
|
9
|
+
await brandingApi.resetDefaultBrand(brandId);
|
|
10
|
+
console.log("Brand reset as default successfully!");
|
|
11
|
+
} catch (error:any) {
|
|
12
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
15
|
resetDefaultBrand();
|
package/examples/brandUpdate.ts
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
-
import * as fs from 'fs';
|
|
3
|
-
|
|
4
|
-
const brandingApi = new BrandingApi();
|
|
5
|
-
brandingApi.setApiKey("YOUR_API_KEY");
|
|
6
|
-
var brandId = "YOUR_BRAND_ID";
|
|
7
|
-
var brandName = "Node-SDK-Test";
|
|
8
|
-
const brandLogo = fs.createReadStream("YOUR_FILE_PATH");
|
|
9
|
-
var backgroundColor = "Blue";
|
|
10
|
-
var buttonColor = "Black";
|
|
11
|
-
var buttonTextColor = "White";
|
|
12
|
-
var emailDisplayName = "david@cubeflakes.com";
|
|
13
|
-
async function updateBrand() {
|
|
14
|
-
try {
|
|
15
|
-
const updateBrandApiResponse = await brandingApi.editBrand(brandId, brandName, brandLogo, backgroundColor, buttonColor, buttonTextColor, emailDisplayName);
|
|
16
|
-
console.log("Brand updated successfully:", updateBrandApiResponse.brandId);
|
|
17
|
-
} catch (error:any) {
|
|
18
|
-
console.error("Error occurred while updating the brand:", error.message);
|
|
19
|
-
}
|
|
20
|
-
}
|
|
1
|
+
import { BrandingApi } from '../api/brandingApi';
|
|
2
|
+
import * as fs from 'fs';
|
|
3
|
+
|
|
4
|
+
const brandingApi = new BrandingApi();
|
|
5
|
+
brandingApi.setApiKey("YOUR_API_KEY");
|
|
6
|
+
var brandId = "YOUR_BRAND_ID";
|
|
7
|
+
var brandName = "Node-SDK-Test";
|
|
8
|
+
const brandLogo = fs.createReadStream("YOUR_FILE_PATH");
|
|
9
|
+
var backgroundColor = "Blue";
|
|
10
|
+
var buttonColor = "Black";
|
|
11
|
+
var buttonTextColor = "White";
|
|
12
|
+
var emailDisplayName = "david@cubeflakes.com";
|
|
13
|
+
async function updateBrand() {
|
|
14
|
+
try {
|
|
15
|
+
const updateBrandApiResponse = await brandingApi.editBrand(brandId, brandName, brandLogo, backgroundColor, buttonColor, buttonTextColor, emailDisplayName);
|
|
16
|
+
console.log("Brand updated successfully:", updateBrandApiResponse.brandId);
|
|
17
|
+
} catch (error:any) {
|
|
18
|
+
console.error("Error occurred while updating the brand:", error.message);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
21
|
updateBrand();
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
-
import { ContactDetails, PhoneNumber } from '../model';
|
|
3
|
-
|
|
4
|
-
const contactsApi = new ContactsApi();
|
|
5
|
-
contactsApi.setApiKey("YOUR_API_KEY");
|
|
6
|
-
|
|
7
|
-
var contactDetails = new ContactDetails();
|
|
8
|
-
contactDetails.name = "LutherCooper";
|
|
9
|
-
contactDetails.email = "luthercooper@cubeflakes.com";
|
|
10
|
-
contactDetails.jobTitle = "Developer";
|
|
11
|
-
contactDetails.companyName = "CubeFlakes";
|
|
12
|
-
var phoneNumber = new PhoneNumber();
|
|
13
|
-
phoneNumber.countryCode = "+91";
|
|
14
|
-
phoneNumber.number = "8807799764";
|
|
15
|
-
contactDetails.phoneNumber = phoneNumber;
|
|
16
|
-
var contact = [contactDetails];
|
|
17
|
-
|
|
18
|
-
async function createContact() {
|
|
19
|
-
try {
|
|
20
|
-
var createContactResponse = await contactsApi.createContact(contact);
|
|
21
|
-
console.log("Contacts created successfully:", createContactResponse);
|
|
22
|
-
} catch (error:any) {
|
|
23
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
24
|
-
}
|
|
25
|
-
}
|
|
1
|
+
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
+
import { ContactDetails, PhoneNumber } from '../model';
|
|
3
|
+
|
|
4
|
+
const contactsApi = new ContactsApi();
|
|
5
|
+
contactsApi.setApiKey("YOUR_API_KEY");
|
|
6
|
+
|
|
7
|
+
var contactDetails = new ContactDetails();
|
|
8
|
+
contactDetails.name = "LutherCooper";
|
|
9
|
+
contactDetails.email = "luthercooper@cubeflakes.com";
|
|
10
|
+
contactDetails.jobTitle = "Developer";
|
|
11
|
+
contactDetails.companyName = "CubeFlakes";
|
|
12
|
+
var phoneNumber = new PhoneNumber();
|
|
13
|
+
phoneNumber.countryCode = "+91";
|
|
14
|
+
phoneNumber.number = "8807799764";
|
|
15
|
+
contactDetails.phoneNumber = phoneNumber;
|
|
16
|
+
var contact = [contactDetails];
|
|
17
|
+
|
|
18
|
+
async function createContact() {
|
|
19
|
+
try {
|
|
20
|
+
var createContactResponse = await contactsApi.createContact(contact);
|
|
21
|
+
console.log("Contacts created successfully:", createContactResponse);
|
|
22
|
+
} catch (error:any) {
|
|
23
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
26
|
createContact();
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
-
|
|
3
|
-
const contactsApi = new ContactsApi();
|
|
4
|
-
contactsApi.setApiKey("YOUR_API_KEY");
|
|
5
|
-
|
|
6
|
-
var contactId = "YOUR_CONTACT_ID";
|
|
7
|
-
async function deleteContact() {
|
|
8
|
-
try {
|
|
9
|
-
await contactsApi.deleteContacts(contactId);
|
|
10
|
-
console.log("Contact deleted successfully!");
|
|
11
|
-
} catch (error:any) {
|
|
12
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
-
}
|
|
14
|
-
}
|
|
1
|
+
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
+
|
|
3
|
+
const contactsApi = new ContactsApi();
|
|
4
|
+
contactsApi.setApiKey("YOUR_API_KEY");
|
|
5
|
+
|
|
6
|
+
var contactId = "YOUR_CONTACT_ID";
|
|
7
|
+
async function deleteContact() {
|
|
8
|
+
try {
|
|
9
|
+
await contactsApi.deleteContacts(contactId);
|
|
10
|
+
console.log("Contact deleted successfully!");
|
|
11
|
+
} catch (error:any) {
|
|
12
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
15
|
deleteContact();
|
package/examples/contactGet.ts
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
-
|
|
3
|
-
const contactsApi = new ContactsApi();
|
|
4
|
-
contactsApi.setApiKey("YOUR_API_KEY");
|
|
5
|
-
|
|
6
|
-
var contactId = "YOUR_CONTACT_ID";
|
|
7
|
-
async function getContactDetails() {
|
|
8
|
-
try {
|
|
9
|
-
var contactDetailsResponse = await contactsApi.getContact(contactId);
|
|
10
|
-
console.log("Contact details retrieved successfully!:", contactDetailsResponse);
|
|
11
|
-
} catch (error:any) {
|
|
12
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
-
}
|
|
14
|
-
}
|
|
1
|
+
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
+
|
|
3
|
+
const contactsApi = new ContactsApi();
|
|
4
|
+
contactsApi.setApiKey("YOUR_API_KEY");
|
|
5
|
+
|
|
6
|
+
var contactId = "YOUR_CONTACT_ID";
|
|
7
|
+
async function getContactDetails() {
|
|
8
|
+
try {
|
|
9
|
+
var contactDetailsResponse = await contactsApi.getContact(contactId);
|
|
10
|
+
console.log("Contact details retrieved successfully!:", contactDetailsResponse);
|
|
11
|
+
} catch (error:any) {
|
|
12
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
15
|
getContactDetails();
|
package/examples/contactList.ts
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
-
|
|
3
|
-
const contactsApi = new ContactsApi();
|
|
4
|
-
contactsApi.setApiKey("YOUR_API_KEY");
|
|
5
|
-
|
|
6
|
-
var page = 1;
|
|
7
|
-
var pageSize = 10;
|
|
8
|
-
async function getContactList() {
|
|
9
|
-
try {
|
|
10
|
-
var contactListResponse = await contactsApi.contactUserList(page, pageSize);
|
|
11
|
-
console.log("Contact list retrieved:", contactListResponse);
|
|
12
|
-
} catch (error:any) {
|
|
13
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
14
|
-
}
|
|
15
|
-
}
|
|
1
|
+
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
+
|
|
3
|
+
const contactsApi = new ContactsApi();
|
|
4
|
+
contactsApi.setApiKey("YOUR_API_KEY");
|
|
5
|
+
|
|
6
|
+
var page = 1;
|
|
7
|
+
var pageSize = 10;
|
|
8
|
+
async function getContactList() {
|
|
9
|
+
try {
|
|
10
|
+
var contactListResponse = await contactsApi.contactUserList(page, pageSize);
|
|
11
|
+
console.log("Contact list retrieved:", contactListResponse);
|
|
12
|
+
} catch (error:any) {
|
|
13
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
16
|
getContactList();
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
-
import { ContactDetails, PhoneNumber } from '../model';
|
|
3
|
-
|
|
4
|
-
const contactsApi = new ContactsApi();
|
|
5
|
-
contactsApi.setApiKey("YOUR_API_KEY");
|
|
6
|
-
|
|
7
|
-
var contactId = "YOUR_CONTACT_ID";
|
|
8
|
-
var contactDetails = new ContactDetails();
|
|
9
|
-
contactDetails.name = "Test_Engineer";
|
|
10
|
-
contactDetails.email = "test1711@gmail.com";
|
|
11
|
-
contactDetails.jobTitle = "Tester";
|
|
12
|
-
contactDetails.companyName = "Flakes";
|
|
13
|
-
var phoneNumber = new PhoneNumber();
|
|
14
|
-
phoneNumber.countryCode = "+91";
|
|
15
|
-
phoneNumber.number = "8807799763";
|
|
16
|
-
contactDetails.phoneNumber = phoneNumber;
|
|
17
|
-
|
|
18
|
-
async function updateContact() {
|
|
19
|
-
try {
|
|
20
|
-
await contactsApi.updateContact(contactId, contactDetails);
|
|
21
|
-
console.log("Contact updated successfully!");
|
|
22
|
-
} catch (error:any) {
|
|
23
|
-
console.error("Error occurred while calling the API:", error.message);
|
|
24
|
-
}
|
|
25
|
-
}
|
|
1
|
+
import { ContactsApi } from '../api/contactsApi';
|
|
2
|
+
import { ContactDetails, PhoneNumber } from '../model';
|
|
3
|
+
|
|
4
|
+
const contactsApi = new ContactsApi();
|
|
5
|
+
contactsApi.setApiKey("YOUR_API_KEY");
|
|
6
|
+
|
|
7
|
+
var contactId = "YOUR_CONTACT_ID";
|
|
8
|
+
var contactDetails = new ContactDetails();
|
|
9
|
+
contactDetails.name = "Test_Engineer";
|
|
10
|
+
contactDetails.email = "test1711@gmail.com";
|
|
11
|
+
contactDetails.jobTitle = "Tester";
|
|
12
|
+
contactDetails.companyName = "Flakes";
|
|
13
|
+
var phoneNumber = new PhoneNumber();
|
|
14
|
+
phoneNumber.countryCode = "+91";
|
|
15
|
+
phoneNumber.number = "8807799763";
|
|
16
|
+
contactDetails.phoneNumber = phoneNumber;
|
|
17
|
+
|
|
18
|
+
async function updateContact() {
|
|
19
|
+
try {
|
|
20
|
+
await contactsApi.updateContact(contactId, contactDetails);
|
|
21
|
+
console.log("Contact updated successfully!");
|
|
22
|
+
} catch (error:any) {
|
|
23
|
+
console.error("Error occurred while calling the API:", error.message);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
26
|
updateContact();
|