├── .editorconfig ├── .gitattributes ├── .gitignore ├── .npmignore ├── .prettierrc.cjs ├── LICENSE ├── README.md ├── VERSION ├── dist └── api.js ├── docs ├── api │ ├── AccountApi.md │ ├── ApiAppApi.md │ ├── BulkSendJobApi.md │ ├── EmbeddedApi.md │ ├── FaxApi.md │ ├── FaxLineApi.md │ ├── OAuthApi.md │ ├── ReportApi.md │ ├── SignatureRequestApi.md │ ├── TeamApi.md │ ├── TemplateApi.md │ └── UnclaimedDraftApi.md └── model │ ├── AccountCreateRequest.md │ ├── AccountCreateResponse.md │ ├── AccountGetResponse.md │ ├── AccountResponse.md │ ├── AccountResponseQuotas.md │ ├── AccountResponseUsage.md │ ├── AccountUpdateRequest.md │ ├── AccountVerifyRequest.md │ ├── AccountVerifyResponse.md │ ├── AccountVerifyResponseAccount.md │ ├── ApiAppCreateRequest.md │ ├── ApiAppGetResponse.md │ ├── ApiAppListResponse.md │ ├── ApiAppResponse.md │ ├── ApiAppResponseOAuth.md │ ├── ApiAppResponseOptions.md │ ├── ApiAppResponseOwnerAccount.md │ ├── ApiAppResponseWhiteLabelingOptions.md │ ├── ApiAppUpdateRequest.md │ ├── BulkSendJobGetResponse.md │ ├── BulkSendJobGetResponseSignatureRequests.md │ ├── BulkSendJobListResponse.md │ ├── BulkSendJobResponse.md │ ├── BulkSendJobSendResponse.md │ ├── EmbeddedEditUrlRequest.md │ ├── EmbeddedEditUrlResponse.md │ ├── EmbeddedEditUrlResponseEmbedded.md │ ├── EmbeddedSignUrlResponse.md │ ├── EmbeddedSignUrlResponseEmbedded.md │ ├── ErrorResponse.md │ ├── ErrorResponseError.md │ ├── EventCallbackRequest.md │ ├── EventCallbackRequestEvent.md │ ├── EventCallbackRequestEventMetadata.md │ ├── FaxGetResponse.md │ ├── FaxLineAddUserRequest.md │ ├── FaxLineAreaCodeGetCountryEnum.md │ ├── FaxLineAreaCodeGetProvinceEnum.md │ ├── FaxLineAreaCodeGetResponse.md │ ├── FaxLineAreaCodeGetStateEnum.md │ ├── FaxLineCreateRequest.md │ ├── FaxLineDeleteRequest.md │ ├── FaxLineListResponse.md │ ├── FaxLineRemoveUserRequest.md │ ├── FaxLineResponse.md │ ├── FaxLineResponseFaxLine.md │ ├── FaxListResponse.md │ ├── FaxResponse.md │ ├── FaxResponseTransmission.md │ ├── FaxSendRequest.md │ ├── FileResponse.md │ ├── FileResponseDataUri.md │ ├── ListInfoResponse.md │ ├── OAuthTokenGenerateRequest.md │ ├── OAuthTokenRefreshRequest.md │ ├── OAuthTokenResponse.md │ ├── ReportCreateRequest.md │ ├── ReportCreateResponse.md │ ├── ReportResponse.md │ ├── SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md │ ├── SignatureRequestBulkSendWithTemplateRequest.md │ ├── SignatureRequestCreateEmbeddedRequest.md │ ├── SignatureRequestCreateEmbeddedWithTemplateRequest.md │ ├── SignatureRequestEditEmbeddedRequest.md │ ├── SignatureRequestEditEmbeddedWithTemplateRequest.md │ ├── SignatureRequestEditRequest.md │ ├── SignatureRequestEditWithTemplateRequest.md │ ├── SignatureRequestGetResponse.md │ ├── SignatureRequestListResponse.md │ ├── SignatureRequestRemindRequest.md │ ├── SignatureRequestResponse.md │ ├── SignatureRequestResponseAttachment.md │ ├── SignatureRequestResponseCustomFieldBase.md │ ├── SignatureRequestResponseCustomFieldCheckbox.md │ ├── SignatureRequestResponseCustomFieldText.md │ ├── SignatureRequestResponseCustomFieldTypeEnum.md │ ├── SignatureRequestResponseDataBase.md │ ├── SignatureRequestResponseDataTypeEnum.md │ ├── SignatureRequestResponseDataValueCheckbox.md │ ├── SignatureRequestResponseDataValueCheckboxMerge.md │ ├── SignatureRequestResponseDataValueDateSigned.md │ ├── SignatureRequestResponseDataValueDropdown.md │ ├── SignatureRequestResponseDataValueInitials.md │ ├── SignatureRequestResponseDataValueRadio.md │ ├── SignatureRequestResponseDataValueSignature.md │ ├── SignatureRequestResponseDataValueText.md │ ├── SignatureRequestResponseDataValueTextMerge.md │ ├── SignatureRequestResponseSignatures.md │ ├── SignatureRequestSendRequest.md │ ├── SignatureRequestSendWithTemplateRequest.md │ ├── SignatureRequestUpdateRequest.md │ ├── SubAttachment.md │ ├── SubBulkSignerList.md │ ├── SubBulkSignerListCustomField.md │ ├── SubCC.md │ ├── SubCustomField.md │ ├── SubEditorOptions.md │ ├── SubFieldOptions.md │ ├── SubFormFieldGroup.md │ ├── SubFormFieldRule.md │ ├── SubFormFieldRuleAction.md │ ├── SubFormFieldRuleTrigger.md │ ├── SubFormFieldsPerDocumentBase.md │ ├── SubFormFieldsPerDocumentCheckbox.md │ ├── SubFormFieldsPerDocumentCheckboxMerge.md │ ├── SubFormFieldsPerDocumentDateSigned.md │ ├── SubFormFieldsPerDocumentDropdown.md │ ├── SubFormFieldsPerDocumentFontEnum.md │ ├── SubFormFieldsPerDocumentHyperlink.md │ ├── SubFormFieldsPerDocumentInitials.md │ ├── SubFormFieldsPerDocumentRadio.md │ ├── SubFormFieldsPerDocumentSignature.md │ ├── SubFormFieldsPerDocumentText.md │ ├── SubFormFieldsPerDocumentTextMerge.md │ ├── SubFormFieldsPerDocumentTypeEnum.md │ ├── SubMergeField.md │ ├── SubOAuth.md │ ├── SubOptions.md │ ├── SubSignatureRequestGroupedSigners.md │ ├── SubSignatureRequestSigner.md │ ├── SubSignatureRequestTemplateSigner.md │ ├── SubSigningOptions.md │ ├── SubTeamResponse.md │ ├── SubTemplateRole.md │ ├── SubUnclaimedDraftSigner.md │ ├── SubUnclaimedDraftTemplateSigner.md │ ├── SubWhiteLabelingOptions.md │ ├── TeamAddMemberRequest.md │ ├── TeamCreateRequest.md │ ├── TeamGetInfoResponse.md │ ├── TeamGetResponse.md │ ├── TeamInfoResponse.md │ ├── TeamInviteResponse.md │ ├── TeamInvitesResponse.md │ ├── TeamMemberResponse.md │ ├── TeamMembersResponse.md │ ├── TeamParentResponse.md │ ├── TeamRemoveMemberRequest.md │ ├── TeamResponse.md │ ├── TeamSubTeamsResponse.md │ ├── TeamUpdateRequest.md │ ├── TemplateAddUserRequest.md │ ├── TemplateCreateEmbeddedDraftRequest.md │ ├── TemplateCreateEmbeddedDraftResponse.md │ ├── TemplateCreateEmbeddedDraftResponseTemplate.md │ ├── TemplateCreateRequest.md │ ├── TemplateCreateResponse.md │ ├── TemplateCreateResponseTemplate.md │ ├── TemplateEditResponse.md │ ├── TemplateGetResponse.md │ ├── TemplateListResponse.md │ ├── TemplateRemoveUserRequest.md │ ├── TemplateResponse.md │ ├── TemplateResponseAccount.md │ ├── TemplateResponseAccountQuota.md │ ├── TemplateResponseCCRole.md │ ├── TemplateResponseDocument.md │ ├── TemplateResponseDocumentCustomFieldBase.md │ ├── TemplateResponseDocumentCustomFieldCheckbox.md │ ├── TemplateResponseDocumentCustomFieldText.md │ ├── TemplateResponseDocumentFieldGroup.md │ ├── TemplateResponseDocumentFieldGroupRule.md │ ├── TemplateResponseDocumentFormFieldBase.md │ ├── TemplateResponseDocumentFormFieldCheckbox.md │ ├── TemplateResponseDocumentFormFieldDateSigned.md │ ├── TemplateResponseDocumentFormFieldDropdown.md │ ├── TemplateResponseDocumentFormFieldHyperlink.md │ ├── TemplateResponseDocumentFormFieldInitials.md │ ├── TemplateResponseDocumentFormFieldRadio.md │ ├── TemplateResponseDocumentFormFieldSignature.md │ ├── TemplateResponseDocumentFormFieldText.md │ ├── TemplateResponseDocumentStaticFieldBase.md │ ├── TemplateResponseDocumentStaticFieldCheckbox.md │ ├── TemplateResponseDocumentStaticFieldDateSigned.md │ ├── TemplateResponseDocumentStaticFieldDropdown.md │ ├── TemplateResponseDocumentStaticFieldHyperlink.md │ ├── TemplateResponseDocumentStaticFieldInitials.md │ ├── TemplateResponseDocumentStaticFieldRadio.md │ ├── TemplateResponseDocumentStaticFieldSignature.md │ ├── TemplateResponseDocumentStaticFieldText.md │ ├── TemplateResponseFieldAvgTextLength.md │ ├── TemplateResponseSignerRole.md │ ├── TemplateUpdateFilesRequest.md │ ├── TemplateUpdateFilesResponse.md │ ├── TemplateUpdateFilesResponseTemplate.md │ ├── UnclaimedDraftCreateEmbeddedRequest.md │ ├── UnclaimedDraftCreateEmbeddedWithTemplateRequest.md │ ├── UnclaimedDraftCreateRequest.md │ ├── UnclaimedDraftCreateResponse.md │ ├── UnclaimedDraftEditAndResendRequest.md │ ├── UnclaimedDraftResponse.md │ └── WarningResponse.md ├── openapi-sdk.yaml ├── package-lock.json ├── package.json ├── test_fixtures ├── AccountCreateRequest.json ├── AccountCreateResponse.json ├── AccountGetResponse.json ├── AccountUpdateRequest.json ├── AccountVerifyRequest.json ├── AccountVerifyResponse.json ├── ApiAppCreateRequest.json ├── ApiAppGetResponse.json ├── ApiAppListResponse.json ├── ApiAppUpdateRequest.json ├── BulkSendJobGetResponse.json ├── BulkSendJobListResponse.json ├── BulkSendJobSendResponse.json ├── EmbeddedEditUrlRequest.json ├── EmbeddedEditUrlResponse.json ├── EmbeddedSignUrlResponse.json ├── ErrorResponse.json ├── EventCallbackHelper_AccountCallbacks.json ├── EventCallbackHelper_AppCallbacks.json ├── FaxGetResponse.json ├── FaxListResponse.json ├── FaxSendRequest.json ├── FaxSendResponse.json ├── FileResponse.json ├── OAuthTokenGenerateRequest.json ├── OAuthTokenRefreshRequest.json ├── OAuthTokenResponse.json ├── ReportCreateRequest.json ├── ReportCreateResponse.json ├── SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json ├── SignatureRequestBulkSendWithTemplateRequest.json ├── SignatureRequestCreateEmbeddedRequest.json ├── SignatureRequestCreateEmbeddedWithTemplateRequest.json ├── SignatureRequestGetResponse.json ├── SignatureRequestListResponse.json ├── SignatureRequestRemindRequest.json ├── SignatureRequestSendRequest.json ├── SignatureRequestSendWithTemplateRequest.json ├── SignatureRequestUpdateRequest.json ├── SubFormFieldsPerDocument.json ├── TeamAddMemberRequest.json ├── TeamCreateRequest.json ├── TeamGetResponse.json ├── TeamRemoveMemberRequest.json ├── TeamUpdateRequest.json ├── TemplateAddUserRequest.json ├── TemplateCreateEmbeddedDraftRequest.json ├── TemplateCreateEmbeddedDraftResponse.json ├── TemplateCreateRequest.json ├── TemplateCreateResponse.json ├── TemplateGetResponse.json ├── TemplateListResponse.json ├── TemplateRemoveUserRequest.json ├── TemplateUpdateFilesRequest.json ├── TemplateUpdateFilesResponse.json ├── UnclaimedDraftCreateEmbeddedRequest.json ├── UnclaimedDraftCreateEmbeddedWithTemplateRequest.json ├── UnclaimedDraftCreateRequest.json ├── UnclaimedDraftCreateResponse.json ├── UnclaimedDraftEditAndResendRequest.json ├── bulk-send-sample.csv ├── pdf-sample-2.pdf └── pdf-sample.pdf ├── tests ├── api │ ├── accountApi.test.ts │ ├── apiAppApi.test.ts │ ├── bulkSendJobApi.test.ts │ ├── embeddedApi.test.ts │ ├── oAuthApi.test.ts │ ├── reportApi.test.ts │ ├── signatureRequestApi.test.ts │ ├── teamApi.test.ts │ ├── templateApi.test.ts │ └── unclaimedDraftApi.test.ts ├── model │ ├── eventCallbackHelper.test.ts │ ├── fixtures.test.ts │ └── subFormFieldsPerDocumentBase.test.ts └── test_utils.ts ├── tsconfig.json └── types ├── api.d.ts ├── api ├── accountApi.d.ts ├── apiAppApi.d.ts ├── apis.d.ts ├── bulkSendJobApi.d.ts ├── embeddedApi.d.ts ├── faxApi.d.ts ├── faxLineApi.d.ts ├── index.d.ts ├── oAuthApi.d.ts ├── reportApi.d.ts ├── signatureRequestApi.d.ts ├── teamApi.d.ts ├── templateApi.d.ts └── unclaimedDraftApi.d.ts └── model ├── accountCreateRequest.d.ts ├── accountCreateResponse.d.ts ├── accountGetResponse.d.ts ├── accountResponse.d.ts ├── accountResponseQuotas.d.ts ├── accountResponseUsage.d.ts ├── accountUpdateRequest.d.ts ├── accountVerifyRequest.d.ts ├── accountVerifyResponse.d.ts ├── accountVerifyResponseAccount.d.ts ├── apiAppCreateRequest.d.ts ├── apiAppGetResponse.d.ts ├── apiAppListResponse.d.ts ├── apiAppResponse.d.ts ├── apiAppResponseOAuth.d.ts ├── apiAppResponseOptions.d.ts ├── apiAppResponseOwnerAccount.d.ts ├── apiAppResponseWhiteLabelingOptions.d.ts ├── apiAppUpdateRequest.d.ts ├── bulkSendJobGetResponse.d.ts ├── bulkSendJobGetResponseSignatureRequests.d.ts ├── bulkSendJobListResponse.d.ts ├── bulkSendJobResponse.d.ts ├── bulkSendJobSendResponse.d.ts ├── embeddedEditUrlRequest.d.ts ├── embeddedEditUrlResponse.d.ts ├── embeddedEditUrlResponseEmbedded.d.ts ├── embeddedSignUrlResponse.d.ts ├── embeddedSignUrlResponseEmbedded.d.ts ├── errorResponse.d.ts ├── errorResponseError.d.ts ├── eventCallbackHelper.d.ts ├── eventCallbackRequest.d.ts ├── eventCallbackRequestEvent.d.ts ├── eventCallbackRequestEventMetadata.d.ts ├── faxGetResponse.d.ts ├── faxLineAddUserRequest.d.ts ├── faxLineAreaCodeGetCountryEnum.d.ts ├── faxLineAreaCodeGetProvinceEnum.d.ts ├── faxLineAreaCodeGetResponse.d.ts ├── faxLineAreaCodeGetStateEnum.d.ts ├── faxLineCreateRequest.d.ts ├── faxLineDeleteRequest.d.ts ├── faxLineListResponse.d.ts ├── faxLineRemoveUserRequest.d.ts ├── faxLineResponse.d.ts ├── faxLineResponseFaxLine.d.ts ├── faxListResponse.d.ts ├── faxResponse.d.ts ├── faxResponseTransmission.d.ts ├── faxSendRequest.d.ts ├── fileResponse.d.ts ├── fileResponseDataUri.d.ts ├── index.d.ts ├── listInfoResponse.d.ts ├── models.d.ts ├── oAuthTokenGenerateRequest.d.ts ├── oAuthTokenRefreshRequest.d.ts ├── oAuthTokenResponse.d.ts ├── reportCreateRequest.d.ts ├── reportCreateResponse.d.ts ├── reportResponse.d.ts ├── signatureRequestBulkCreateEmbeddedWithTemplateRequest.d.ts ├── signatureRequestBulkSendWithTemplateRequest.d.ts ├── signatureRequestCreateEmbeddedRequest.d.ts ├── signatureRequestCreateEmbeddedWithTemplateRequest.d.ts ├── signatureRequestEditEmbeddedRequest.d.ts ├── signatureRequestEditEmbeddedWithTemplateRequest.d.ts ├── signatureRequestEditRequest.d.ts ├── signatureRequestEditWithTemplateRequest.d.ts ├── signatureRequestGetResponse.d.ts ├── signatureRequestListResponse.d.ts ├── signatureRequestRemindRequest.d.ts ├── signatureRequestResponse.d.ts ├── signatureRequestResponseAttachment.d.ts ├── signatureRequestResponseCustomFieldBase.d.ts ├── signatureRequestResponseCustomFieldCheckbox.d.ts ├── signatureRequestResponseCustomFieldText.d.ts ├── signatureRequestResponseCustomFieldTypeEnum.d.ts ├── signatureRequestResponseDataBase.d.ts ├── signatureRequestResponseDataTypeEnum.d.ts ├── signatureRequestResponseDataValueCheckbox.d.ts ├── signatureRequestResponseDataValueCheckboxMerge.d.ts ├── signatureRequestResponseDataValueDateSigned.d.ts ├── signatureRequestResponseDataValueDropdown.d.ts ├── signatureRequestResponseDataValueInitials.d.ts ├── signatureRequestResponseDataValueRadio.d.ts ├── signatureRequestResponseDataValueSignature.d.ts ├── signatureRequestResponseDataValueText.d.ts ├── signatureRequestResponseDataValueTextMerge.d.ts ├── signatureRequestResponseSignatures.d.ts ├── signatureRequestSendRequest.d.ts ├── signatureRequestSendWithTemplateRequest.d.ts ├── signatureRequestUpdateRequest.d.ts ├── subAttachment.d.ts ├── subBulkSignerList.d.ts ├── subBulkSignerListCustomField.d.ts ├── subCC.d.ts ├── subCustomField.d.ts ├── subEditorOptions.d.ts ├── subFieldOptions.d.ts ├── subFormFieldGroup.d.ts ├── subFormFieldRule.d.ts ├── subFormFieldRuleAction.d.ts ├── subFormFieldRuleTrigger.d.ts ├── subFormFieldsPerDocumentBase.d.ts ├── subFormFieldsPerDocumentCheckbox.d.ts ├── subFormFieldsPerDocumentCheckboxMerge.d.ts ├── subFormFieldsPerDocumentDateSigned.d.ts ├── subFormFieldsPerDocumentDropdown.d.ts ├── subFormFieldsPerDocumentFontEnum.d.ts ├── subFormFieldsPerDocumentHyperlink.d.ts ├── subFormFieldsPerDocumentInitials.d.ts ├── subFormFieldsPerDocumentRadio.d.ts ├── subFormFieldsPerDocumentSignature.d.ts ├── subFormFieldsPerDocumentText.d.ts ├── subFormFieldsPerDocumentTextMerge.d.ts ├── subFormFieldsPerDocumentTypeEnum.d.ts ├── subMergeField.d.ts ├── subOAuth.d.ts ├── subOptions.d.ts ├── subSignatureRequestGroupedSigners.d.ts ├── subSignatureRequestSigner.d.ts ├── subSignatureRequestTemplateSigner.d.ts ├── subSigningOptions.d.ts ├── subTeamResponse.d.ts ├── subTemplateRole.d.ts ├── subUnclaimedDraftSigner.d.ts ├── subUnclaimedDraftTemplateSigner.d.ts ├── subWhiteLabelingOptions.d.ts ├── teamAddMemberRequest.d.ts ├── teamCreateRequest.d.ts ├── teamGetInfoResponse.d.ts ├── teamGetResponse.d.ts ├── teamInfoResponse.d.ts ├── teamInviteResponse.d.ts ├── teamInvitesResponse.d.ts ├── teamMemberResponse.d.ts ├── teamMembersResponse.d.ts ├── teamParentResponse.d.ts ├── teamRemoveMemberRequest.d.ts ├── teamResponse.d.ts ├── teamSubTeamsResponse.d.ts ├── teamUpdateRequest.d.ts ├── templateAddUserRequest.d.ts ├── templateCreateEmbeddedDraftRequest.d.ts ├── templateCreateEmbeddedDraftResponse.d.ts ├── templateCreateEmbeddedDraftResponseTemplate.d.ts ├── templateCreateRequest.d.ts ├── templateCreateResponse.d.ts ├── templateCreateResponseTemplate.d.ts ├── templateEditResponse.d.ts ├── templateGetResponse.d.ts ├── templateListResponse.d.ts ├── templateRemoveUserRequest.d.ts ├── templateResponse.d.ts ├── templateResponseAccount.d.ts ├── templateResponseAccountQuota.d.ts ├── templateResponseCCRole.d.ts ├── templateResponseDocument.d.ts ├── templateResponseDocumentCustomFieldBase.d.ts ├── templateResponseDocumentCustomFieldCheckbox.d.ts ├── templateResponseDocumentCustomFieldText.d.ts ├── templateResponseDocumentFieldGroup.d.ts ├── templateResponseDocumentFieldGroupRule.d.ts ├── templateResponseDocumentFormFieldBase.d.ts ├── templateResponseDocumentFormFieldCheckbox.d.ts ├── templateResponseDocumentFormFieldDateSigned.d.ts ├── templateResponseDocumentFormFieldDropdown.d.ts ├── templateResponseDocumentFormFieldHyperlink.d.ts ├── templateResponseDocumentFormFieldInitials.d.ts ├── templateResponseDocumentFormFieldRadio.d.ts ├── templateResponseDocumentFormFieldSignature.d.ts ├── templateResponseDocumentFormFieldText.d.ts ├── templateResponseDocumentStaticFieldBase.d.ts ├── templateResponseDocumentStaticFieldCheckbox.d.ts ├── templateResponseDocumentStaticFieldDateSigned.d.ts ├── templateResponseDocumentStaticFieldDropdown.d.ts ├── templateResponseDocumentStaticFieldHyperlink.d.ts ├── templateResponseDocumentStaticFieldInitials.d.ts ├── templateResponseDocumentStaticFieldRadio.d.ts ├── templateResponseDocumentStaticFieldSignature.d.ts ├── templateResponseDocumentStaticFieldText.d.ts ├── templateResponseFieldAvgTextLength.d.ts ├── templateResponseSignerRole.d.ts ├── templateUpdateFilesRequest.d.ts ├── templateUpdateFilesResponse.d.ts ├── templateUpdateFilesResponseTemplate.d.ts ├── unclaimedDraftCreateEmbeddedRequest.d.ts ├── unclaimedDraftCreateEmbeddedWithTemplateRequest.d.ts ├── unclaimedDraftCreateRequest.d.ts ├── unclaimedDraftCreateResponse.d.ts ├── unclaimedDraftEditAndResendRequest.d.ts ├── unclaimedDraftResponse.d.ts └── warningResponse.d.ts /.editorconfig: -------------------------------------------------------------------------------- 1 | [{*.html,*.md,*.json,*.css,*.yml,*.yaml}] 2 | indent_style = space 3 | indent_size = 2 4 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | /.github export-ignore 2 | /.gitmodules export-ignore 3 | /.openapi-generator export-ignore 4 | /.openapi-generator-ignore export-ignore 5 | /.travis.yml export-ignore 6 | /api.ts export-ignore 7 | /composer.json export-ignore 8 | /composer.lock export-ignore 9 | /jest.config.ts export-ignore 10 | /openapi-config.yaml export-ignore 11 | /api export-ignore 12 | /bin export-ignore 13 | /examples export-ignore 14 | /model export-ignore 15 | /oas export-ignore 16 | /run-build export-ignore 17 | /templates export-ignore 18 | /test export-ignore 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | wwwroot/*.js 2 | node_modules 3 | typings 4 | # CUSTOM - BEGIN 5 | test.* 6 | *.tgz 7 | .openapi-generator 8 | .composer 9 | tmp_docs 10 | vendor 11 | # CUSTOM - END 12 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | *.tgz 2 | .editorconfig 3 | .gitattributes 4 | .github 5 | .openapi-generator 6 | .openapi-generator-ignore 7 | bin 8 | composer.json 9 | composer.lock 10 | docs 11 | examples 12 | node_modules 13 | nonversioned 14 | oas 15 | openapi-config.yaml 16 | openapi-sdk.yaml 17 | run-build 18 | templates 19 | test.* 20 | test_fixtures 21 | tests 22 | tsconfig.json 23 | typings 24 | vendor 25 | wwwroot/*.js 26 | -------------------------------------------------------------------------------- /.prettierrc.cjs: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | plugins: [require.resolve('prettier-plugin-organize-imports')] 3 | }; 4 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 1.9.0 2 | -------------------------------------------------------------------------------- /docs/model/AccountCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # AccountCreateResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | 10 | | `oauthData` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | | 11 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/AccountGetResponse.md: -------------------------------------------------------------------------------- 1 | # # AccountGetResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/AccountResponseQuotas.md: -------------------------------------------------------------------------------- 1 | # # AccountResponseQuotas 2 | 3 | Details concerning remaining monthly quotas. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | | 10 | | `documentsLeft` | ```number``` | Signature requests remaining. | | 11 | | `templatesTotal` | ```number``` | Total API templates allowed. | | 12 | | `templatesLeft` | ```number``` | API templates remaining. | | 13 | | `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | 14 | | `numFaxPagesLeft` | ```number``` | Number of fax pages left | | 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/model/AccountResponseUsage.md: -------------------------------------------------------------------------------- 1 | # # AccountResponseUsage 2 | 3 | Details concerning monthly usage 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `faxPagesSent` | ```number``` | Number of fax pages sent | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/AccountUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # AccountUpdateRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `accountId` | ```string``` | The ID of the Account | | 10 | | `callbackUrl` | ```string``` | The URL that Dropbox Sign should POST events to. | | 11 | | `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/AccountVerifyRequest.md: -------------------------------------------------------------------------------- 1 | # # AccountVerifyRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `emailAddress`*_required_ | ```string``` | Email address to run the verification for. | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/AccountVerifyResponse.md: -------------------------------------------------------------------------------- 1 | # # AccountVerifyResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `account` | [```AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/AccountVerifyResponseAccount.md: -------------------------------------------------------------------------------- 1 | # # AccountVerifyResponseAccount 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `emailAddress` | ```string``` | The email address associated with the Account. | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/ApiAppCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # ApiAppCreateRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `domains`*_required_ | ```Array``` | The domain names the ApiApp will be associated with. | | 10 | | `name`*_required_ | ```string``` | The name you want to assign to the ApiApp. | | 11 | | `callbackUrl` | ```string``` | The URL at which the ApiApp should receive event callbacks. | | 12 | | `customLogoFile` | ```RequestFile``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | | 13 | | `oauth` | [```SubOAuth```](SubOAuth.md) | | | 14 | | `options` | [```SubOptions```](SubOptions.md) | | | 15 | | `whiteLabelingOptions` | [```SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | | | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/model/ApiAppGetResponse.md: -------------------------------------------------------------------------------- 1 | # # ApiAppGetResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `apiApp`*_required_ | [```ApiAppResponse```](ApiAppResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/ApiAppListResponse.md: -------------------------------------------------------------------------------- 1 | # # ApiAppListResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `apiApps`*_required_ | [```Array```](ApiAppResponse.md) | Contains information about API Apps. | | 10 | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | 11 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/ApiAppResponseOAuth.md: -------------------------------------------------------------------------------- 1 | # # ApiAppResponseOAuth 2 | 3 | An object describing the app's OAuth properties, or null if OAuth is not configured for the app. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `callbackUrl` | ```string``` | The app's OAuth callback URL. | | 10 | | `secret` | ```string``` | The app's OAuth secret, or null if the app does not belong to user. | | 11 | | `scopes` | ```Array``` | Array of OAuth scopes used by the app. | | 12 | | `chargesUsers` | ```boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/ApiAppResponseOptions.md: -------------------------------------------------------------------------------- 1 | # # ApiAppResponseOptions 2 | 3 | An object with options that override account settings. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `canInsertEverywhere` | ```boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/ApiAppResponseOwnerAccount.md: -------------------------------------------------------------------------------- 1 | # # ApiAppResponseOwnerAccount 2 | 3 | An object describing the app's owner 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `accountId` | ```string``` | The owner account's ID | | 10 | | `emailAddress` | ```string``` | The owner account's email address | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/ApiAppUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # ApiAppUpdateRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `callbackUrl` | ```string``` | The URL at which the API App should receive event callbacks. | | 10 | | `customLogoFile` | ```RequestFile``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | | 11 | | `domains` | ```Array``` | The domain names the ApiApp will be associated with. | | 12 | | `name` | ```string``` | The name you want to assign to the ApiApp. | | 13 | | `oauth` | [```SubOAuth```](SubOAuth.md) | | | 14 | | `options` | [```SubOptions```](SubOptions.md) | | | 15 | | `whiteLabelingOptions` | [```SubWhiteLabelingOptions```](SubWhiteLabelingOptions.md) | | | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/model/BulkSendJobGetResponse.md: -------------------------------------------------------------------------------- 1 | # # BulkSendJobGetResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | 10 | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | 11 | | `signatureRequests`*_required_ | [```Array```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | 12 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/BulkSendJobListResponse.md: -------------------------------------------------------------------------------- 1 | # # BulkSendJobListResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `bulkSendJobs`*_required_ | [```Array```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | 10 | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | 11 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/BulkSendJobResponse.md: -------------------------------------------------------------------------------- 1 | # # BulkSendJobResponse 2 | 3 | Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `bulkSendJobId` | ```string``` | The id of the BulkSendJob. | | 10 | | `total` | ```number``` | The total amount of Signature Requests queued for sending. | | 11 | | `isCreator` | ```boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | 12 | | `createdAt` | ```number``` | Time that the BulkSendJob was created. | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/BulkSendJobSendResponse.md: -------------------------------------------------------------------------------- 1 | # # BulkSendJobSendResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/EmbeddedEditUrlResponse.md: -------------------------------------------------------------------------------- 1 | # # EmbeddedEditUrlResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `embedded`*_required_ | [```EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/EmbeddedEditUrlResponseEmbedded.md: -------------------------------------------------------------------------------- 1 | # # EmbeddedEditUrlResponseEmbedded 2 | 3 | An embedded template object. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `editUrl` | ```string``` | A template url that can be opened in an iFrame. | | 10 | | `expiresAt` | ```number``` | The specific time that the the `edit_url` link expires, in epoch. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/EmbeddedSignUrlResponse.md: -------------------------------------------------------------------------------- 1 | # # EmbeddedSignUrlResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `embedded`*_required_ | [```EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/EmbeddedSignUrlResponseEmbedded.md: -------------------------------------------------------------------------------- 1 | # # EmbeddedSignUrlResponseEmbedded 2 | 3 | An object that contains necessary information to set up embedded signing. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `signUrl` | ```string``` | A signature url that can be opened in an iFrame. | | 10 | | `expiresAt` | ```number``` | The specific time that the the `sign_url` link expires, in epoch. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/ErrorResponse.md: -------------------------------------------------------------------------------- 1 | # # ErrorResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `error`*_required_ | [```ErrorResponseError```](ErrorResponseError.md) | | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/ErrorResponseError.md: -------------------------------------------------------------------------------- 1 | # # ErrorResponseError 2 | 3 | Contains information about an error that occurred. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `errorMsg`*_required_ | ```string``` | Message describing an error. | | 10 | | `errorName`*_required_ | ```string``` | Name of the error. | | 11 | | `errorPath` | ```string``` | Path at which an error occurred. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/EventCallbackRequest.md: -------------------------------------------------------------------------------- 1 | # # EventCallbackRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `event`*_required_ | [```EventCallbackRequestEvent```](EventCallbackRequestEvent.md) | | | 10 | | `account` | [```AccountResponse```](AccountResponse.md) | | | 11 | | `signatureRequest` | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | | 12 | | `template` | [```TemplateResponse```](TemplateResponse.md) | | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/EventCallbackRequestEvent.md: -------------------------------------------------------------------------------- 1 | # # EventCallbackRequestEvent 2 | 3 | Basic information about the event that occurred. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `eventTime`*_required_ | ```string``` | Time the event was created (using Unix time). | | 10 | | `eventType`*_required_ | ```string``` | Type of callback event that was triggered. | | 11 | | `eventHash`*_required_ | ```string``` | Generated hash used to verify source of event data. | | 12 | | `eventMetadata` | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/EventCallbackRequestEventMetadata.md: -------------------------------------------------------------------------------- 1 | # # EventCallbackRequestEventMetadata 2 | 3 | Specific metadata about the event. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `relatedSignatureId` | ```string``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | 10 | | `reportedForAccountId` | ```string``` | Account ID the event was reported for. | | 11 | | `reportedForAppId` | ```string``` | App ID the event was reported for. | | 12 | | `eventMessage` | ```string``` | Message about a declined or failed (due to error) signature flow. | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/FaxGetResponse.md: -------------------------------------------------------------------------------- 1 | # # FaxGetResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/FaxLineAddUserRequest.md: -------------------------------------------------------------------------------- 1 | # # FaxLineAddUserRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `number`*_required_ | ```string``` | The Fax Line number | | 10 | | `accountId` | ```string``` | Account ID | | 11 | | `emailAddress` | ```string``` | Email address | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/FaxLineAreaCodeGetCountryEnum.md: -------------------------------------------------------------------------------- 1 | # # FaxLineAreaCodeGetCountryEnum 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/model/FaxLineAreaCodeGetProvinceEnum.md: -------------------------------------------------------------------------------- 1 | # # FaxLineAreaCodeGetProvinceEnum 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/model/FaxLineAreaCodeGetResponse.md: -------------------------------------------------------------------------------- 1 | # # FaxLineAreaCodeGetResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `areaCodes`*_required_ | ```Array``` | | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/FaxLineAreaCodeGetStateEnum.md: -------------------------------------------------------------------------------- 1 | # # FaxLineAreaCodeGetStateEnum 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/model/FaxLineCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # FaxLineCreateRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `areaCode`*_required_ | ```number``` | Area code of the new Fax Line | | 10 | | `country`*_required_ | ```string``` | Country of the area code | | 11 | | `city` | ```string``` | City of the area code | | 12 | | `accountId` | ```string``` | Account ID of the account that will be assigned this new Fax Line | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/FaxLineDeleteRequest.md: -------------------------------------------------------------------------------- 1 | # # FaxLineDeleteRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `number`*_required_ | ```string``` | The Fax Line number | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/FaxLineListResponse.md: -------------------------------------------------------------------------------- 1 | # # FaxLineListResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | 10 | | `faxLines`*_required_ | [```Array```](FaxLineResponseFaxLine.md) | | | 11 | | `warnings` | [```WarningResponse```](WarningResponse.md) | | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/FaxLineRemoveUserRequest.md: -------------------------------------------------------------------------------- 1 | # # FaxLineRemoveUserRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `number`*_required_ | ```string``` | The Fax Line number | | 10 | | `accountId` | ```string``` | Account ID of the user to remove access | | 11 | | `emailAddress` | ```string``` | Email address of the user to remove access | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/FaxLineResponse.md: -------------------------------------------------------------------------------- 1 | # # FaxLineResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `faxLine`*_required_ | [```FaxLineResponseFaxLine```](FaxLineResponseFaxLine.md) | | | 10 | | `warnings` | [```WarningResponse```](WarningResponse.md) | | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/FaxLineResponseFaxLine.md: -------------------------------------------------------------------------------- 1 | # # FaxLineResponseFaxLine 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `number` | ```string``` | Number | | 10 | | `createdAt` | ```number``` | Created at | | 11 | | `updatedAt` | ```number``` | Updated at | | 12 | | `accounts` | [```Array```](AccountResponse.md) | | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/FaxListResponse.md: -------------------------------------------------------------------------------- 1 | # # FaxListResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `faxes`*_required_ | [```Array```](FaxResponse.md) | | | 10 | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/FaxResponseTransmission.md: -------------------------------------------------------------------------------- 1 | # # FaxResponseTransmission 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `recipient`*_required_ | ```string``` | Fax Transmission Recipient | | 10 | | `statusCode`*_required_ | ```string``` | Fax Transmission Status Code | | 11 | | `sentAt` | ```number``` | Fax Transmission Sent Timestamp | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/FileResponse.md: -------------------------------------------------------------------------------- 1 | # # FileResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `fileUrl`*_required_ | ```string``` | URL to the file. | | 10 | | `expiresAt`*_required_ | ```number``` | When the link expires. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/FileResponseDataUri.md: -------------------------------------------------------------------------------- 1 | # # FileResponseDataUri 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `dataUri`*_required_ | ```string``` | File as base64 encoded string. | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/ListInfoResponse.md: -------------------------------------------------------------------------------- 1 | # # ListInfoResponse 2 | 3 | Contains pagination information about the data returned. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `numPages` | ```number``` | Total number of pages available. | | 10 | | `numResults` | ```number``` | Total number of objects available. | | 11 | | `page` | ```number``` | Number of the page being returned. | | 12 | | `pageSize` | ```number``` | Objects returned per page. | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/OAuthTokenGenerateRequest.md: -------------------------------------------------------------------------------- 1 | # # OAuthTokenGenerateRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `clientId`*_required_ | ```string``` | The client id of the app requesting authorization. | | 10 | | `clientSecret`*_required_ | ```string``` | The secret token of your app. | | 11 | | `code`*_required_ | ```string``` | The code passed to your callback when the user granted access. | | 12 | | `grantType`*_required_ | ```string``` | When generating a new token use `authorization_code`. | [default to 'authorization_code'] | 13 | | `state`*_required_ | ```string``` | Same as the state you specified earlier. | | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/model/OAuthTokenResponse.md: -------------------------------------------------------------------------------- 1 | # # OAuthTokenResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `accessToken` | ```string``` | | | 10 | | `tokenType` | ```string``` | | | 11 | | `refreshToken` | ```string``` | | | 12 | | `expiresIn` | ```number``` | Number of seconds until the `access_token` expires. Uses epoch time. | | 13 | | `state` | ```string``` | | | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/model/ReportCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # ReportCreateRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `endDate`*_required_ | ```string``` | The (inclusive) end date for the report data in `MM/DD/YYYY` format. | | 10 | | `reportType`*_required_ | ```Array``` | The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). | | 11 | | `startDate`*_required_ | ```string``` | The (inclusive) start date for the report data in `MM/DD/YYYY` format. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/ReportCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # ReportCreateResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `report`*_required_ | [```ReportResponse```](ReportResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestGetResponse.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestGetResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `signatureRequest`*_required_ | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestListResponse.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestListResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `signatureRequests`*_required_ | [```Array```](SignatureRequestResponse.md) | Contains information about signature requests. | | 10 | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | 11 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestRemindRequest.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestRemindRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `emailAddress`*_required_ | ```string``` | The email address of the signer to send a reminder to. | | 10 | | `name` | ```string``` | The name of the signer to send a reminder to. Include if two or more signers share an email address. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseAttachment.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseAttachment 2 | 3 | Signer attachments. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `id`*_required_ | ```string``` | The unique ID for this attachment. | | 10 | | `signer`*_required_ | ```string``` | The Signer this attachment is assigned to. | | 11 | | `name`*_required_ | ```string``` | The name of this attachment. | | 12 | | `required`*_required_ | ```boolean``` | A boolean value denoting if this attachment is required. | | 13 | | `instructions` | ```string``` | Instructions for Signer. | | 14 | | `uploadedAt` | ```number``` | Timestamp when attachment was uploaded by Signer. | | 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseCustomFieldCheckbox.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseCustomFieldCheckbox 2 | 3 | This class extends `SignatureRequestResponseCustomFieldBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'checkbox'] | 10 | | `value` | ```boolean``` | A true/false for checkbox fields | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseCustomFieldText.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseCustomFieldText 2 | 3 | This class extends `SignatureRequestResponseCustomFieldBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'text'] | 10 | | `value` | ```string``` | A text string for text fields | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseCustomFieldTypeEnum.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseCustomFieldTypeEnum 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataBase.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataBase 2 | 3 | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `apiId` | ```string``` | The unique ID for this field. | | 10 | | `signatureId` | ```string``` | The ID of the signature to which this response is linked. | | 11 | | `name` | ```string``` | The name of the form field. | | 12 | | `required` | ```boolean``` | A boolean value denoting if this field is required. | | 13 | | `type` | ```string``` | | | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataTypeEnum.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataTypeEnum 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataValueCheckbox.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataValueCheckbox 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type` | ```string``` | A yes/no checkbox | [default to 'checkbox'] | 10 | | `value` | ```boolean``` | The value of the form field. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataValueCheckboxMerge.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataValueCheckboxMerge 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type` | ```string``` | A checkbox field that has default value set by the api | [default to 'checkbox-merge'] | 10 | | `value` | ```string``` | The value of the form field. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataValueDateSigned.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataValueDateSigned 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type` | ```string``` | A date | [default to 'date_signed'] | 10 | | `value` | ```string``` | The value of the form field. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataValueDropdown.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataValueDropdown 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type` | ```string``` | An input field for dropdowns | [default to 'dropdown'] | 10 | | `value` | ```string``` | The value of the form field. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataValueInitials.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataValueInitials 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type` | ```string``` | An input field for initials | [default to 'initials'] | 10 | | `value` | ```string``` | The value of the form field. | | 11 | | `isSigned` | ```boolean``` | This field contains the boolean true if the field is signed. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataValueRadio.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataValueRadio 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type` | ```string``` | An input field for radios | [default to 'radio'] | 10 | | `value` | ```boolean``` | The value of the form field. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataValueSignature.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataValueSignature 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type` | ```string``` | A signature input field | [default to 'signature'] | 10 | | `value` | ```string``` | The value of the form field. | | 11 | | `isSigned` | ```boolean``` | This field contains the boolean true if the field is signed. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataValueText.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataValueText 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type` | ```string``` | A text input field | [default to 'text'] | 10 | | `value` | ```string``` | The value of the form field. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SignatureRequestResponseDataValueTextMerge.md: -------------------------------------------------------------------------------- 1 | # # SignatureRequestResponseDataValueTextMerge 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type` | ```string``` | A text field that has default text set by the api | [default to 'text-merge'] | 10 | | `value` | ```string``` | The value of the form field. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SubAttachment.md: -------------------------------------------------------------------------------- 1 | # # SubAttachment 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name`*_required_ | ```string``` | The name of attachment. | | 10 | | `signerIndex`*_required_ | ```number``` | The signer's index in the `signers` parameter (0-based indexing).

**NOTE:** Only one signer can be assigned per attachment. | | 11 | | `instructions` | ```string``` | The instructions for uploading the attachment. | | 12 | | `required` | ```boolean``` | Determines if the attachment must be uploaded. | [default to false] | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/SubBulkSignerList.md: -------------------------------------------------------------------------------- 1 | # # SubBulkSignerList 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `customFields` | [```Array```](SubBulkSignerListCustomField.md) | An array of custom field values. | | 10 | | `signers` | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.

Currently only templates with a single role are supported. All signers must have the same `role` value. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SubBulkSignerListCustomField.md: -------------------------------------------------------------------------------- 1 | # # SubBulkSignerListCustomField 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name`*_required_ | ```string``` | The name of the custom field. Must be the field's `name` or `api_id`. | | 10 | | `value`*_required_ | ```string``` | The value of the custom field. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SubCC.md: -------------------------------------------------------------------------------- 1 | # # SubCC 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `role`*_required_ | ```string``` | Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role. | | 10 | | `emailAddress`*_required_ | ```string``` | The email address of the CC recipient. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SubEditorOptions.md: -------------------------------------------------------------------------------- 1 | # # SubEditorOptions 2 | 3 | This allows the requester to specify editor options when a preparing a document 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `allowEditSigners` | ```boolean``` | Allows requesters to edit the list of signers | [default to false] | 10 | | `allowEditDocuments` | ```boolean``` | Allows requesters to edit documents, including delete and add | [default to false] | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SubFieldOptions.md: -------------------------------------------------------------------------------- 1 | # # SubFieldOptions 2 | 3 | This allows the requester to specify field options for a signature request. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `dateFormat`*_required_ | ```string``` | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))

**NOTE:** Only available for Premium and higher. | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldGroup.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldGroup 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `groupId`*_required_ | ```string``` | ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`. | | 10 | | `groupLabel`*_required_ | ```string``` | Name of the group | | 11 | | `requirement`*_required_ | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentCheckbox.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentCheckbox 2 | 3 | This class extends `SubFormFieldsPerDocumentBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class. | [default to 'checkbox'] | 10 | | `isChecked`*_required_ | ```boolean``` | `true` for checking the checkbox field by default, otherwise `false`. | | 11 | | `group` | ```string``` | String referencing group defined in `form_field_groups` parameter. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentCheckboxMerge.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentCheckboxMerge 2 | 3 | This class extends `SubFormFieldsPerDocumentBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class. | [default to 'checkbox-merge'] | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentDateSigned.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentDateSigned 2 | 3 | This class extends `SubFormFieldsPerDocumentBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to 'date_signed'] | 10 | | `fontFamily` | ```string``` | Font family for the field. | | 11 | | `fontSize` | ```number``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentFontEnum.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentFontEnum 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentHyperlink.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentHyperlink 2 | 3 | This class extends `SubFormFieldsPerDocumentBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. | [default to 'hyperlink'] | 10 | | `content`*_required_ | ```string``` | Link Text. | | 11 | | `contentUrl`*_required_ | ```string``` | Link URL. | | 12 | | `fontFamily` | ```string``` | Font family for the field. | | 13 | | `fontSize` | ```number``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentInitials.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentInitials 2 | 3 | This class extends `SubFormFieldsPerDocumentBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class. | [default to 'initials'] | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentRadio.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentRadio 2 | 3 | This class extends `SubFormFieldsPerDocumentBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. | [default to 'radio'] | 10 | | `group`*_required_ | ```string``` | String referencing group defined in `form_field_groups` parameter. | | 11 | | `isChecked`*_required_ | ```boolean``` | `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentSignature.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentSignature 2 | 3 | This class extends `SubFormFieldsPerDocumentBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. | [default to 'signature'] | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentTextMerge.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentTextMerge 2 | 3 | This class extends `SubFormFieldsPerDocumentBase`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] | 10 | | `fontFamily` | ```string``` | Font family for the field. | | 11 | | `fontSize` | ```number``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.

**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SubFormFieldsPerDocumentTypeEnum.md: -------------------------------------------------------------------------------- 1 | # # SubFormFieldsPerDocumentTypeEnum 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | 10 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 11 | -------------------------------------------------------------------------------- /docs/model/SubMergeField.md: -------------------------------------------------------------------------------- 1 | # # SubMergeField 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name`*_required_ | ```string``` | The name of the merge field. Must be unique. | | 10 | | `type`*_required_ | ```string``` | The type of merge field. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SubOAuth.md: -------------------------------------------------------------------------------- 1 | # # SubOAuth 2 | 3 | OAuth related parameters. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `callbackUrl` | ```string``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | 10 | | `scopes` | ```Array``` | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SubOptions.md: -------------------------------------------------------------------------------- 1 | # # SubOptions 2 | 3 | Additional options supported by API App. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `canInsertEverywhere` | ```boolean``` | Determines if signers can use "Insert Everywhere" when signing a document. | [default to false] | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/SubSignatureRequestGroupedSigners.md: -------------------------------------------------------------------------------- 1 | # # SubSignatureRequestGroupedSigners 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `group`*_required_ | ```string``` | The name of the group. | | 10 | | `signers`*_required_ | [```Array```](SubSignatureRequestSigner.md) | Signers belonging to this Group.

**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. | | 11 | | `order` | ```number``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SubSigningOptions.md: -------------------------------------------------------------------------------- 1 | # # SubSigningOptions 2 | 3 | This allows the requester to specify the types allowed for creating a signature. 4 | 5 | **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. 6 | 7 | ## Properties 8 | 9 | Name | Type | Description | Notes 10 | ------------ | ------------- | ------------- | ------------- 11 | | `defaultType`*_required_ | ```string``` | The default type shown (limited to the listed types) | | 12 | | `draw` | ```boolean``` | Allows drawing the signature | [default to false] | 13 | | `phone` | ```boolean``` | Allows using a smartphone to email the signature | [default to false] | 14 | | `type` | ```boolean``` | Allows typing the signature | [default to false] | 15 | | `upload` | ```boolean``` | Allows uploading the signature | [default to false] | 16 | 17 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 18 | -------------------------------------------------------------------------------- /docs/model/SubTeamResponse.md: -------------------------------------------------------------------------------- 1 | # # SubTeamResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `teamId` | ```string``` | The id of a team | | 10 | | `name` | ```string``` | The name of a team | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SubTemplateRole.md: -------------------------------------------------------------------------------- 1 | # # SubTemplateRole 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name` | ```string``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | 10 | | `order` | ```number``` | The order in which this signer role is required to sign. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/SubUnclaimedDraftSigner.md: -------------------------------------------------------------------------------- 1 | # # SubUnclaimedDraftSigner 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `emailAddress`*_required_ | ```string``` | The email address of the signer. | | 10 | | `name`*_required_ | ```string``` | The name of the signer. | | 11 | | `order` | ```number``` | The order the signer is required to sign in. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/SubUnclaimedDraftTemplateSigner.md: -------------------------------------------------------------------------------- 1 | # # SubUnclaimedDraftTemplateSigner 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `role`*_required_ | ```string``` | Must match an existing role in chosen Template(s). | | 10 | | `name`*_required_ | ```string``` | The name of the signer filling the role of `role`. | | 11 | | `emailAddress`*_required_ | ```string``` | The email address of the signer filling the role of `role`. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/TeamAddMemberRequest.md: -------------------------------------------------------------------------------- 1 | # # TeamAddMemberRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `accountId` | ```string``` | `account_id` or `email_address` is required. If both are provided, the account id prevails.

Account id of the user to invite to your Team. | | 10 | | `emailAddress` | ```string``` | `account_id` or `email_address` is required, If both are provided, the account id prevails.

Email address of the user to invite to your Team. | | 11 | | `role` | ```string``` | A role member will take in a new Team.

**NOTE:** This parameter is used only if `team_id` is provided. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/TeamCreateRequest.md: -------------------------------------------------------------------------------- 1 | # # TeamCreateRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name` | ```string``` | The name of your Team. | [default to 'Untitled Team'] | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/TeamGetInfoResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamGetInfoResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `team`*_required_ | [```TeamInfoResponse```](TeamInfoResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TeamGetResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamGetResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `team`*_required_ | [```TeamResponse```](TeamResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TeamInfoResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamInfoResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `teamId` | ```string``` | The id of a team | | 10 | | `teamParent` | [```TeamParentResponse```](TeamParentResponse.md) | | | 11 | | `name` | ```string``` | The name of a team | | 12 | | `numMembers` | ```number``` | Number of members within a team | | 13 | | `numSubTeams` | ```number``` | Number of sub teams within a team | | 14 | 15 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 16 | -------------------------------------------------------------------------------- /docs/model/TeamInviteResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamInviteResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `emailAddress` | ```string``` | Email address of the user invited to this team. | | 10 | | `teamId` | ```string``` | Id of the team. | | 11 | | `role` | ```string``` | Role of the user invited to this team. | | 12 | | `sentAt` | ```number``` | Timestamp when the invitation was sent. | | 13 | | `redeemedAt` | ```number``` | Timestamp when the invitation was redeemed. | | 14 | | `expiresAt` | ```number``` | Timestamp when the invitation is expiring. | | 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/model/TeamInvitesResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamInvitesResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `teamInvites`*_required_ | [```Array```](TeamInviteResponse.md) | Contains a list of team invites and their roles. | | 10 | | `warnings` | [```Array```](WarningResponse.md) | | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TeamMemberResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamMemberResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `accountId` | ```string``` | Account id of the team member. | | 10 | | `emailAddress` | ```string``` | Email address of the team member. | | 11 | | `role` | ```string``` | The specific role a member has on the team. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/TeamMembersResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamMembersResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `teamMembers`*_required_ | [```Array```](TeamMemberResponse.md) | Contains a list of team members and their roles for a specific team. | | 10 | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | 11 | | `warnings` | [```Array```](WarningResponse.md) | | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/TeamParentResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamParentResponse 2 | 3 | Information about the parent team if a team has one, set to `null` otherwise. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `teamId` | ```string``` | The id of a team | | 10 | | `name` | ```string``` | The name of a team | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TeamResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamResponse 2 | 3 | Contains information about your team and its members 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name` | ```string``` | The name of your Team | | 10 | | `accounts` | [```Array```](AccountResponse.md) | | | 11 | | `invitedAccounts` | [```Array```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | | 12 | | `invitedEmails` | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/TeamSubTeamsResponse.md: -------------------------------------------------------------------------------- 1 | # # TeamSubTeamsResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `subTeams`*_required_ | [```Array```](SubTeamResponse.md) | Contains a list with sub teams. | | 10 | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | 11 | | `warnings` | [```Array```](WarningResponse.md) | | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/TeamUpdateRequest.md: -------------------------------------------------------------------------------- 1 | # # TeamUpdateRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name` | ```string``` | The name of your Team. | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/TemplateAddUserRequest.md: -------------------------------------------------------------------------------- 1 | # # TemplateAddUserRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `accountId` | ```string``` | The id of the Account to give access to the Template.
**NOTE:** The account id prevails if email address is also provided. | | 10 | | `emailAddress` | ```string``` | The email address of the Account to give access to the Template.
**NOTE:** The account id prevails if it is also provided. | | 11 | | `skipNotification` | ```boolean``` | If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`. | [default to false] | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/TemplateCreateEmbeddedDraftResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplateCreateEmbeddedDraftResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `template`*_required_ | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md: -------------------------------------------------------------------------------- 1 | # # TemplateCreateEmbeddedDraftResponseTemplate 2 | 3 | Template object with parameters: `template_id`, `edit_url`, `expires_at`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `templateId` | ```string``` | The id of the Template. | | 10 | | `editUrl` | ```string``` | Link to edit the template. | | 11 | | `expiresAt` | ```number``` | When the link expires. | | 12 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/TemplateCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplateCreateResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `template`*_required_ | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TemplateCreateResponseTemplate.md: -------------------------------------------------------------------------------- 1 | # # TemplateCreateResponseTemplate 2 | 3 | Template object with parameters: `template_id`. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `templateId` | ```string``` | The id of the Template. | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/TemplateEditResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplateEditResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `templateId`*_required_ | ```string``` | The id of the Template. | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/TemplateGetResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplateGetResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `template`*_required_ | [```TemplateResponse```](TemplateResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TemplateListResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplateListResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `templates`*_required_ | [```Array```](TemplateResponse.md) | List of templates that the API caller has access to. | | 10 | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | 11 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 12 | 13 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 14 | -------------------------------------------------------------------------------- /docs/model/TemplateRemoveUserRequest.md: -------------------------------------------------------------------------------- 1 | # # TemplateRemoveUserRequest 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `accountId` | ```string``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | | 10 | | `emailAddress` | ```string``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TemplateResponseAccount.md: -------------------------------------------------------------------------------- 1 | # # TemplateResponseAccount 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `accountId` | ```string``` | The id of the Account. | | 10 | | `emailAddress` | ```string``` | The email address associated with the Account. | | 11 | | `isLocked` | ```boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | 12 | | `isPaidHs` | ```boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | 13 | | `isPaidHf` | ```boolean``` | Returns `true` if the user has a paid HelloFax account. | | 14 | | `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | 15 | 16 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 17 | -------------------------------------------------------------------------------- /docs/model/TemplateResponseAccountQuota.md: -------------------------------------------------------------------------------- 1 | # # TemplateResponseAccountQuota 2 | 3 | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `templatesLeft` | ```number``` | API templates remaining. | | 10 | | `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | | 11 | | `documentsLeft` | ```number``` | Signature requests remaining. | | 12 | | `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | 13 | 14 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 15 | -------------------------------------------------------------------------------- /docs/model/TemplateResponseCCRole.md: -------------------------------------------------------------------------------- 1 | # # TemplateResponseCCRole 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name` | ```string``` | The name of the Role. | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/TemplateResponseDocumentCustomFieldCheckbox.md: -------------------------------------------------------------------------------- 1 | # # TemplateResponseDocumentCustomFieldCheckbox 2 | 3 | This class extends `TemplateResponseDocumentCustomFieldBase` 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'checkbox'] | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/TemplateResponseDocumentFieldGroup.md: -------------------------------------------------------------------------------- 1 | # # TemplateResponseDocumentFieldGroup 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name` | ```string``` | The name of the form field group. | | 10 | | `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TemplateResponseDocumentFieldGroupRule.md: -------------------------------------------------------------------------------- 1 | # # TemplateResponseDocumentFieldGroupRule 2 | 3 | The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `requirement` | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | 10 | | `groupLabel` | ```string``` | Name of the group | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TemplateResponseFieldAvgTextLength.md: -------------------------------------------------------------------------------- 1 | # # TemplateResponseFieldAvgTextLength 2 | 3 | Average text length in this field. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `numLines` | ```number``` | Number of lines. | | 10 | | `numCharsPerLine` | ```number``` | Number of characters per line. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TemplateResponseSignerRole.md: -------------------------------------------------------------------------------- 1 | # # TemplateResponseSignerRole 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `name` | ```string``` | The name of the Role. | | 10 | | `order` | ```number``` | If signer order is assigned this is the 0-based index for this role. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/TemplateUpdateFilesResponse.md: -------------------------------------------------------------------------------- 1 | # # TemplateUpdateFilesResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `template`*_required_ | [```TemplateUpdateFilesResponseTemplate```](TemplateUpdateFilesResponseTemplate.md) | | | 10 | 11 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 12 | -------------------------------------------------------------------------------- /docs/model/TemplateUpdateFilesResponseTemplate.md: -------------------------------------------------------------------------------- 1 | # # TemplateUpdateFilesResponseTemplate 2 | 3 | Contains template id 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `templateId` | ```string``` | The id of the Template. | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/UnclaimedDraftCreateResponse.md: -------------------------------------------------------------------------------- 1 | # # UnclaimedDraftCreateResponse 2 | 3 | 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `unclaimedDraft`*_required_ | [```UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | 10 | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /docs/model/WarningResponse.md: -------------------------------------------------------------------------------- 1 | # # WarningResponse 2 | 3 | A list of warnings. 4 | 5 | ## Properties 6 | 7 | Name | Type | Description | Notes 8 | ------------ | ------------- | ------------- | ------------- 9 | | `warningMsg`*_required_ | ```string``` | Warning message | | 10 | | `warningName`*_required_ | ```string``` | Warning name | | 11 | 12 | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) 13 | -------------------------------------------------------------------------------- /test_fixtures/AccountCreateRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "email_address": "newuser@dropboxsign.com", 4 | "client_id": "cc91c61d00f8bb2ece1428035716b", 5 | "client_secret": "1d14434088507ffa390e6f5528465" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /test_fixtures/AccountCreateResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "account": { 4 | "account_id": "a2b31224f7e6fb5581d2f8cbd91cf65fa2f86aae", 5 | "email_address": "newuser@dropboxsign.com", 6 | "is_paid_hs": false, 7 | "is_paid_hf": false, 8 | "is_locked": false, 9 | "quotas": { 10 | "templates_left": 0, 11 | "api_signature_requests_left": 0, 12 | "documents_left": 3 13 | } 14 | } 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /test_fixtures/AccountGetResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "account": { 4 | "account_id": "5008b25c7f67153e57d5a357b1687968068fb465", 5 | "email_address": "me@dropboxsign.com", 6 | "is_locked": false, 7 | "is_paid_hs": true, 8 | "is_paid_hf": false, 9 | "quotas": { 10 | "api_signature_requests_left": 1250 11 | } 12 | } 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /test_fixtures/AccountUpdateRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "callback_url": "https://www.example.com/callback" 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /test_fixtures/AccountVerifyRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "email_address": "some_user@dropboxsign.com" 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /test_fixtures/AccountVerifyResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "account": { 4 | "email_address": "some_user@dropboxsign.com" 5 | } 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /test_fixtures/BulkSendJobListResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "list_info": { 4 | "page": 1, 5 | "num_pages": 1, 6 | "num_results": 2, 7 | "page_size": 20 8 | }, 9 | "bulk_send_jobs": [ 10 | { 11 | "bulk_send_job_id": "fef03f144d9384737a98ff2ca6c1fd9d7bc2239a", 12 | "total": 250, 13 | "is_creator": false, 14 | "created_at": 1532740871 15 | }, 16 | { 17 | "bulk_send_job_id": "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", 18 | "total": 1, 19 | "is_creator": true, 20 | "created_at": 1532640962 21 | } 22 | ] 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /test_fixtures/BulkSendJobSendResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "bulk_send_job": { 4 | "bulk_send_job_id": "ccaf88244ef006b6e31ebba5ed4cb53b3131d9ac", 5 | "total": 3, 6 | "is_creator": true, 7 | "created_at": 1543556038 8 | } 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /test_fixtures/EmbeddedEditUrlRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "allow_edit_ccs": true, 4 | "cc_roles": [ 5 | "" 6 | ], 7 | "editor_options": { 8 | "allow_edit_signers": true, 9 | "allow_edit_documents": false 10 | }, 11 | "force_signer_roles": true, 12 | "force_subject_message": true, 13 | "merge_fields": [ 14 | { 15 | "name": "field1", 16 | "type": "text" 17 | }, 18 | { 19 | "name": "field1", 20 | "type": "checkbox" 21 | } 22 | ], 23 | "preview_only": true, 24 | "show_preview": true, 25 | "show_progress_stepper": true, 26 | "test_mode": true 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /test_fixtures/EmbeddedEditUrlResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "embedded": { 4 | "edit_url": "https://app.hellosign.com/editor/embeddedTemplate?token=70ca8e5779c9a931125db09f3170efc1&root_snapshot_guids[]=a97ce534aec6cbe09e70cdd55112e31bd320ed00&edited_template_guid=61a832ff0d8423f91d503e76bfbcc750f7417c78&guid=56ecaf0659aa29215d2ee489c0c88ff8c9496099&force_signer_input=1", 5 | "expires_at": 1634313821 6 | } 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /test_fixtures/EmbeddedSignUrlResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "embedded": { 4 | "sign_url": "https://app.hellosign.com/editor/embeddedSign?signature_id=50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b&token=b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", 5 | "expires_at": 1634313821 6 | } 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /test_fixtures/ErrorResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "error": { 4 | "error_msg": "Generic error message", 5 | "error_path": "path_to_error[0]", 6 | "error_name": "bad_request" 7 | } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /test_fixtures/FaxSendRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "file_url": [ 4 | "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" 5 | ], 6 | "test_mode": "true", 7 | "recipient": "16690000001", 8 | "sender": "16690000000", 9 | "cover_page_to": "Jill Fax", 10 | "cover_page_message": "I'm sending you a fax!", 11 | "cover_page_from": "Faxer Faxerson", 12 | "title": "This is what the fax is about!" 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /test_fixtures/FaxSendResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "fax": { 4 | "fax_id": "c2e9691c85d9d6fa6ae773842e3680b2b8650f1d", 5 | "title": "example title", 6 | "original_title": "example original title", 7 | "subject": "example subject", 8 | "message": "example message", 9 | "metadata": [ ], 10 | "created_at": 1726774555, 11 | "sender": "me@dropboxsign.com", 12 | "transmissions": [], 13 | "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" 14 | } 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /test_fixtures/FileResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "file_url": "https://s3.amazonaws.com/hellofax_uploads/super_groups/2016/03/18/9aba07a585d7e223b4f137c8981c5e5892893c00/merged-completed.pdf?AWSAccessKeyId=AKIAJWEWDFQHQMBECJZA&Expires=1452868903&Signature=M%2FNDS%2BQre8xjPvzm7fHf%2BjO8Zbc%3D", 4 | "expires_at": 1458605123 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /test_fixtures/OAuthTokenGenerateRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "state": "900e06e2", 4 | "code": "1b0d28d90c86c141", 5 | "grant_type": "authorization_code", 6 | "client_id": "cc91c61d00f8bb2ece1428035716b", 7 | "client_secret": "1d14434088507ffa390e6f5528465" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /test_fixtures/OAuthTokenRefreshRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "grant_type": "refresh_token", 4 | "refresh_token": "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /test_fixtures/OAuthTokenResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "access_token": "NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc=", 4 | "token_type": "Bearer", 5 | "refresh_token": "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", 6 | "expires_in": 86400, 7 | "state": "900e06e2" 8 | }, 9 | "refresh": { 10 | "access_token": "NWNiOTMxOGFkOGVjMDhhNTAxZN2NkNjgxMjMwOWJiYTEzZTBmZGUzMjMThhMzYyMzc=", 11 | "token_type": "Bearer", 12 | "refresh_token": "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", 13 | "expires_in": 86400 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /test_fixtures/ReportCreateRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "start_date": "09/01/2020", 4 | "end_date": "09/01/2020", 5 | "report_type": [ 6 | "user_activity", 7 | "document_status" 8 | ] 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /test_fixtures/ReportCreateResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "report": { 4 | "success": "Your request is being processed. You will receive an email when the report is ready.", 5 | "start_date": "09/01/2020", 6 | "end_date": "09/02/2020", 7 | "report_type": [ 8 | "user_activity", 9 | "document_status" 10 | ] 11 | } 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /test_fixtures/SignatureRequestRemindRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "email_address": "john@example.com" 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /test_fixtures/SignatureRequestUpdateRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "email_address": "john@example.com", 4 | "name": "New Signer 1", 5 | "signature_id": "The signature ID for the recipient." 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /test_fixtures/TeamAddMemberRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "account_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", 4 | "email_address": "george@example.com" 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /test_fixtures/TeamCreateRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "name": "Team America World Police" 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /test_fixtures/TeamRemoveMemberRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "account_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", 4 | "email_address": "teammate@dropboxsign.com", 5 | "new_owner_email_address": "new_teammate@dropboxsign.com" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /test_fixtures/TeamUpdateRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "name": "New Team Name" 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /test_fixtures/TemplateAddUserRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "account_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", 4 | "email_address": "george@dropboxsign.com", 5 | "skip_notification": false 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /test_fixtures/TemplateCreateEmbeddedDraftResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "template": { 4 | "template_id": "61a832ff0d8423f91d503e76bfbcc750f7417c78", 5 | "edit_url": "https://app.hellosign.com/editor/embeddedTemplate?token=8d80ead273a0405d6844005a20beb99b&root_snapshot_guids%5B0%5D=74cc144a76afa5bdca3378278e9a6ac3c2947c92&snapshot_access_guids%5B0%5D=9ceac764&guid=61a832ff0d8423f91d503e76bfbcc750f7417c78", 6 | "expires_at": 1427306768 7 | } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /test_fixtures/TemplateCreateResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "template": { 4 | "template_id": "21f920ec2b7f4b6bb64d3ed79f26303843046536" 5 | } 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /test_fixtures/TemplateRemoveUserRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "account_id": "37dee8d8440c66d54cfa05d92c160882", 4 | "email_address": "george@dropboxsign.com" 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /test_fixtures/TemplateUpdateFilesRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "client_id": "37dee8d8440c66d54cfa05d92c160882", 4 | "file_urls": [ 5 | "https://app.hellosign.com/docs/example_signature_request.pdf" 6 | ], 7 | "message": "For your approval", 8 | "subject": "Please sign this document", 9 | "test_mode": true 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /test_fixtures/TemplateUpdateFilesResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "template": { 4 | "template_id": "f57db65d3f933122019888057a36176831451a35" 5 | } 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /test_fixtures/UnclaimedDraftCreateResponse.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "unclaimed_draft": { 4 | "claim_url": "https://app.hellosign.com/send/resendDocs?root_snapshot_guids[]=7f967b7d06e154394eab693febedf61e8ebe49eb&snapshot_access_guids[]=fb848631&root_snapshot_guids[]=7aedaf31e12edf9f2672a0b2ddf028aca670e101&snapshot_access_guids[]=f398ef87", 5 | "expires_at": 1414093891, 6 | "test_mode": true 7 | } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /test_fixtures/UnclaimedDraftEditAndResendRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "default": { 3 | "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", 4 | "editor_options": { 5 | "allow_edit_signers": true, 6 | "allow_edit_documents": false 7 | }, 8 | "is_for_embedded_signing": false, 9 | "requester_email_address": "jack@dropboxsign.com", 10 | "requesting_redirect_url": "https://example.com/redirect", 11 | "show_progress_stepper": true, 12 | "signing_redirect_url": "https://example.com/redirect", 13 | "test_mode": false 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /test_fixtures/bulk-send-sample.csv: -------------------------------------------------------------------------------- 1 | "name","email_address" 2 | "Bulk Send Signer 1","bulk-send-signer-1@example.com" 3 | "Bulk Send Signer 2","bulk-send-signer-2@example.com" 4 | -------------------------------------------------------------------------------- /test_fixtures/pdf-sample-2.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hellosign/dropbox-sign-node/2708c621c52b2e30277dbca535b364d3222569c9/test_fixtures/pdf-sample-2.pdf -------------------------------------------------------------------------------- /test_fixtures/pdf-sample.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hellosign/dropbox-sign-node/2708c621c52b2e30277dbca535b364d3222569c9/test_fixtures/pdf-sample.pdf -------------------------------------------------------------------------------- /types/api.d.ts: -------------------------------------------------------------------------------- 1 | export * from './api/index'; 2 | export * from './model/index'; 3 | -------------------------------------------------------------------------------- /types/model/accountCreateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class AccountCreateRequest { 3 | "emailAddress": string; 4 | "clientId"?: string; 5 | "clientSecret"?: string; 6 | "locale"?: string; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): AccountCreateRequest; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/accountCreateResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { AccountResponse } from "./accountResponse"; 3 | import { OAuthTokenResponse } from "./oAuthTokenResponse"; 4 | import { WarningResponse } from "./warningResponse"; 5 | export declare class AccountCreateResponse { 6 | "account": AccountResponse; 7 | "oauthData"?: OAuthTokenResponse; 8 | "warnings"?: Array; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): AccountCreateResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/accountGetResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { AccountResponse } from "./accountResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class AccountGetResponse { 5 | "account": AccountResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): AccountGetResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/accountResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { AccountResponseQuotas } from "./accountResponseQuotas"; 3 | import { AccountResponseUsage } from "./accountResponseUsage"; 4 | export declare class AccountResponse { 5 | "accountId"?: string; 6 | "emailAddress"?: string; 7 | "isLocked"?: boolean; 8 | "isPaidHs"?: boolean; 9 | "isPaidHf"?: boolean; 10 | "quotas"?: AccountResponseQuotas; 11 | "callbackUrl"?: string | null; 12 | "roleCode"?: string | null; 13 | "teamId"?: string | null; 14 | "locale"?: string | null; 15 | "usage"?: AccountResponseUsage; 16 | static discriminator: string | undefined; 17 | static attributeTypeMap: AttributeTypeMap; 18 | static getAttributeTypeMap(): AttributeTypeMap; 19 | static init(data: any): AccountResponse; 20 | } 21 | -------------------------------------------------------------------------------- /types/model/accountResponseQuotas.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class AccountResponseQuotas { 3 | "apiSignatureRequestsLeft"?: number | null; 4 | "documentsLeft"?: number | null; 5 | "templatesTotal"?: number | null; 6 | "templatesLeft"?: number | null; 7 | "smsVerificationsLeft"?: number | null; 8 | "numFaxPagesLeft"?: number | null; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): AccountResponseQuotas; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/accountResponseUsage.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class AccountResponseUsage { 3 | "faxPagesSent"?: number | null; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): AccountResponseUsage; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/accountUpdateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class AccountUpdateRequest { 3 | "accountId"?: string | null; 4 | "callbackUrl"?: string; 5 | "locale"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): AccountUpdateRequest; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/accountVerifyRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class AccountVerifyRequest { 3 | "emailAddress": string; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): AccountVerifyRequest; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/accountVerifyResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { AccountVerifyResponseAccount } from "./accountVerifyResponseAccount"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class AccountVerifyResponse { 5 | "account"?: AccountVerifyResponseAccount; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): AccountVerifyResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/accountVerifyResponseAccount.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class AccountVerifyResponseAccount { 3 | "emailAddress"?: string; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): AccountVerifyResponseAccount; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/apiAppCreateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap, RequestFile } from "./"; 2 | import { SubOAuth } from "./subOAuth"; 3 | import { SubOptions } from "./subOptions"; 4 | import { SubWhiteLabelingOptions } from "./subWhiteLabelingOptions"; 5 | export declare class ApiAppCreateRequest { 6 | "domains": Array; 7 | "name": string; 8 | "callbackUrl"?: string; 9 | "customLogoFile"?: RequestFile; 10 | "oauth"?: SubOAuth; 11 | "options"?: SubOptions; 12 | "whiteLabelingOptions"?: SubWhiteLabelingOptions; 13 | static discriminator: string | undefined; 14 | static attributeTypeMap: AttributeTypeMap; 15 | static getAttributeTypeMap(): AttributeTypeMap; 16 | static init(data: any): ApiAppCreateRequest; 17 | } 18 | -------------------------------------------------------------------------------- /types/model/apiAppGetResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { ApiAppResponse } from "./apiAppResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class ApiAppGetResponse { 5 | "apiApp": ApiAppResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): ApiAppGetResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/apiAppListResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { ApiAppResponse } from "./apiAppResponse"; 3 | import { ListInfoResponse } from "./listInfoResponse"; 4 | import { WarningResponse } from "./warningResponse"; 5 | export declare class ApiAppListResponse { 6 | "apiApps": Array; 7 | "listInfo": ListInfoResponse; 8 | "warnings"?: Array; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): ApiAppListResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/apiAppResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { ApiAppResponseOAuth } from "./apiAppResponseOAuth"; 3 | import { ApiAppResponseOptions } from "./apiAppResponseOptions"; 4 | import { ApiAppResponseOwnerAccount } from "./apiAppResponseOwnerAccount"; 5 | import { ApiAppResponseWhiteLabelingOptions } from "./apiAppResponseWhiteLabelingOptions"; 6 | export declare class ApiAppResponse { 7 | "callbackUrl"?: string | null; 8 | "clientId"?: string; 9 | "createdAt"?: number; 10 | "domains"?: Array; 11 | "name"?: string; 12 | "isApproved"?: boolean; 13 | "oauth"?: ApiAppResponseOAuth | null; 14 | "options"?: ApiAppResponseOptions | null; 15 | "ownerAccount"?: ApiAppResponseOwnerAccount; 16 | "whiteLabelingOptions"?: ApiAppResponseWhiteLabelingOptions | null; 17 | static discriminator: string | undefined; 18 | static attributeTypeMap: AttributeTypeMap; 19 | static getAttributeTypeMap(): AttributeTypeMap; 20 | static init(data: any): ApiAppResponse; 21 | } 22 | -------------------------------------------------------------------------------- /types/model/apiAppResponseOAuth.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class ApiAppResponseOAuth { 3 | "callbackUrl"?: string; 4 | "secret"?: string | null; 5 | "scopes"?: Array; 6 | "chargesUsers"?: boolean; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): ApiAppResponseOAuth; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/apiAppResponseOptions.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class ApiAppResponseOptions { 3 | "canInsertEverywhere"?: boolean; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): ApiAppResponseOptions; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/apiAppResponseOwnerAccount.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class ApiAppResponseOwnerAccount { 3 | "accountId"?: string; 4 | "emailAddress"?: string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): ApiAppResponseOwnerAccount; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/apiAppResponseWhiteLabelingOptions.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class ApiAppResponseWhiteLabelingOptions { 3 | "headerBackgroundColor"?: string; 4 | "legalVersion"?: string; 5 | "linkColor"?: string; 6 | "pageBackgroundColor"?: string; 7 | "primaryButtonColor"?: string; 8 | "primaryButtonColorHover"?: string; 9 | "primaryButtonTextColor"?: string; 10 | "primaryButtonTextColorHover"?: string; 11 | "secondaryButtonColor"?: string; 12 | "secondaryButtonColorHover"?: string; 13 | "secondaryButtonTextColor"?: string; 14 | "secondaryButtonTextColorHover"?: string; 15 | "textColor1"?: string; 16 | "textColor2"?: string; 17 | static discriminator: string | undefined; 18 | static attributeTypeMap: AttributeTypeMap; 19 | static getAttributeTypeMap(): AttributeTypeMap; 20 | static init(data: any): ApiAppResponseWhiteLabelingOptions; 21 | } 22 | -------------------------------------------------------------------------------- /types/model/apiAppUpdateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap, RequestFile } from "./"; 2 | import { SubOAuth } from "./subOAuth"; 3 | import { SubOptions } from "./subOptions"; 4 | import { SubWhiteLabelingOptions } from "./subWhiteLabelingOptions"; 5 | export declare class ApiAppUpdateRequest { 6 | "callbackUrl"?: string; 7 | "customLogoFile"?: RequestFile; 8 | "domains"?: Array; 9 | "name"?: string; 10 | "oauth"?: SubOAuth; 11 | "options"?: SubOptions; 12 | "whiteLabelingOptions"?: SubWhiteLabelingOptions; 13 | static discriminator: string | undefined; 14 | static attributeTypeMap: AttributeTypeMap; 15 | static getAttributeTypeMap(): AttributeTypeMap; 16 | static init(data: any): ApiAppUpdateRequest; 17 | } 18 | -------------------------------------------------------------------------------- /types/model/bulkSendJobGetResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { BulkSendJobGetResponseSignatureRequests } from "./bulkSendJobGetResponseSignatureRequests"; 3 | import { BulkSendJobResponse } from "./bulkSendJobResponse"; 4 | import { ListInfoResponse } from "./listInfoResponse"; 5 | import { WarningResponse } from "./warningResponse"; 6 | export declare class BulkSendJobGetResponse { 7 | "bulkSendJob": BulkSendJobResponse; 8 | "listInfo": ListInfoResponse; 9 | "signatureRequests": Array; 10 | "warnings"?: Array; 11 | static discriminator: string | undefined; 12 | static attributeTypeMap: AttributeTypeMap; 13 | static getAttributeTypeMap(): AttributeTypeMap; 14 | static init(data: any): BulkSendJobGetResponse; 15 | } 16 | -------------------------------------------------------------------------------- /types/model/bulkSendJobListResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { BulkSendJobResponse } from "./bulkSendJobResponse"; 3 | import { ListInfoResponse } from "./listInfoResponse"; 4 | import { WarningResponse } from "./warningResponse"; 5 | export declare class BulkSendJobListResponse { 6 | "bulkSendJobs": Array; 7 | "listInfo": ListInfoResponse; 8 | "warnings"?: Array; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): BulkSendJobListResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/bulkSendJobResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class BulkSendJobResponse { 3 | "bulkSendJobId"?: string | null; 4 | "total"?: number; 5 | "isCreator"?: boolean; 6 | "createdAt"?: number; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): BulkSendJobResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/bulkSendJobSendResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { BulkSendJobResponse } from "./bulkSendJobResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class BulkSendJobSendResponse { 5 | "bulkSendJob": BulkSendJobResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): BulkSendJobSendResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/embeddedEditUrlRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubEditorOptions } from "./subEditorOptions"; 3 | import { SubMergeField } from "./subMergeField"; 4 | export declare class EmbeddedEditUrlRequest { 5 | "allowEditCcs"?: boolean; 6 | "ccRoles"?: Array; 7 | "editorOptions"?: SubEditorOptions; 8 | "forceSignerRoles"?: boolean; 9 | "forceSubjectMessage"?: boolean; 10 | "mergeFields"?: Array; 11 | "previewOnly"?: boolean; 12 | "showPreview"?: boolean; 13 | "showProgressStepper"?: boolean; 14 | "testMode"?: boolean; 15 | static discriminator: string | undefined; 16 | static attributeTypeMap: AttributeTypeMap; 17 | static getAttributeTypeMap(): AttributeTypeMap; 18 | static init(data: any): EmbeddedEditUrlRequest; 19 | } 20 | -------------------------------------------------------------------------------- /types/model/embeddedEditUrlResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { EmbeddedEditUrlResponseEmbedded } from "./embeddedEditUrlResponseEmbedded"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class EmbeddedEditUrlResponse { 5 | "embedded": EmbeddedEditUrlResponseEmbedded; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): EmbeddedEditUrlResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/embeddedEditUrlResponseEmbedded.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class EmbeddedEditUrlResponseEmbedded { 3 | "editUrl"?: string; 4 | "expiresAt"?: number; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): EmbeddedEditUrlResponseEmbedded; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/embeddedSignUrlResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { EmbeddedSignUrlResponseEmbedded } from "./embeddedSignUrlResponseEmbedded"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class EmbeddedSignUrlResponse { 5 | "embedded": EmbeddedSignUrlResponseEmbedded; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): EmbeddedSignUrlResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/embeddedSignUrlResponseEmbedded.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class EmbeddedSignUrlResponseEmbedded { 3 | "signUrl"?: string; 4 | "expiresAt"?: number; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): EmbeddedSignUrlResponseEmbedded; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/errorResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { ErrorResponseError } from "./errorResponseError"; 3 | export declare class ErrorResponse { 4 | "error": ErrorResponseError; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): ErrorResponse; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/errorResponseError.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class ErrorResponseError { 3 | "errorMsg": string; 4 | "errorName": string; 5 | "errorPath"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): ErrorResponseError; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/eventCallbackHelper.d.ts: -------------------------------------------------------------------------------- 1 | import { EventCallbackRequest } from "./"; 2 | export declare class EventCallbackHelper { 3 | static readonly EVENT_TYPE_ACCOUNT_CALLBACK = "account_callback"; 4 | static readonly EVENT_TYPE_APP_CALLBACK = "app_callback"; 5 | static isValid: (apiKey: string, eventCallback: EventCallbackRequest) => boolean; 6 | static getCallbackType: (eventCallback: EventCallbackRequest) => string; 7 | } 8 | -------------------------------------------------------------------------------- /types/model/eventCallbackRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { AccountResponse } from "./accountResponse"; 3 | import { EventCallbackRequestEvent } from "./eventCallbackRequestEvent"; 4 | import { SignatureRequestResponse } from "./signatureRequestResponse"; 5 | import { TemplateResponse } from "./templateResponse"; 6 | export declare class EventCallbackRequest { 7 | "event": EventCallbackRequestEvent; 8 | "account"?: AccountResponse; 9 | "signatureRequest"?: SignatureRequestResponse; 10 | "template"?: TemplateResponse; 11 | static discriminator: string | undefined; 12 | static attributeTypeMap: AttributeTypeMap; 13 | static getAttributeTypeMap(): AttributeTypeMap; 14 | static init(data: any): EventCallbackRequest; 15 | } 16 | -------------------------------------------------------------------------------- /types/model/eventCallbackRequestEventMetadata.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class EventCallbackRequestEventMetadata { 3 | "relatedSignatureId"?: string | null; 4 | "reportedForAccountId"?: string | null; 5 | "reportedForAppId"?: string | null; 6 | "eventMessage"?: string | null; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): EventCallbackRequestEventMetadata; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/faxGetResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { FaxResponse } from "./faxResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class FaxGetResponse { 5 | "fax": FaxResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): FaxGetResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/faxLineAddUserRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class FaxLineAddUserRequest { 3 | "number": string; 4 | "accountId"?: string; 5 | "emailAddress"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): FaxLineAddUserRequest; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/faxLineAreaCodeGetCountryEnum.d.ts: -------------------------------------------------------------------------------- 1 | export declare enum FaxLineAreaCodeGetCountryEnum { 2 | Ca = "CA", 3 | Us = "US", 4 | Uk = "UK" 5 | } 6 | -------------------------------------------------------------------------------- /types/model/faxLineAreaCodeGetProvinceEnum.d.ts: -------------------------------------------------------------------------------- 1 | export declare enum FaxLineAreaCodeGetProvinceEnum { 2 | Ab = "AB", 3 | Bc = "BC", 4 | Mb = "MB", 5 | Nb = "NB", 6 | Nl = "NL", 7 | Nt = "NT", 8 | Ns = "NS", 9 | Nu = "NU", 10 | On = "ON", 11 | Pe = "PE", 12 | Qc = "QC", 13 | Sk = "SK", 14 | Yt = "YT" 15 | } 16 | -------------------------------------------------------------------------------- /types/model/faxLineAreaCodeGetResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class FaxLineAreaCodeGetResponse { 3 | "areaCodes": Array; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): FaxLineAreaCodeGetResponse; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/faxLineCreateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class FaxLineCreateRequest { 3 | "areaCode": number; 4 | "country": FaxLineCreateRequest.CountryEnum; 5 | "city"?: string; 6 | "accountId"?: string; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): FaxLineCreateRequest; 11 | } 12 | export declare namespace FaxLineCreateRequest { 13 | enum CountryEnum { 14 | Ca = "CA", 15 | Us = "US", 16 | Uk = "UK" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /types/model/faxLineDeleteRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class FaxLineDeleteRequest { 3 | "number": string; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): FaxLineDeleteRequest; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/faxLineListResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { FaxLineResponseFaxLine } from "./faxLineResponseFaxLine"; 3 | import { ListInfoResponse } from "./listInfoResponse"; 4 | import { WarningResponse } from "./warningResponse"; 5 | export declare class FaxLineListResponse { 6 | "listInfo": ListInfoResponse; 7 | "faxLines": Array; 8 | "warnings"?: WarningResponse; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): FaxLineListResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/faxLineRemoveUserRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class FaxLineRemoveUserRequest { 3 | "number": string; 4 | "accountId"?: string; 5 | "emailAddress"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): FaxLineRemoveUserRequest; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/faxLineResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { FaxLineResponseFaxLine } from "./faxLineResponseFaxLine"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class FaxLineResponse { 5 | "faxLine": FaxLineResponseFaxLine; 6 | "warnings"?: WarningResponse; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): FaxLineResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/faxLineResponseFaxLine.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { AccountResponse } from "./accountResponse"; 3 | export declare class FaxLineResponseFaxLine { 4 | "number"?: string; 5 | "createdAt"?: number; 6 | "updatedAt"?: number; 7 | "accounts"?: Array; 8 | static discriminator: string | undefined; 9 | static attributeTypeMap: AttributeTypeMap; 10 | static getAttributeTypeMap(): AttributeTypeMap; 11 | static init(data: any): FaxLineResponseFaxLine; 12 | } 13 | -------------------------------------------------------------------------------- /types/model/faxListResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { FaxResponse } from "./faxResponse"; 3 | import { ListInfoResponse } from "./listInfoResponse"; 4 | export declare class FaxListResponse { 5 | "faxes": Array; 6 | "listInfo": ListInfoResponse; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): FaxListResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/faxResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { FaxResponseTransmission } from "./faxResponseTransmission"; 3 | export declare class FaxResponse { 4 | "faxId": string; 5 | "title": string; 6 | "originalTitle": string; 7 | "metadata": { 8 | [key: string]: any; 9 | }; 10 | "createdAt": number; 11 | "sender": string; 12 | "filesUrl": string; 13 | "transmissions": Array; 14 | "subject"?: string | null; 15 | "message"?: string | null; 16 | "finalCopyUri"?: string | null; 17 | static discriminator: string | undefined; 18 | static attributeTypeMap: AttributeTypeMap; 19 | static getAttributeTypeMap(): AttributeTypeMap; 20 | static init(data: any): FaxResponse; 21 | } 22 | -------------------------------------------------------------------------------- /types/model/faxResponseTransmission.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class FaxResponseTransmission { 3 | "recipient": string; 4 | "statusCode": FaxResponseTransmission.StatusCodeEnum; 5 | "sentAt"?: number; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): FaxResponseTransmission; 10 | } 11 | export declare namespace FaxResponseTransmission { 12 | enum StatusCodeEnum { 13 | Success = "success", 14 | Transmitting = "transmitting", 15 | ErrorCouldNotFax = "error_could_not_fax", 16 | ErrorUnknown = "error_unknown", 17 | ErrorBusy = "error_busy", 18 | ErrorNoAnswer = "error_no_answer", 19 | ErrorDisconnected = "error_disconnected", 20 | ErrorBadDestination = "error_bad_destination" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /types/model/faxSendRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap, RequestFile } from "./"; 2 | export declare class FaxSendRequest { 3 | "recipient": string; 4 | "sender"?: string; 5 | "files"?: Array; 6 | "fileUrls"?: Array; 7 | "testMode"?: boolean; 8 | "coverPageTo"?: string; 9 | "coverPageFrom"?: string; 10 | "coverPageMessage"?: string; 11 | "title"?: string; 12 | static discriminator: string | undefined; 13 | static attributeTypeMap: AttributeTypeMap; 14 | static getAttributeTypeMap(): AttributeTypeMap; 15 | static init(data: any): FaxSendRequest; 16 | } 17 | -------------------------------------------------------------------------------- /types/model/fileResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class FileResponse { 3 | "fileUrl": string; 4 | "expiresAt": number; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): FileResponse; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/fileResponseDataUri.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class FileResponseDataUri { 3 | "dataUri": string; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): FileResponseDataUri; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/listInfoResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class ListInfoResponse { 3 | "numPages"?: number; 4 | "numResults"?: number | null; 5 | "page"?: number; 6 | "pageSize"?: number; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): ListInfoResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/oAuthTokenGenerateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class OAuthTokenGenerateRequest { 3 | "clientId": string; 4 | "clientSecret": string; 5 | "code": string; 6 | "grantType": string; 7 | "state": string; 8 | static discriminator: string | undefined; 9 | static attributeTypeMap: AttributeTypeMap; 10 | static getAttributeTypeMap(): AttributeTypeMap; 11 | static init(data: any): OAuthTokenGenerateRequest; 12 | } 13 | -------------------------------------------------------------------------------- /types/model/oAuthTokenRefreshRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class OAuthTokenRefreshRequest { 3 | "grantType": string; 4 | "refreshToken": string; 5 | "clientId"?: string; 6 | "clientSecret"?: string; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): OAuthTokenRefreshRequest; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/oAuthTokenResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class OAuthTokenResponse { 3 | "accessToken"?: string; 4 | "tokenType"?: string; 5 | "refreshToken"?: string; 6 | "expiresIn"?: number; 7 | "state"?: string | null; 8 | static discriminator: string | undefined; 9 | static attributeTypeMap: AttributeTypeMap; 10 | static getAttributeTypeMap(): AttributeTypeMap; 11 | static init(data: any): OAuthTokenResponse; 12 | } 13 | -------------------------------------------------------------------------------- /types/model/reportCreateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class ReportCreateRequest { 3 | "endDate": string; 4 | "reportType": Array; 5 | "startDate": string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): ReportCreateRequest; 10 | } 11 | export declare namespace ReportCreateRequest { 12 | enum ReportTypeEnum { 13 | UserActivity = "user_activity", 14 | DocumentStatus = "document_status" 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /types/model/reportCreateResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { ReportResponse } from "./reportResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class ReportCreateResponse { 5 | "report": ReportResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): ReportCreateResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/reportResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class ReportResponse { 3 | "success"?: string; 4 | "startDate"?: string; 5 | "endDate"?: string; 6 | "reportType"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): ReportResponse; 11 | } 12 | export declare namespace ReportResponse { 13 | enum ReportTypeEnum { 14 | UserActivity = "user_activity", 15 | DocumentStatus = "document_status" 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /types/model/signatureRequestGetResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponse } from "./signatureRequestResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class SignatureRequestGetResponse { 5 | "signatureRequest": SignatureRequestResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SignatureRequestGetResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/signatureRequestListResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { ListInfoResponse } from "./listInfoResponse"; 3 | import { SignatureRequestResponse } from "./signatureRequestResponse"; 4 | import { WarningResponse } from "./warningResponse"; 5 | export declare class SignatureRequestListResponse { 6 | "signatureRequests": Array; 7 | "listInfo": ListInfoResponse; 8 | "warnings"?: Array; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): SignatureRequestListResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/signatureRequestRemindRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SignatureRequestRemindRequest { 3 | "emailAddress": string; 4 | "name"?: string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SignatureRequestRemindRequest; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseAttachment.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SignatureRequestResponseAttachment { 3 | "id": string; 4 | "signer": number | string; 5 | "name": string; 6 | "required": boolean; 7 | "instructions"?: string | null; 8 | "uploadedAt"?: number | null; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): SignatureRequestResponseAttachment; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseCustomFieldBase.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare abstract class SignatureRequestResponseCustomFieldBase { 3 | "type": string; 4 | "name": string; 5 | "required"?: boolean; 6 | "apiId"?: string; 7 | "editor"?: string | null; 8 | static discriminator: string | undefined; 9 | static attributeTypeMap: AttributeTypeMap; 10 | static getAttributeTypeMap(): AttributeTypeMap; 11 | static discriminatorClassName(value: any): string | null; 12 | } 13 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseCustomFieldCheckbox.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseCustomFieldBase } from "./signatureRequestResponseCustomFieldBase"; 3 | export declare class SignatureRequestResponseCustomFieldCheckbox extends SignatureRequestResponseCustomFieldBase { 4 | "type": string; 5 | "value"?: boolean; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SignatureRequestResponseCustomFieldCheckbox; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseCustomFieldText.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseCustomFieldBase } from "./signatureRequestResponseCustomFieldBase"; 3 | export declare class SignatureRequestResponseCustomFieldText extends SignatureRequestResponseCustomFieldBase { 4 | "type": string; 5 | "value"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SignatureRequestResponseCustomFieldText; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseCustomFieldTypeEnum.d.ts: -------------------------------------------------------------------------------- 1 | export declare enum SignatureRequestResponseCustomFieldTypeEnum { 2 | Text = "text", 3 | Checkbox = "checkbox" 4 | } 5 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataBase.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare abstract class SignatureRequestResponseDataBase { 3 | "apiId"?: string; 4 | "signatureId"?: string; 5 | "name"?: string; 6 | "required"?: boolean; 7 | "type"?: string; 8 | static discriminator: string | undefined; 9 | static attributeTypeMap: AttributeTypeMap; 10 | static getAttributeTypeMap(): AttributeTypeMap; 11 | static discriminatorClassName(value: any): string | null; 12 | } 13 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataTypeEnum.d.ts: -------------------------------------------------------------------------------- 1 | export declare enum SignatureRequestResponseDataTypeEnum { 2 | Text = "text", 3 | Checkbox = "checkbox", 4 | DateSigned = "date_signed", 5 | Dropdown = "dropdown", 6 | Initials = "initials", 7 | Radio = "radio", 8 | Signature = "signature", 9 | TextMerge = "text-merge", 10 | CheckboxMerge = "checkbox-merge" 11 | } 12 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataValueCheckbox.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; 3 | export declare class SignatureRequestResponseDataValueCheckbox extends SignatureRequestResponseDataBase { 4 | "type"?: string; 5 | "value"?: boolean; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SignatureRequestResponseDataValueCheckbox; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataValueCheckboxMerge.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; 3 | export declare class SignatureRequestResponseDataValueCheckboxMerge extends SignatureRequestResponseDataBase { 4 | "type"?: string; 5 | "value"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SignatureRequestResponseDataValueCheckboxMerge; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataValueDateSigned.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; 3 | export declare class SignatureRequestResponseDataValueDateSigned extends SignatureRequestResponseDataBase { 4 | "type"?: string; 5 | "value"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SignatureRequestResponseDataValueDateSigned; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataValueDropdown.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; 3 | export declare class SignatureRequestResponseDataValueDropdown extends SignatureRequestResponseDataBase { 4 | "type"?: string; 5 | "value"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SignatureRequestResponseDataValueDropdown; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataValueInitials.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; 3 | export declare class SignatureRequestResponseDataValueInitials extends SignatureRequestResponseDataBase { 4 | "type"?: string; 5 | "value"?: string; 6 | "isSigned"?: boolean | null; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SignatureRequestResponseDataValueInitials; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataValueRadio.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; 3 | export declare class SignatureRequestResponseDataValueRadio extends SignatureRequestResponseDataBase { 4 | "type"?: string; 5 | "value"?: boolean; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SignatureRequestResponseDataValueRadio; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataValueSignature.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; 3 | export declare class SignatureRequestResponseDataValueSignature extends SignatureRequestResponseDataBase { 4 | "type"?: string; 5 | "value"?: string; 6 | "isSigned"?: boolean | null; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SignatureRequestResponseDataValueSignature; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataValueText.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; 3 | export declare class SignatureRequestResponseDataValueText extends SignatureRequestResponseDataBase { 4 | "type"?: string; 5 | "value"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SignatureRequestResponseDataValueText; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/signatureRequestResponseDataValueTextMerge.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; 3 | export declare class SignatureRequestResponseDataValueTextMerge extends SignatureRequestResponseDataBase { 4 | "type"?: string; 5 | "value"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SignatureRequestResponseDataValueTextMerge; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/signatureRequestUpdateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SignatureRequestUpdateRequest { 3 | "signatureId": string; 4 | "emailAddress"?: string; 5 | "name"?: string; 6 | "expiresAt"?: number | null; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SignatureRequestUpdateRequest; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/subAttachment.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubAttachment { 3 | "name": string; 4 | "signerIndex": number; 5 | "instructions"?: string; 6 | "required"?: boolean; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SubAttachment; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/subBulkSignerList.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubBulkSignerListCustomField } from "./subBulkSignerListCustomField"; 3 | import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; 4 | export declare class SubBulkSignerList { 5 | "customFields"?: Array; 6 | "signers"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SubBulkSignerList; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/subBulkSignerListCustomField.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubBulkSignerListCustomField { 3 | "name": string; 4 | "value": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubBulkSignerListCustomField; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/subCC.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubCC { 3 | "role": string; 4 | "emailAddress": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubCC; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/subCustomField.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubCustomField { 3 | "name": string; 4 | "editor"?: string; 5 | "required"?: boolean; 6 | "value"?: string; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SubCustomField; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/subEditorOptions.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubEditorOptions { 3 | "allowEditSigners"?: boolean; 4 | "allowEditDocuments"?: boolean; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubEditorOptions; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/subFieldOptions.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubFieldOptions { 3 | "dateFormat": SubFieldOptions.DateFormatEnum; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): SubFieldOptions; 8 | } 9 | export declare namespace SubFieldOptions { 10 | enum DateFormatEnum { 11 | MMDDYYYY = "MM / DD / YYYY", 12 | MM_DD_YYYY = "MM - DD - YYYY", 13 | DDMMYYYY = "DD / MM / YYYY", 14 | DD_MM_YYYY = "DD - MM - YYYY", 15 | YYYYMMDD = "YYYY / MM / DD", 16 | YYYY_MM_DD = "YYYY - MM - DD" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /types/model/subFormFieldGroup.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubFormFieldGroup { 3 | "groupId": string; 4 | "groupLabel": string; 5 | "requirement": string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SubFormFieldGroup; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/subFormFieldRule.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubFormFieldRuleAction } from "./subFormFieldRuleAction"; 3 | import { SubFormFieldRuleTrigger } from "./subFormFieldRuleTrigger"; 4 | export declare class SubFormFieldRule { 5 | "id": string; 6 | "triggerOperator": string; 7 | "triggers": Array; 8 | "actions": Array; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): SubFormFieldRule; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/subFormFieldRuleAction.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubFormFieldRuleAction { 3 | "hidden": boolean; 4 | "type": SubFormFieldRuleAction.TypeEnum; 5 | "fieldId"?: string; 6 | "groupId"?: string; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SubFormFieldRuleAction; 11 | } 12 | export declare namespace SubFormFieldRuleAction { 13 | enum TypeEnum { 14 | ChangeFieldVisibility = "change-field-visibility", 15 | FieldVisibility = "change-field-visibility", 16 | ChangeGroupVisibility = "change-group-visibility", 17 | GroupVisibility = "change-group-visibility" 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /types/model/subFormFieldRuleTrigger.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubFormFieldRuleTrigger { 3 | "id": string; 4 | "operator": SubFormFieldRuleTrigger.OperatorEnum; 5 | "value"?: string; 6 | "values"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SubFormFieldRuleTrigger; 11 | } 12 | export declare namespace SubFormFieldRuleTrigger { 13 | enum OperatorEnum { 14 | Any = "any", 15 | Is = "is", 16 | Match = "match", 17 | None = "none", 18 | Not = "not" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /types/model/subFormFieldsPerDocumentBase.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare abstract class SubFormFieldsPerDocumentBase { 3 | "documentIndex": number; 4 | "apiId": string; 5 | "height": number; 6 | "required": boolean; 7 | "signer": number | string; 8 | "type": string; 9 | "width": number; 10 | "x": number; 11 | "y": number; 12 | "name"?: string; 13 | "page"?: number | null; 14 | static discriminator: string | undefined; 15 | static attributeTypeMap: AttributeTypeMap; 16 | static getAttributeTypeMap(): AttributeTypeMap; 17 | static discriminatorClassName(value: any): string | null; 18 | } 19 | -------------------------------------------------------------------------------- /types/model/subFormFieldsPerDocumentCheckbox.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; 3 | export declare class SubFormFieldsPerDocumentCheckbox extends SubFormFieldsPerDocumentBase { 4 | "type": string; 5 | "isChecked": boolean; 6 | "group"?: string; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SubFormFieldsPerDocumentCheckbox; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/subFormFieldsPerDocumentCheckboxMerge.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; 3 | export declare class SubFormFieldsPerDocumentCheckboxMerge extends SubFormFieldsPerDocumentBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubFormFieldsPerDocumentCheckboxMerge; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/subFormFieldsPerDocumentFontEnum.d.ts: -------------------------------------------------------------------------------- 1 | export declare enum SubFormFieldsPerDocumentFontEnum { 2 | Helvetica = "helvetica", 3 | Arial = "arial", 4 | Courier = "courier", 5 | Calibri = "calibri", 6 | Cambria = "cambria", 7 | Georgia = "georgia", 8 | Times = "times", 9 | Trebuchet = "trebuchet", 10 | Verdana = "verdana", 11 | Roboto = "roboto", 12 | RobotoMono = "robotoMono", 13 | NotoSans = "notoSans", 14 | NotoSerif = "notoSerif", 15 | NotoCjkJpRegular = "notoCJK-JP-Regular", 16 | NotoHebrewRegular = "notoHebrew-Regular", 17 | NotoSanThaiMerged = "notoSanThaiMerged" 18 | } 19 | -------------------------------------------------------------------------------- /types/model/subFormFieldsPerDocumentInitials.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; 3 | export declare class SubFormFieldsPerDocumentInitials extends SubFormFieldsPerDocumentBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubFormFieldsPerDocumentInitials; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/subFormFieldsPerDocumentRadio.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; 3 | export declare class SubFormFieldsPerDocumentRadio extends SubFormFieldsPerDocumentBase { 4 | "type": string; 5 | "group": string; 6 | "isChecked": boolean; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SubFormFieldsPerDocumentRadio; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/subFormFieldsPerDocumentSignature.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; 3 | export declare class SubFormFieldsPerDocumentSignature extends SubFormFieldsPerDocumentBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubFormFieldsPerDocumentSignature; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/subFormFieldsPerDocumentTypeEnum.d.ts: -------------------------------------------------------------------------------- 1 | export declare enum SubFormFieldsPerDocumentTypeEnum { 2 | Checkbox = "checkbox", 3 | CheckboxMerge = "checkbox-merge", 4 | DateSigned = "date_signed", 5 | Dropdown = "dropdown", 6 | Hyperlink = "hyperlink", 7 | Initials = "initials", 8 | Signature = "signature", 9 | Radio = "radio", 10 | Text = "text", 11 | TextMerge = "text-merge" 12 | } 13 | -------------------------------------------------------------------------------- /types/model/subMergeField.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubMergeField { 3 | "name": string; 4 | "type": SubMergeField.TypeEnum; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubMergeField; 9 | } 10 | export declare namespace SubMergeField { 11 | enum TypeEnum { 12 | Text = "text", 13 | Checkbox = "checkbox" 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /types/model/subOAuth.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubOAuth { 3 | "callbackUrl"?: string; 4 | "scopes"?: Array; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubOAuth; 9 | } 10 | export declare namespace SubOAuth { 11 | enum ScopesEnum { 12 | RequestSignature = "request_signature", 13 | BasicAccountInfo = "basic_account_info", 14 | AccountAccess = "account_access", 15 | SignatureRequestAccess = "signature_request_access", 16 | TemplateAccess = "template_access", 17 | TeamAccess = "team_access", 18 | ApiAppAccess = "api_app_access", 19 | Empty = "" 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /types/model/subOptions.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubOptions { 3 | "canInsertEverywhere"?: boolean; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): SubOptions; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/subSignatureRequestGroupedSigners.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; 3 | export declare class SubSignatureRequestGroupedSigners { 4 | "group": string; 5 | "signers": Array; 6 | "order"?: number | null; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): SubSignatureRequestGroupedSigners; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/subSignatureRequestSigner.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubSignatureRequestSigner { 3 | "name": string; 4 | "emailAddress": string; 5 | "order"?: number | null; 6 | "pin"?: string; 7 | "smsPhoneNumber"?: string; 8 | "smsPhoneNumberType"?: SubSignatureRequestSigner.SmsPhoneNumberTypeEnum; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): SubSignatureRequestSigner; 13 | } 14 | export declare namespace SubSignatureRequestSigner { 15 | enum SmsPhoneNumberTypeEnum { 16 | Authentication = "authentication", 17 | Delivery = "delivery" 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /types/model/subSignatureRequestTemplateSigner.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubSignatureRequestTemplateSigner { 3 | "role": string; 4 | "name": string; 5 | "emailAddress": string; 6 | "pin"?: string; 7 | "smsPhoneNumber"?: string; 8 | "smsPhoneNumberType"?: SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): SubSignatureRequestTemplateSigner; 13 | } 14 | export declare namespace SubSignatureRequestTemplateSigner { 15 | enum SmsPhoneNumberTypeEnum { 16 | Authentication = "authentication", 17 | Delivery = "delivery" 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /types/model/subSigningOptions.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubSigningOptions { 3 | "defaultType": SubSigningOptions.DefaultTypeEnum; 4 | "draw"?: boolean; 5 | "phone"?: boolean; 6 | "type"?: boolean; 7 | "upload"?: boolean; 8 | static discriminator: string | undefined; 9 | static attributeTypeMap: AttributeTypeMap; 10 | static getAttributeTypeMap(): AttributeTypeMap; 11 | static init(data: any): SubSigningOptions; 12 | } 13 | export declare namespace SubSigningOptions { 14 | enum DefaultTypeEnum { 15 | Draw = "draw", 16 | Phone = "phone", 17 | Type = "type", 18 | Upload = "upload" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /types/model/subTeamResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubTeamResponse { 3 | "teamId"?: string; 4 | "name"?: string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubTeamResponse; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/subTemplateRole.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubTemplateRole { 3 | "name"?: string; 4 | "order"?: number | null; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): SubTemplateRole; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/subUnclaimedDraftSigner.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubUnclaimedDraftSigner { 3 | "emailAddress": string; 4 | "name": string; 5 | "order"?: number | null; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SubUnclaimedDraftSigner; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/subUnclaimedDraftTemplateSigner.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class SubUnclaimedDraftTemplateSigner { 3 | "role": string; 4 | "name": string; 5 | "emailAddress": string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): SubUnclaimedDraftTemplateSigner; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/teamAddMemberRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TeamAddMemberRequest { 3 | "accountId"?: string; 4 | "emailAddress"?: string; 5 | "role"?: TeamAddMemberRequest.RoleEnum; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TeamAddMemberRequest; 10 | } 11 | export declare namespace TeamAddMemberRequest { 12 | enum RoleEnum { 13 | Member = "Member", 14 | Developer = "Developer", 15 | TeamManager = "Team Manager", 16 | Admin = "Admin" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /types/model/teamCreateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TeamCreateRequest { 3 | "name"?: string; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): TeamCreateRequest; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/teamGetInfoResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TeamInfoResponse } from "./teamInfoResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class TeamGetInfoResponse { 5 | "team": TeamInfoResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): TeamGetInfoResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/teamGetResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TeamResponse } from "./teamResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class TeamGetResponse { 5 | "team": TeamResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): TeamGetResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/teamInfoResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TeamParentResponse } from "./teamParentResponse"; 3 | export declare class TeamInfoResponse { 4 | "teamId"?: string; 5 | "teamParent"?: TeamParentResponse | null; 6 | "name"?: string; 7 | "numMembers"?: number; 8 | "numSubTeams"?: number; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): TeamInfoResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/teamInviteResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TeamInviteResponse { 3 | "emailAddress"?: string; 4 | "teamId"?: string; 5 | "role"?: string; 6 | "sentAt"?: number; 7 | "redeemedAt"?: number; 8 | "expiresAt"?: number; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): TeamInviteResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/teamInvitesResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TeamInviteResponse } from "./teamInviteResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class TeamInvitesResponse { 5 | "teamInvites": Array; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): TeamInvitesResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/teamMemberResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TeamMemberResponse { 3 | "accountId"?: string; 4 | "emailAddress"?: string; 5 | "role"?: string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TeamMemberResponse; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/teamMembersResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { ListInfoResponse } from "./listInfoResponse"; 3 | import { TeamMemberResponse } from "./teamMemberResponse"; 4 | import { WarningResponse } from "./warningResponse"; 5 | export declare class TeamMembersResponse { 6 | "teamMembers": Array; 7 | "listInfo": ListInfoResponse; 8 | "warnings"?: Array; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): TeamMembersResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/teamParentResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TeamParentResponse { 3 | "teamId"?: string; 4 | "name"?: string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TeamParentResponse; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/teamRemoveMemberRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TeamRemoveMemberRequest { 3 | "accountId"?: string; 4 | "emailAddress"?: string; 5 | "newOwnerEmailAddress"?: string; 6 | "newTeamId"?: string; 7 | "newRole"?: TeamRemoveMemberRequest.NewRoleEnum; 8 | static discriminator: string | undefined; 9 | static attributeTypeMap: AttributeTypeMap; 10 | static getAttributeTypeMap(): AttributeTypeMap; 11 | static init(data: any): TeamRemoveMemberRequest; 12 | } 13 | export declare namespace TeamRemoveMemberRequest { 14 | enum NewRoleEnum { 15 | Member = "Member", 16 | Developer = "Developer", 17 | TeamManager = "Team Manager", 18 | Admin = "Admin" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /types/model/teamResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { AccountResponse } from "./accountResponse"; 3 | export declare class TeamResponse { 4 | "name"?: string; 5 | "accounts"?: Array; 6 | "invitedAccounts"?: Array; 7 | "invitedEmails"?: Array; 8 | static discriminator: string | undefined; 9 | static attributeTypeMap: AttributeTypeMap; 10 | static getAttributeTypeMap(): AttributeTypeMap; 11 | static init(data: any): TeamResponse; 12 | } 13 | -------------------------------------------------------------------------------- /types/model/teamSubTeamsResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { ListInfoResponse } from "./listInfoResponse"; 3 | import { SubTeamResponse } from "./subTeamResponse"; 4 | import { WarningResponse } from "./warningResponse"; 5 | export declare class TeamSubTeamsResponse { 6 | "subTeams": Array; 7 | "listInfo": ListInfoResponse; 8 | "warnings"?: Array; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): TeamSubTeamsResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/teamUpdateRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TeamUpdateRequest { 3 | "name"?: string; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): TeamUpdateRequest; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/templateAddUserRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TemplateAddUserRequest { 3 | "accountId"?: string; 4 | "emailAddress"?: string; 5 | "skipNotification"?: boolean; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TemplateAddUserRequest; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/templateCreateEmbeddedDraftResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateCreateEmbeddedDraftResponseTemplate } from "./templateCreateEmbeddedDraftResponseTemplate"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class TemplateCreateEmbeddedDraftResponse { 5 | "template": TemplateCreateEmbeddedDraftResponseTemplate; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): TemplateCreateEmbeddedDraftResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { WarningResponse } from "./warningResponse"; 3 | export declare class TemplateCreateEmbeddedDraftResponseTemplate { 4 | "templateId"?: string; 5 | "editUrl"?: string; 6 | "expiresAt"?: number; 7 | "warnings"?: Array; 8 | static discriminator: string | undefined; 9 | static attributeTypeMap: AttributeTypeMap; 10 | static getAttributeTypeMap(): AttributeTypeMap; 11 | static init(data: any): TemplateCreateEmbeddedDraftResponseTemplate; 12 | } 13 | -------------------------------------------------------------------------------- /types/model/templateCreateResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateCreateResponseTemplate } from "./templateCreateResponseTemplate"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class TemplateCreateResponse { 5 | "template": TemplateCreateResponseTemplate; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): TemplateCreateResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/templateCreateResponseTemplate.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TemplateCreateResponseTemplate { 3 | "templateId"?: string; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): TemplateCreateResponseTemplate; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/templateEditResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TemplateEditResponse { 3 | "templateId": string; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): TemplateEditResponse; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/templateGetResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponse } from "./templateResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class TemplateGetResponse { 5 | "template": TemplateResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): TemplateGetResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/templateListResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { ListInfoResponse } from "./listInfoResponse"; 3 | import { TemplateResponse } from "./templateResponse"; 4 | import { WarningResponse } from "./warningResponse"; 5 | export declare class TemplateListResponse { 6 | "templates": Array; 7 | "listInfo": ListInfoResponse; 8 | "warnings"?: Array; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): TemplateListResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/templateRemoveUserRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TemplateRemoveUserRequest { 3 | "accountId"?: string; 4 | "emailAddress"?: string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateRemoveUserRequest; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseAccount.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseAccountQuota } from "./templateResponseAccountQuota"; 3 | export declare class TemplateResponseAccount { 4 | "accountId"?: string; 5 | "emailAddress"?: string; 6 | "isLocked"?: boolean; 7 | "isPaidHs"?: boolean; 8 | "isPaidHf"?: boolean; 9 | "quotas"?: TemplateResponseAccountQuota; 10 | static discriminator: string | undefined; 11 | static attributeTypeMap: AttributeTypeMap; 12 | static getAttributeTypeMap(): AttributeTypeMap; 13 | static init(data: any): TemplateResponseAccount; 14 | } 15 | -------------------------------------------------------------------------------- /types/model/templateResponseAccountQuota.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TemplateResponseAccountQuota { 3 | "templatesLeft"?: number; 4 | "apiSignatureRequestsLeft"?: number; 5 | "documentsLeft"?: number; 6 | "smsVerificationsLeft"?: number; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): TemplateResponseAccountQuota; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/templateResponseCCRole.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TemplateResponseCCRole { 3 | "name"?: string; 4 | static discriminator: string | undefined; 5 | static attributeTypeMap: AttributeTypeMap; 6 | static getAttributeTypeMap(): AttributeTypeMap; 7 | static init(data: any): TemplateResponseCCRole; 8 | } 9 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentCustomFieldBase.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare abstract class TemplateResponseDocumentCustomFieldBase { 3 | "type": string; 4 | "apiId"?: string; 5 | "name"?: string; 6 | "signer"?: number | string | null; 7 | "x"?: number; 8 | "y"?: number; 9 | "width"?: number; 10 | "height"?: number; 11 | "required"?: boolean; 12 | "group"?: string | null; 13 | static discriminator: string | undefined; 14 | static attributeTypeMap: AttributeTypeMap; 15 | static getAttributeTypeMap(): AttributeTypeMap; 16 | static discriminatorClassName(value: any): string | null; 17 | } 18 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentCustomFieldCheckbox.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocumentCustomFieldBase"; 3 | export declare class TemplateResponseDocumentCustomFieldCheckbox extends TemplateResponseDocumentCustomFieldBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentCustomFieldCheckbox; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentCustomFieldText.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocumentCustomFieldBase"; 3 | import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; 4 | export declare class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCustomFieldBase { 5 | "type": string; 6 | "avgTextLength"?: TemplateResponseFieldAvgTextLength; 7 | "isMultiline"?: boolean; 8 | "originalFontSize"?: number; 9 | "fontFamily"?: string; 10 | static discriminator: string | undefined; 11 | static attributeTypeMap: AttributeTypeMap; 12 | static getAttributeTypeMap(): AttributeTypeMap; 13 | static init(data: any): TemplateResponseDocumentCustomFieldText; 14 | } 15 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFieldGroup.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentFieldGroupRule } from "./templateResponseDocumentFieldGroupRule"; 3 | export declare class TemplateResponseDocumentFieldGroup { 4 | "name"?: string; 5 | "rule"?: TemplateResponseDocumentFieldGroupRule; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TemplateResponseDocumentFieldGroup; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFieldGroupRule.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TemplateResponseDocumentFieldGroupRule { 3 | "requirement"?: string; 4 | "groupLabel"?: string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentFieldGroupRule; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFormFieldBase.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare abstract class TemplateResponseDocumentFormFieldBase { 3 | "type": string; 4 | "apiId"?: string; 5 | "name"?: string; 6 | "signer"?: number | string; 7 | "x"?: number; 8 | "y"?: number; 9 | "width"?: number; 10 | "height"?: number; 11 | "required"?: boolean; 12 | static discriminator: string | undefined; 13 | static attributeTypeMap: AttributeTypeMap; 14 | static getAttributeTypeMap(): AttributeTypeMap; 15 | static discriminatorClassName(value: any): string | null; 16 | } 17 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFormFieldCheckbox.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; 3 | export declare class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocumentFormFieldBase { 4 | "type": string; 5 | "group"?: string | null; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TemplateResponseDocumentFormFieldCheckbox; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFormFieldDateSigned.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; 3 | export declare class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocumentFormFieldBase { 4 | "type": string; 5 | "group"?: string | null; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TemplateResponseDocumentFormFieldDateSigned; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFormFieldDropdown.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; 3 | export declare class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocumentFormFieldBase { 4 | "type": string; 5 | "group"?: string | null; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TemplateResponseDocumentFormFieldDropdown; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFormFieldHyperlink.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; 3 | import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; 4 | export declare class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumentFormFieldBase { 5 | "type": string; 6 | "avgTextLength"?: TemplateResponseFieldAvgTextLength; 7 | "isMultiline"?: boolean; 8 | "originalFontSize"?: number; 9 | "fontFamily"?: string; 10 | "group"?: string | null; 11 | static discriminator: string | undefined; 12 | static attributeTypeMap: AttributeTypeMap; 13 | static getAttributeTypeMap(): AttributeTypeMap; 14 | static init(data: any): TemplateResponseDocumentFormFieldHyperlink; 15 | } 16 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFormFieldInitials.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; 3 | export declare class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocumentFormFieldBase { 4 | "type": string; 5 | "group"?: string | null; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TemplateResponseDocumentFormFieldInitials; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFormFieldRadio.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; 3 | export declare class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFormFieldBase { 4 | "type": string; 5 | "group": string; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TemplateResponseDocumentFormFieldRadio; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentFormFieldSignature.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; 3 | export declare class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumentFormFieldBase { 4 | "type": string; 5 | "group"?: string | null; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TemplateResponseDocumentFormFieldSignature; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentStaticFieldBase.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare abstract class TemplateResponseDocumentStaticFieldBase { 3 | "type": string; 4 | "apiId"?: string; 5 | "name"?: string; 6 | "signer"?: string; 7 | "x"?: number; 8 | "y"?: number; 9 | "width"?: number; 10 | "height"?: number; 11 | "required"?: boolean; 12 | "group"?: string | null; 13 | static discriminator: string | undefined; 14 | static attributeTypeMap: AttributeTypeMap; 15 | static getAttributeTypeMap(): AttributeTypeMap; 16 | static discriminatorClassName(value: any): string | null; 17 | } 18 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentStaticFieldCheckbox.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; 3 | export declare class TemplateResponseDocumentStaticFieldCheckbox extends TemplateResponseDocumentStaticFieldBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentStaticFieldCheckbox; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentStaticFieldDateSigned.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; 3 | export declare class TemplateResponseDocumentStaticFieldDateSigned extends TemplateResponseDocumentStaticFieldBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentStaticFieldDateSigned; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentStaticFieldDropdown.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; 3 | export declare class TemplateResponseDocumentStaticFieldDropdown extends TemplateResponseDocumentStaticFieldBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentStaticFieldDropdown; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentStaticFieldHyperlink.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; 3 | export declare class TemplateResponseDocumentStaticFieldHyperlink extends TemplateResponseDocumentStaticFieldBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentStaticFieldHyperlink; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentStaticFieldInitials.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; 3 | export declare class TemplateResponseDocumentStaticFieldInitials extends TemplateResponseDocumentStaticFieldBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentStaticFieldInitials; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentStaticFieldRadio.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; 3 | export declare class TemplateResponseDocumentStaticFieldRadio extends TemplateResponseDocumentStaticFieldBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentStaticFieldRadio; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentStaticFieldSignature.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; 3 | export declare class TemplateResponseDocumentStaticFieldSignature extends TemplateResponseDocumentStaticFieldBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentStaticFieldSignature; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseDocumentStaticFieldText.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; 3 | export declare class TemplateResponseDocumentStaticFieldText extends TemplateResponseDocumentStaticFieldBase { 4 | "type": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseDocumentStaticFieldText; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseFieldAvgTextLength.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TemplateResponseFieldAvgTextLength { 3 | "numLines"?: number; 4 | "numCharsPerLine"?: number; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseFieldAvgTextLength; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateResponseSignerRole.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class TemplateResponseSignerRole { 3 | "name"?: string; 4 | "order"?: number; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateResponseSignerRole; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateUpdateFilesRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap, RequestFile } from "./"; 2 | export declare class TemplateUpdateFilesRequest { 3 | "clientId"?: string; 4 | "files"?: Array; 5 | "fileUrls"?: Array; 6 | "message"?: string; 7 | "subject"?: string; 8 | "testMode"?: boolean; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): TemplateUpdateFilesRequest; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/templateUpdateFilesResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { TemplateUpdateFilesResponseTemplate } from "./templateUpdateFilesResponseTemplate"; 3 | export declare class TemplateUpdateFilesResponse { 4 | "template": TemplateUpdateFilesResponseTemplate; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): TemplateUpdateFilesResponse; 9 | } 10 | -------------------------------------------------------------------------------- /types/model/templateUpdateFilesResponseTemplate.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { WarningResponse } from "./warningResponse"; 3 | export declare class TemplateUpdateFilesResponseTemplate { 4 | "templateId"?: string; 5 | "warnings"?: Array; 6 | static discriminator: string | undefined; 7 | static attributeTypeMap: AttributeTypeMap; 8 | static getAttributeTypeMap(): AttributeTypeMap; 9 | static init(data: any): TemplateUpdateFilesResponseTemplate; 10 | } 11 | -------------------------------------------------------------------------------- /types/model/unclaimedDraftCreateResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { UnclaimedDraftResponse } from "./unclaimedDraftResponse"; 3 | import { WarningResponse } from "./warningResponse"; 4 | export declare class UnclaimedDraftCreateResponse { 5 | "unclaimedDraft": UnclaimedDraftResponse; 6 | "warnings"?: Array; 7 | static discriminator: string | undefined; 8 | static attributeTypeMap: AttributeTypeMap; 9 | static getAttributeTypeMap(): AttributeTypeMap; 10 | static init(data: any): UnclaimedDraftCreateResponse; 11 | } 12 | -------------------------------------------------------------------------------- /types/model/unclaimedDraftEditAndResendRequest.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | import { SubEditorOptions } from "./subEditorOptions"; 3 | export declare class UnclaimedDraftEditAndResendRequest { 4 | "clientId": string; 5 | "editorOptions"?: SubEditorOptions; 6 | "isForEmbeddedSigning"?: boolean; 7 | "requesterEmailAddress"?: string; 8 | "requestingRedirectUrl"?: string; 9 | "showProgressStepper"?: boolean; 10 | "signingRedirectUrl"?: string; 11 | "testMode"?: boolean; 12 | static discriminator: string | undefined; 13 | static attributeTypeMap: AttributeTypeMap; 14 | static getAttributeTypeMap(): AttributeTypeMap; 15 | static init(data: any): UnclaimedDraftEditAndResendRequest; 16 | } 17 | -------------------------------------------------------------------------------- /types/model/unclaimedDraftResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class UnclaimedDraftResponse { 3 | "signatureRequestId"?: string | null; 4 | "claimUrl"?: string; 5 | "signingRedirectUrl"?: string | null; 6 | "requestingRedirectUrl"?: string | null; 7 | "expiresAt"?: number | null; 8 | "testMode"?: boolean; 9 | static discriminator: string | undefined; 10 | static attributeTypeMap: AttributeTypeMap; 11 | static getAttributeTypeMap(): AttributeTypeMap; 12 | static init(data: any): UnclaimedDraftResponse; 13 | } 14 | -------------------------------------------------------------------------------- /types/model/warningResponse.d.ts: -------------------------------------------------------------------------------- 1 | import { AttributeTypeMap } from "./"; 2 | export declare class WarningResponse { 3 | "warningMsg": string; 4 | "warningName": string; 5 | static discriminator: string | undefined; 6 | static attributeTypeMap: AttributeTypeMap; 7 | static getAttributeTypeMap(): AttributeTypeMap; 8 | static init(data: any): WarningResponse; 9 | } 10 | --------------------------------------------------------------------------------