diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 48c4321fb..5575959d2 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -7697,7 +7697,7 @@ components: type: array items: type: string - maxItems: 2 + maxItems: 10 minItems: 1 name: description: '_t__ApiAppCreate::NAME' @@ -7723,7 +7723,7 @@ components: type: array items: type: string - maxItems: 2 + maxItems: 10 name: description: '_t__ApiAppUpdate::NAME' type: string @@ -7740,6 +7740,10 @@ components: description: '_t__EmbeddedEditUrl::ALLOW_EDIT_CCS' type: boolean default: false + allow_form_view: + description: '_t__EmbeddedEditUrl::ALLOW_FORM_VIEW' + type: boolean + default: false cc_roles: description: '_t__EmbeddedEditUrl::CC_ROLES' type: array @@ -8021,6 +8025,7 @@ components: enum: - user_activity - document_status + - sms_activity maxItems: 2 minItems: 1 start_date: @@ -8177,6 +8182,10 @@ components: description: '_t__SignatureRequestCreateEmbedded::ALLOW_DECLINE' type: boolean default: false + allow_form_view: + description: '_t__SignatureRequestCreateEmbedded::ALLOW_FORM_VIEW' + type: boolean + default: false allow_reassign: description: '_t__SignatureRequestCreateEmbedded::ALLOW_REASSIGN' type: boolean @@ -8356,6 +8365,10 @@ components: description: '_t__SignatureRequestSend::ALLOW_DECLINE' type: boolean default: false + allow_form_view: + description: '_t__SignatureRequestSend::ALLOW_FORM_VIEW' + type: boolean + default: false allow_reassign: description: '_t__SignatureRequestSend::ALLOW_REASSIGN' type: boolean @@ -8468,6 +8481,10 @@ components: description: '_t__SignatureRequestCreateEmbedded::ALLOW_DECLINE' type: boolean default: false + allow_form_view: + description: '_t__SignatureRequestCreateEmbedded::ALLOW_FORM_VIEW' + type: boolean + default: false allow_reassign: description: '_t__SignatureRequestCreateEmbedded::ALLOW_REASSIGN' type: boolean @@ -8738,6 +8755,10 @@ components: description: '_t__SignatureRequestSend::ALLOW_REASSIGN' type: boolean default: false + allow_form_view: + description: '_t__SignatureRequestSend::ALLOW_FORM_VIEW' + type: boolean + default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array @@ -9889,6 +9910,10 @@ components: description: '_t__TemplateCreate::ALLOW_REASSIGN' type: boolean default: false + allow_form_view: + description: '_t__TemplateCreate::ALLOW_FORM_VIEW' + type: boolean + default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array @@ -9977,6 +10002,10 @@ components: description: '_t__TemplateCreateEmbeddedDraft::ALLOW_REASSIGN' type: boolean default: false + allow_form_view: + description: '_t__TemplateCreateEmbeddedDraft::ALLOW_FORM_VIEW' + type: boolean + default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array @@ -10123,6 +10152,10 @@ components: description: '_t__UnclaimedDraftCreate::ALLOW_DECLINE' type: boolean default: false + allow_form_view: + description: '_t__UnclaimedDraftCreate::ALLOW_FORM_VIEW' + type: boolean + default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array @@ -10238,6 +10271,10 @@ components: description: '_t__UnclaimedDraftCreateEmbedded::ALLOW_DECLINE' type: boolean default: false + allow_form_view: + description: '_t__UnclaimedDraftCreateEmbedded::ALLOW_FORM_VIEW' + type: boolean + default: false allow_reassign: description: '_t__UnclaimedDraftCreateEmbedded::ALLOW_REASSIGN' type: boolean @@ -11224,6 +11261,7 @@ components: enum: - user_activity - document_status + - sms_activity type: object x-internal-class: true SignatureRequestResponse: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 72542c9b1..f6c81c0ba 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -111,8 +111,8 @@ paths: $ref: examples/AccountCreateExample.sh x-meta: seo: - title: 'Create Account | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a range of tools. Find out how to create a new Dropbox Sign Account using the specified `email_address` here.' + title: '_t__AccountCreate::SEO::TITLE' + description: '_t__AccountCreate::SEO::DESCRIPTION' /account: get: tags: @@ -220,8 +220,8 @@ paths: $ref: examples/AccountGetExample.sh x-meta: seo: - title: 'Get Account | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return the properties and settings of your Account, click here.' + title: '_t__AccountGet::SEO::TITLE' + description: '_t__AccountGet::SEO::DESCRIPTION' put: tags: - Account @@ -317,8 +317,8 @@ paths: $ref: examples/AccountUpdateExample.sh x-meta: seo: - title: 'Update Account | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how update the properties and settings of your Account, click here.' + title: '_t__AccountUpdate::SEO::TITLE' + description: '_t__AccountUpdate::SEO::DESCRIPTION' /account/verify: post: tags: @@ -415,8 +415,8 @@ paths: $ref: examples/AccountVerifyExample.sh x-meta: seo: - title: 'Verify Account | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to verify whether an Account exists, click here.' + title: '_t__AccountVerify::SEO::TITLE' + description: '_t__AccountVerify::SEO::DESCRIPTION' /api_app: post: tags: @@ -516,8 +516,8 @@ paths: $ref: examples/ApiAppCreateExample.sh x-meta: seo: - title: 'Create API App | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to create a new API App, click here.' + title: '_t__ApiAppCreate::SEO::TITLE' + description: '_t__ApiAppCreate::SEO::DESCRIPTION' '/api_app/{client_id}': get: tags: @@ -616,8 +616,8 @@ paths: $ref: examples/ApiAppGetExample.sh x-meta: seo: - title: 'Get API App | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return an object with information about an API App, click here.' + title: '_t__ApiAppGet::SEO::TITLE' + description: '_t__ApiAppGet::SEO::DESCRIPTION' put: tags: - 'Api App' @@ -727,8 +727,8 @@ paths: $ref: examples/ApiAppUpdateExample.sh x-meta: seo: - title: 'Update API App | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to update an App that you own, click here.' + title: '_t__ApiAppUpdate::SEO::TITLE' + description: '_t__ApiAppUpdate::SEO::DESCRIPTION' delete: tags: - 'Api App' @@ -817,8 +817,8 @@ paths: $ref: examples/ApiAppDeleteExample.sh x-meta: seo: - title: 'Delete API App | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to delete an API App, click here.' + title: '_t__ApiAppDelete::SEO::TITLE' + description: '_t__ApiAppDelete::SEO::DESCRIPTION' /api_app/list: get: tags: @@ -919,8 +919,8 @@ paths: $ref: examples/ApiAppListExample.sh x-meta: seo: - title: 'List API Apps | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return a list of API Apps that are accessible by you, click here.' + title: '_t__ApiAppList::SEO::TITLE' + description: '_t__ApiAppList::SEO::DESCRIPTION' '/bulk_send_job/{bulk_send_job_id}': get: tags: @@ -1030,8 +1030,8 @@ paths: $ref: examples/BulkSendJobGetExample.sh x-meta: seo: - title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of the BulkSendJob and SignatureRequests, click here.' + title: '_t__BulkSendJobGet::SEO::TITLE' + description: '_t__BulkSendJobGet::SEO::DESCRIPTION' /bulk_send_job/list: get: tags: @@ -1133,8 +1133,8 @@ paths: $ref: examples/BulkSendJobListExample.sh x-meta: seo: - title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of BulkSendJob that you can access, click here.' + title: '_t__BulkSendJobList::SEO::TITLE' + description: '_t__BulkSendJobList::SEO::DESCRIPTION' '/embedded/edit_url/{template_id}': post: tags: @@ -1240,8 +1240,8 @@ paths: $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: - title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a template url, click here.' + title: '_t__EmbeddedEditUrl::SEO::TITLE' + description: '_t__EmbeddedEditUrl::SEO::DESCRIPTION' '/embedded/sign_url/{signature_id}': get: tags: @@ -1342,8 +1342,8 @@ paths: $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: - title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.' + title: '_t__EmbeddedSignUrl::SEO::TITLE' + description: '_t__EmbeddedSignUrl::SEO::DESCRIPTION' '/fax/{fax_id}': get: tags: @@ -1439,8 +1439,8 @@ paths: $ref: examples/FaxGetExample.sh x-meta: seo: - title: 'Get Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' + title: '_t__FaxGet::SEO::TITLE' + description: '_t__FaxGet::SEO::DESCRIPTION' delete: tags: - Fax @@ -1528,8 +1528,8 @@ paths: $ref: examples/FaxDeleteExample.sh x-meta: seo: - title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here.' + title: '_t__FaxDelete::SEO::TITLE' + description: '_t__FaxDelete::SEO::DESCRIPTION' '/fax/files/{fax_id}': get: tags: @@ -1625,8 +1625,8 @@ paths: $ref: examples/FaxFilesExample.sh x-meta: seo: - title: 'Fax Files | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' + title: '_t__FaxFiles::SEO::TITLE' + description: '_t__FaxFiles::SEO::DESCRIPTION' /fax_line/add_user: put: tags: @@ -1720,8 +1720,8 @@ paths: $ref: examples/FaxLineAddUserExample.sh x-meta: seo: - title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here.' + title: '_t__FaxLineAddUser::SEO::TITLE' + description: '_t__FaxLineAddUser::SEO::DESCRIPTION' /fax_line/area_codes: get: tags: @@ -1901,8 +1901,8 @@ paths: $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: - title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' + title: '_t__FaxLineAreaCodeGet::SEO::TITLE' + description: '_t__FaxLineAreaCodeGet::SEO::DESCRIPTION' /fax_line/create: post: tags: @@ -1996,8 +1996,8 @@ paths: $ref: examples/FaxLineCreateExample.sh x-meta: seo: - title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + title: '_t__FaxLineCreate::SEO::TITLE' + description: '_t__FaxLineCreate::SEO::DESCRIPTION' /fax_line: get: tags: @@ -2091,8 +2091,8 @@ paths: $ref: examples/FaxLineGetExample.sh x-meta: seo: - title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' + title: '_t__FaxLineGet::SEO::TITLE' + description: '_t__FaxLineGet::SEO::DESCRIPTION' delete: tags: - 'Fax Line' @@ -2180,8 +2180,8 @@ paths: $ref: examples/FaxLineDeleteExample.sh x-meta: seo: - title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.' + title: '_t__FaxLineDelete::SEO::TITLE' + description: '_t__FaxLineDelete::SEO::DESCRIPTION' /fax_line/list: get: tags: @@ -2294,8 +2294,8 @@ paths: $ref: examples/FaxLineListExample.sh x-meta: seo: - title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.' + title: '_t__FaxLineList::SEO::TITLE' + description: '_t__FaxLineList::SEO::DESCRIPTION' /fax_line/remove_user: put: tags: @@ -2389,8 +2389,8 @@ paths: $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: - title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.' + title: '_t__FaxLineRemoveUser::SEO::TITLE' + description: '_t__FaxLineRemoveUser::SEO::DESCRIPTION' /fax/list: get: tags: @@ -2493,8 +2493,8 @@ paths: $ref: examples/FaxListExample.sh x-meta: seo: - title: 'List Faxes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here.' + title: '_t__FaxList::SEO::TITLE' + description: '_t__FaxList::SEO::DESCRIPTION' /fax/send: post: tags: @@ -2593,8 +2593,8 @@ paths: $ref: examples/FaxSendExample.sh x-meta: seo: - title: 'Send Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' + title: '_t__FaxSend::SEO::TITLE' + description: '_t__FaxSend::SEO::DESCRIPTION' /oauth/token: post: tags: @@ -2687,8 +2687,8 @@ paths: $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: - title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to generate a new OAuth token with the API, click here.' + title: '_t__OAuthTokenGenerate::SEO::TITLE' + description: '_t__OAuthTokenGenerate::SEO::DESCRIPTION' x-hideTryItPanel: true '/oauth/token?refresh': post: @@ -2782,8 +2782,8 @@ paths: $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: - title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to refresh your OAuth token with the API, click here.' + title: '_t__OAuthTokenRefresh::SEO::TITLE' + description: '_t__OAuthTokenRefresh::SEO::DESCRIPTION' x-hideTryItPanel: true /report/create: post: @@ -2879,8 +2879,8 @@ paths: $ref: examples/ReportCreateExample.sh x-meta: seo: - title: 'Create Report | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to request the creation of one or more reports, click here.' + title: '_t__ReportCreate::SEO::TITLE' + description: '_t__ReportCreate::SEO::DESCRIPTION' /signature_request/bulk_create_embedded_with_template: post: tags: @@ -2984,8 +2984,8 @@ paths: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create embedded BulkSendJob signature requests, click here.' + title: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::DESCRIPTION' /signature_request/bulk_send_with_template: post: tags: @@ -3089,8 +3089,8 @@ paths: $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: - title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create BulkSendJob for up to 250 signature requests, click here.' + title: '_t__SignatureRequestBulkSendWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestBulkSendWithTemplate::SEO::DESCRIPTION' '/signature_request/cancel/{signature_request_id}': post: tags: @@ -3196,8 +3196,8 @@ paths: $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: - title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to cancel an incomplete signature request, click here.' + title: '_t__SignatureRequestCancel::SEO::TITLE' + description: '_t__SignatureRequestCancel::SEO::DESCRIPTION' /signature_request/create_embedded: post: tags: @@ -3301,8 +3301,8 @@ paths: $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: - title: 'Create Embedded Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new SignatureRequest in an iFrame, click here.' + title: '_t__SignatureRequestCreateEmbedded::SEO::TITLE' + description: '_t__SignatureRequestCreateEmbedded::SEO::DESCRIPTION' /signature_request/create_embedded_with_template: post: tags: @@ -3404,8 +3404,8 @@ paths: $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Signature Request with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.' + title: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::DESCRIPTION' '/signature_request/edit/{signature_request_id}': put: tags: @@ -3524,8 +3524,8 @@ paths: $ref: examples/SignatureRequestEditExample.sh x-meta: seo: - title: 'Edit Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.' + title: '_t__SignatureRequestEdit::SEO::TITLE' + description: '_t__SignatureRequestEdit::SEO::DESCRIPTION' '/signature_request/edit_embedded/{signature_request_id}': put: tags: @@ -3643,8 +3643,8 @@ paths: $ref: examples/SignatureRequestEditEmbeddedExample.sh x-meta: seo: - title: 'Edit Embedded Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.' + title: '_t__SignatureRequestEditEmbedded::SEO::TITLE' + description: '_t__SignatureRequestEditEmbedded::SEO::DESCRIPTION' '/signature_request/edit_embedded_with_template/{signature_request_id}': put: tags: @@ -3760,8 +3760,8 @@ paths: $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Signature Request with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.' + title: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::DESCRIPTION' '/signature_request/edit_with_template/{signature_request_id}': put: tags: @@ -3878,8 +3878,8 @@ paths: $ref: examples/SignatureRequestEditWithTemplateExample.sh x-meta: seo: - title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.' + title: '_t__SignatureRequestEditWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestEditWithTemplate::SEO::DESCRIPTION' '/signature_request/files/{signature_request_id}': get: tags: @@ -3998,8 +3998,8 @@ paths: $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + title: '_t__SignatureRequestFiles::SEO::TITLE' + description: '_t__SignatureRequestFiles::SEO::DESCRIPTION' '/signature_request/files_as_data_uri/{signature_request_id}': get: tags: @@ -4106,8 +4106,8 @@ paths: $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + title: '_t__SignatureRequestFiles::SEO::TITLE' + description: '_t__SignatureRequestFiles::SEO::DESCRIPTION' '/signature_request/files_as_file_url/{signature_request_id}': get: tags: @@ -4221,8 +4221,8 @@ paths: $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + title: '_t__SignatureRequestFiles::SEO::TITLE' + description: '_t__SignatureRequestFiles::SEO::DESCRIPTION' '/signature_request/{signature_request_id}': get: tags: @@ -4322,8 +4322,8 @@ paths: $ref: examples/SignatureRequestGetExample.sh x-meta: seo: - title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' + title: '_t__SignatureRequestGet::SEO::TITLE' + description: '_t__SignatureRequestGet::SEO::DESCRIPTION' /signature_request/list: get: tags: @@ -4443,8 +4443,8 @@ paths: $ref: examples/SignatureRequestListExample.sh x-meta: seo: - title: 'List Signature Requests | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' + title: '_t__SignatureRequestList::SEO::TITLE' + description: '_t__SignatureRequestList::SEO::DESCRIPTION' '/signature_request/release_hold/{signature_request_id}': post: tags: @@ -4541,8 +4541,8 @@ paths: $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: - title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' + title: '_t__SignatureRequestReleaseHold::SEO::TITLE' + description: '_t__SignatureRequestReleaseHold::SEO::DESCRIPTION' '/signature_request/remind/{signature_request_id}': post: tags: @@ -4658,8 +4658,8 @@ paths: $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: - title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' + title: '_t__SignatureRequestRemind::SEO::TITLE' + description: '_t__SignatureRequestRemind::SEO::DESCRIPTION' '/signature_request/remove/{signature_request_id}': post: tags: @@ -4757,8 +4757,8 @@ paths: $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: - title: 'Remove Signature Request Access | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' + title: '_t__SignatureRequestRemove::SEO::TITLE' + description: '_t__SignatureRequestRemove::SEO::DESCRIPTION' /signature_request/send: post: tags: @@ -4863,8 +4863,8 @@ paths: $ref: examples/SignatureRequestSendExample.sh x-meta: seo: - title: 'Send Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' + title: '_t__SignatureRequestSend::SEO::TITLE' + description: '_t__SignatureRequestSend::SEO::DESCRIPTION' /signature_request/send_with_template: post: tags: @@ -4965,8 +4965,8 @@ paths: $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: - title: 'Send with Template | API Documentation | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' + title: '_t__SignatureRequestSendWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestSendWithTemplate::SEO::DESCRIPTION' '/signature_request/update/{signature_request_id}': post: tags: @@ -5077,8 +5077,8 @@ paths: $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: - title: 'Update Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' + title: '_t__SignatureRequestUpdate::SEO::TITLE' + description: '_t__SignatureRequestUpdate::SEO::DESCRIPTION' /team/add_member: put: tags: @@ -5186,8 +5186,8 @@ paths: $ref: examples/TeamAddMemberExample.sh x-meta: seo: - title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' + title: '_t__TeamAddMember::SEO::TITLE' + description: '_t__TeamAddMember::SEO::DESCRIPTION' /team/create: post: tags: @@ -5282,8 +5282,8 @@ paths: $ref: examples/TeamCreateExample.sh x-meta: seo: - title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' + title: '_t__TeamCreate::SEO::TITLE' + description: '_t__TeamCreate::SEO::DESCRIPTION' /team/destroy: delete: tags: @@ -5362,8 +5362,8 @@ paths: $ref: examples/TeamDeleteExample.sh x-meta: seo: - title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' + title: '_t__TeamDelete::SEO::TITLE' + description: '_t__TeamDelete::SEO::DESCRIPTION' /team: get: tags: @@ -5451,8 +5451,8 @@ paths: $ref: examples/TeamGetExample.sh x-meta: seo: - title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + title: '_t__TeamGet::SEO::TITLE' + description: '_t__TeamGet::SEO::DESCRIPTION' put: tags: - Team @@ -5546,8 +5546,8 @@ paths: $ref: examples/TeamUpdateExample.sh x-meta: seo: - title: 'Update Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' + title: '_t__TeamUpdate::SEO::TITLE' + description: '_t__TeamUpdate::SEO::DESCRIPTION' /team/info: get: tags: @@ -5646,8 +5646,8 @@ paths: $ref: examples/TeamInfoExample.sh x-meta: seo: - title: 'Get Team Info | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' + title: '_t__TeamInfo::SEO::TITLE' + description: '_t__TeamInfo::SEO::DESCRIPTION' /team/invites: get: tags: @@ -5742,8 +5742,8 @@ paths: $ref: examples/TeamInvitesExample.sh x-meta: seo: - title: 'List Team Invites | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' + title: '_t__TeamInvites::SEO::TITLE' + description: '_t__TeamInvites::SEO::DESCRIPTION' '/team/members/{team_id}': get: tags: @@ -5858,8 +5858,8 @@ paths: $ref: examples/TeamMembersExample.sh x-meta: seo: - title: 'List Team Members | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' + title: '_t__TeamMembers::SEO::TITLE' + description: '_t__TeamMembers::SEO::DESCRIPTION' /team/remove_member: post: tags: @@ -5958,8 +5958,8 @@ paths: $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: - title: 'Remove User from Team | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' + title: '_t__TeamRemoveMember::SEO::TITLE' + description: '_t__TeamRemoveMember::SEO::DESCRIPTION' '/team/sub_teams/{team_id}': get: tags: @@ -6074,8 +6074,8 @@ paths: $ref: examples/TeamSubTeamsExample.sh x-meta: seo: - title: 'List Sub Teams | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' + title: '_t__TeamSubTeams::SEO::TITLE' + description: '_t__TeamSubTeams::SEO::DESCRIPTION' '/template/add_user/{template_id}': post: tags: @@ -6181,8 +6181,8 @@ paths: $ref: examples/TemplateAddUserExample.sh x-meta: seo: - title: 'Add User to Template | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' + title: '_t__TemplateAddUser::SEO::TITLE' + description: '_t__TemplateAddUser::SEO::DESCRIPTION' /template/create: post: tags: @@ -6290,8 +6290,8 @@ paths: $ref: examples/TemplateCreateExample.sh x-meta: seo: - title: 'Create Template | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' + title: '_t__TemplateCreate::SEO::TITLE' + description: '_t__TemplateCreate::SEO::DESCRIPTION' /template/create_embedded_draft: post: tags: @@ -6399,8 +6399,8 @@ paths: $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: - title: 'Create Embedded Template Draft | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' + title: '_t__TemplateCreateEmbeddedDraft::SEO::TITLE' + description: '_t__TemplateCreateEmbeddedDraft::SEO::DESCRIPTION' '/template/delete/{template_id}': post: tags: @@ -6494,8 +6494,8 @@ paths: $ref: examples/TemplateDeleteExample.sh x-meta: seo: - title: 'Delete Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' + title: '_t__TemplateDelete::SEO::TITLE' + description: '_t__TemplateDelete::SEO::DESCRIPTION' '/template/files/{template_id}': get: tags: @@ -6612,8 +6612,8 @@ paths: $ref: examples/TemplateFilesExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + title: '_t__TemplateFiles::SEO::TITLE' + description: '_t__TemplateFiles::SEO::DESCRIPTION' '/template/files_as_data_uri/{template_id}': get: tags: @@ -6719,8 +6719,8 @@ paths: $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + title: '_t__TemplateFiles::SEO::TITLE' + description: '_t__TemplateFiles::SEO::DESCRIPTION' '/template/files_as_file_url/{template_id}': get: tags: @@ -6833,8 +6833,8 @@ paths: $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + title: '_t__TemplateFiles::SEO::TITLE' + description: '_t__TemplateFiles::SEO::DESCRIPTION' '/template/{template_id}': get: tags: @@ -6933,8 +6933,8 @@ paths: $ref: examples/TemplateGetExample.sh x-meta: seo: - title: 'Get Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' + title: '_t__TemplateGet::SEO::TITLE' + description: '_t__TemplateGet::SEO::DESCRIPTION' /template/list: get: tags: @@ -7056,8 +7056,8 @@ paths: $ref: examples/TemplateListExample.sh x-meta: seo: - title: 'List Templates | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' + title: '_t__TemplateList::SEO::TITLE' + description: '_t__TemplateList::SEO::DESCRIPTION' '/template/remove_user/{template_id}': post: tags: @@ -7163,8 +7163,8 @@ paths: $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: - title: 'Remove User from Template | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' + title: '_t__TemplateRemoveUser::SEO::TITLE' + description: '_t__TemplateRemoveUser::SEO::DESCRIPTION' '/template/update_files/{template_id}': post: tags: @@ -7289,8 +7289,8 @@ paths: $ref: examples/TemplateUpdateFilesExample.sh x-meta: seo: - title: 'Update Template Files | REST API | Dropbox Sign for Developers' - description: 'Overlays a new file with the overlay of an existing template' + title: '_t__TemplateUpdateFiles::SEO::TITLE' + description: '_t__TemplateUpdateFiles::SEO::DESCRIPTION' /unclaimed_draft/create: post: tags: @@ -7394,8 +7394,8 @@ paths: $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: - title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' + title: '_t__UnclaimedDraftCreate::SEO::TITLE' + description: '_t__UnclaimedDraftCreate::SEO::DESCRIPTION' /unclaimed_draft/create_embedded: post: tags: @@ -7507,8 +7507,8 @@ paths: $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh x-meta: seo: - title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' + title: '_t__UnclaimedDraftCreateEmbedded::SEO::TITLE' + description: '_t__UnclaimedDraftCreateEmbedded::SEO::DESCRIPTION' /unclaimed_draft/create_embedded_with_template: post: tags: @@ -7615,8 +7615,8 @@ paths: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' + title: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SEO::TITLE' + description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SEO::DESCRIPTION' '/unclaimed_draft/edit_and_resend/{signature_request_id}': post: tags: @@ -7730,8 +7730,8 @@ paths: $ref: examples/UnclaimedDraftEditAndResendExample.sh x-meta: seo: - title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' + title: '_t__UnclaimedDraftEditAndResend::SEO::TITLE' + description: '_t__UnclaimedDraftEditAndResend::SEO::DESCRIPTION' components: schemas: AccountCreateRequest: @@ -7797,7 +7797,7 @@ components: type: array items: type: string - maxItems: 2 + maxItems: 10 minItems: 1 name: description: 'The name you want to assign to the ApiApp.' @@ -7823,7 +7823,7 @@ components: type: array items: type: string - maxItems: 2 + maxItems: 10 name: description: 'The name you want to assign to the ApiApp.' type: string @@ -7840,6 +7840,10 @@ components: description: 'This allows the requester to enable/disable to add or change CC roles when editing the template.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false cc_roles: description: 'The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.' type: array @@ -8135,6 +8139,7 @@ components: enum: - user_activity - document_status + - sms_activity maxItems: 2 minItems: 1 start_date: @@ -8208,10 +8213,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8297,10 +8299,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8342,18 +8341,12 @@ components: items: type: string signers: - description: |- - Add Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: - description: |- - Add Grouped Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' @@ -8361,6 +8354,10 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8369,7 +8366,7 @@ components: type: boolean default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -8435,10 +8432,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8522,15 +8516,12 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' @@ -8576,18 +8567,12 @@ components: items: type: string signers: - description: |- - Add Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: - description: |- - Add Grouped Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' @@ -8595,6 +8580,10 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8603,7 +8592,7 @@ components: type: boolean default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -8677,10 +8666,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8732,18 +8718,12 @@ components: items: type: string signers: - description: |- - Add Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: - description: |- - Add Grouped Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' @@ -8751,6 +8731,10 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8759,7 +8743,7 @@ components: type: boolean default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -8825,10 +8809,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8912,15 +8893,12 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' @@ -9004,15 +8982,12 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' @@ -9066,18 +9041,12 @@ components: items: type: string signers: - description: |- - Add Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: - description: |- - Add Grouped Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' @@ -9092,8 +9061,12 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -9178,10 +9151,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -9280,15 +9250,12 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' @@ -9859,10 +9826,7 @@ components: description: 'Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.' type: boolean validation_type: - description: |- - Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. - - **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + description: '_t__Sub::FormFieldsPerDocument::VALIDATION_TYPE' type: string enum: - numbers_only @@ -9920,7 +9884,7 @@ components: - type properties: type: - description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.' + description: '_t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE' type: string default: text-merge font_family: @@ -10045,13 +10009,13 @@ components: type: type: string width: - description: 'Size of the field in pixels.' + description: '_t__Sub::FormFieldsPerDocument::WIDTH' type: integer x: - description: 'Location coordinates of the field in pixels.' + description: '_t__Sub::FormFieldsPerDocument::X' type: integer 'y': - description: 'Location coordinates of the field in pixels.' + description: '_t__Sub::FormFieldsPerDocument::Y' type: integer type: object discriminator: @@ -10075,17 +10039,14 @@ components: - signers properties: group: - description: 'The name of the group.' + description: '_t__Sub::SignatureRequestGroupedSigners::GROUP_NAME' type: string order: - description: 'The order the group is required to sign in. Use this instead of Signer-level `order`.' + description: '_t__Sub::SignatureRequestGroupedSigners::ORDER' type: integer nullable: true signers: - description: |- - 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. + description: '_t__Sub::SignatureRequestGroupedSigners::SIGNERS' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' @@ -10096,26 +10057,26 @@ components: - type properties: name: - description: 'The name of the merge field. Must be unique.' + description: '_t__Sub::MergeField::NAME' type: string type: - description: 'The type of merge field.' + description: '_t__Sub::MergeField::TYPE' type: string enum: - text - checkbox x-enumDescriptions: - text: 'Sets merge [field type](/api/reference/constants/#field-types) to `text`.' - checkbox: 'Sets merge [field type](/api/reference/constants/#field-types) to `checkbox`.' + text: '_t__Sub::MergeField::EnumDescriptions::TEXT' + checkbox: '_t__Sub::MergeField::EnumDescriptions::CHECKBOX' type: object SubOAuth: - description: 'OAuth related parameters.' + description: '_t__Sub::OAuth::DESCRIPTION' properties: callback_url: - description: 'The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)' + description: '_t__Sub::OAuth::CALLBACK_URL' type: string scopes: - description: 'A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided).' + description: '_t__Sub::OAuth::SCOPES' type: array items: type: string @@ -10130,10 +10091,10 @@ components: - '' type: object SubOptions: - description: 'Additional options supported by API App.' + description: '_t__Sub::Options::DESCRIPTION' properties: can_insert_everywhere: - description: 'Determines if signers can use "Insert Everywhere" when signing a document.' + description: '_t__Sub::Options::CAN_INSERT_EVERYWHERE' type: boolean default: false type: object @@ -10143,36 +10104,26 @@ components: - email_address properties: name: - description: 'The name of the signer.' + description: '_t__Sub::SignatureRequestSigner::SIGNER_NAME' type: string email_address: - description: 'The email address of the signer.' + description: '_t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS' type: string format: email order: - description: 'The order the signer is required to sign in.' + description: '_t__Sub::SignatureRequestSigner::SIGNER_ORDER' type: integer nullable: true pin: - description: 'The 4- to 12-character access code that will secure this signer''s signature page.' + description: '_t__Sub::SignatureRequestSigner::SIGNER_PIN' type: string maxLength: 12 minLength: 4 sms_phone_number: - description: |- - An E.164 formatted phone number. - - By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - - **NOTE:** Not available in test mode and requires a Standard plan or higher. + description: '_t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER' type: string sms_phone_number_type: - description: |- - Specifies the feature used with the `sms_phone_number`. Default `authentication`. - - If `authentication`, signer is sent a verification code via SMS that is required to access the document. - - If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + description: '_t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE' type: string enum: - authentication @@ -10185,35 +10136,25 @@ components: - email_address properties: role: - description: 'Must match an existing role in chosen Template(s). It''s case-sensitive.' + description: '_t__Sub::SignatureRequestTemplateSigner::ROLE' type: string name: - description: 'The name of the signer.' + description: '_t__Sub::SignatureRequestTemplateSigner::NAME' type: string email_address: - description: 'The email address of the signer.' + description: '_t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS' type: string format: email pin: - description: 'The 4- to 12-character access code that will secure this signer''s signature page.' + description: '_t__Sub::SignatureRequestTemplateSigner::PIN' type: string maxLength: 12 minLength: 4 sms_phone_number: - description: |- - An E.164 formatted phone number. - - By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - - **NOTE:** Not available in test mode and requires a Standard plan or higher. + description: '_t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER' type: string sms_phone_number_type: - description: |- - Specifies the feature used with the `sms_phone_number`. Default `authentication`. - - If `authentication`, signer is sent a verification code via SMS that is required to access the document. - - If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + description: '_t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE' type: string enum: - authentication @@ -10225,14 +10166,14 @@ components: - email_address properties: email_address: - description: 'The email address of the signer.' + description: '_t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS' type: string format: email name: - description: 'The name of the signer.' + description: '_t__Sub::UnclaimedDraftSigner::NAME' type: string order: - description: 'The order the signer is required to sign in.' + description: '_t__Sub::UnclaimedDraftSigner::ORDER' type: integer nullable: true type: object @@ -10243,36 +10184,33 @@ components: - email_address properties: role: - description: 'Must match an existing role in chosen Template(s).' + description: '_t__Sub::UnclaimedDraftTemplateSigner::ROLE' type: string name: - description: 'The name of the signer filling the role of `role`.' + description: '_t__Sub::UnclaimedDraftTemplateSigner::NAME' type: string email_address: - description: 'The email address of the signer filling the role of `role`.' + description: '_t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS' type: string format: email type: object SubTemplateRole: properties: name: - description: 'The role name of the signer that will be displayed when the template is used to create a signature request.' + description: '_t__Sub::SignerRole::NAME' type: string order: - description: 'The order in which this signer role is required to sign.' + description: '_t__Sub::SignerRole::ORDER' type: integer nullable: true type: object SubSigningOptions: - description: |- - This allows the requester to specify the types allowed for creating a signature. - - **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + description: '_t__Sub::SigningOptions::DESCRIPTION' required: - default_type properties: default_type: - description: 'The default type shown (limited to the listed types)' + description: '_t__Sub::SigningOptions::DEFAULT' type: string enum: - draw @@ -10280,27 +10218,24 @@ components: - type - upload draw: - description: 'Allows drawing the signature' + description: '_t__Sub::SigningOptions::DRAW' type: boolean default: false phone: - description: 'Allows using a smartphone to email the signature' + description: '_t__Sub::SigningOptions::PHONE' type: boolean default: false type: - description: 'Allows typing the signature' + description: '_t__Sub::SigningOptions::TYPE' type: boolean default: false upload: - description: 'Allows uploading the signature' + description: '_t__Sub::SigningOptions::UPLOAD' type: boolean default: false type: object SubWhiteLabelingOptions: - description: |- - An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) - - Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. + description: '_t__Sub::WhiteLabelingOptions::DESCRIPTION' properties: header_background_color: type: string @@ -10348,7 +10283,7 @@ components: type: string default: '#ffffff' reset_to_default: - description: 'Resets white labeling options to defaults. Only useful when updating an API App.' + description: '_t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT' type: boolean type: object TeamAddMemberRequest: @@ -10475,8 +10410,12 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -10531,10 +10470,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -10591,8 +10527,12 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -10657,10 +10597,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -10772,8 +10709,12 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -10836,10 +10777,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -10848,7 +10786,7 @@ components: type: boolean default: true signers: - description: 'Add Signers to your Unclaimed Draft Signature Request.' + description: '_t__Sub::UnclaimedDraftSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftSigner' @@ -10918,6 +10856,10 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -10926,7 +10868,7 @@ components: type: boolean default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -11007,10 +10949,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -11033,7 +10972,7 @@ components: type: boolean default: true signers: - description: 'Add Signers to your Unclaimed Draft Signature Request.' + description: '_t__Sub::UnclaimedDraftSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftSigner' @@ -11156,10 +11095,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -11193,7 +11129,7 @@ components: type: boolean default: true signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftTemplateSigner' @@ -11275,7 +11211,7 @@ components: oauth_data: $ref: '#/components/schemas/OAuthTokenResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11288,7 +11224,7 @@ components: account: $ref: '#/components/schemas/AccountResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11299,7 +11235,7 @@ components: account: $ref: '#/components/schemas/AccountVerifyResponseAccount' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11312,7 +11248,7 @@ components: api_app: $ref: '#/components/schemas/ApiAppResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11324,14 +11260,14 @@ components: - list_info properties: api_apps: - description: 'Contains information about API Apps.' + description: '_t__ApiAppListResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/ApiAppResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11348,12 +11284,12 @@ components: list_info: $ref: '#/components/schemas/ListInfoResponse' signature_requests: - description: 'Contains information about the Signature Requests sent in bulk.' + description: '_t__BulkSendJobGetResponse::SIGNATURE_REQUESTS' type: array items: $ref: '#/components/schemas/BulkSendJobGetResponseSignatureRequests' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11365,14 +11301,14 @@ components: - list_info properties: bulk_send_jobs: - description: 'Contains a list of BulkSendJobs that the API caller has access to.' + description: '_t__BulkSendJobListResponse::BULK_SEND_JOBS' type: array items: $ref: '#/components/schemas/BulkSendJobResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11385,7 +11321,7 @@ components: bulk_send_job: $ref: '#/components/schemas/BulkSendJobResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11398,7 +11334,7 @@ components: embedded: $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11411,7 +11347,7 @@ components: embedded: $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11431,7 +11367,7 @@ components: fax: $ref: '#/components/schemas/FaxResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11491,10 +11427,10 @@ components: - expires_at properties: file_url: - description: 'URL to the file.' + description: '_t__FileResponse::FILE_URL' type: string expires_at: - description: 'When the link expires.' + description: '_t__FileResponse::EXPIRES_AT' type: integer type: object x-internal-class: true @@ -11503,7 +11439,7 @@ components: - data_uri properties: data_uri: - description: 'File as base64 encoded string.' + description: '_t__FileResponse::DATA_URI' type: string type: object x-internal-class: true @@ -11514,7 +11450,7 @@ components: report: $ref: '#/components/schemas/ReportResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11527,7 +11463,7 @@ components: signature_request: $ref: '#/components/schemas/SignatureRequestResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11539,14 +11475,14 @@ components: - list_info properties: signature_requests: - description: 'Contains information about signature requests.' + description: '_t__SignatureRequestListResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11555,36 +11491,36 @@ components: AccountResponse: properties: account_id: - description: 'The ID of the Account' + description: '_t__Account::ACCOUNT_ID' type: string email_address: - description: 'The email address associated with the Account.' + description: '_t__Account::EMAIL_ADDRESS' type: string is_locked: - description: 'Returns `true` if the user has been locked out of their account by a team admin.' + description: '_t__Account::IS_LOCKED' type: boolean is_paid_hs: - description: 'Returns `true` if the user has a paid Dropbox Sign account.' + description: '_t__Account::IS_PAID_HS' type: boolean is_paid_hf: - description: 'Returns `true` if the user has a paid HelloFax account.' + description: '_t__Account::IS_PAID_HF' type: boolean quotas: $ref: '#/components/schemas/AccountResponseQuotas' callback_url: - description: 'The URL that Dropbox Sign events will `POST` to.' + description: '_t__Account::CALLBACK_URL' type: string nullable: true role_code: - description: 'The membership role for the team.' + description: '_t__Account::ROLE_CODE' type: string nullable: true team_id: - description: 'The id of the team account belongs to.' + description: '_t__Account::TEAM_ID' type: string nullable: true locale: - description: '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.' + description: '_t__Account::LOCALE' type: string nullable: true usage: @@ -11600,7 +11536,7 @@ components: refresh_token: type: string expires_in: - description: 'Number of seconds until the `access_token` expires. Uses epoch time.' + description: '_t__OAuthTokenResponse::EXPIRES_IN' type: integer state: type: string @@ -11608,39 +11544,39 @@ components: type: object x-internal-class: true AccountResponseQuotas: - description: 'Details concerning remaining monthly quotas.' + description: '_t__Account::QUOTA' properties: api_signature_requests_left: - description: 'API signature requests remaining.' + description: '_t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT' type: integer nullable: true documents_left: - description: 'Signature requests remaining.' + description: '_t__AccountQuota::DOCUMENTS_LEFT' type: integer nullable: true templates_total: - description: 'Total API templates allowed.' + description: '_t__AccountQuota::TEMPLATES_TOTAL' type: integer nullable: true templates_left: - description: 'API templates remaining.' + description: '_t__AccountQuota::TEMPLATES_LEFT' type: integer nullable: true sms_verifications_left: - description: 'SMS verifications remaining.' + description: '_t__AccountQuota::SMS_VERIFICATIONS_LEFT' type: integer nullable: true num_fax_pages_left: - description: 'Number of fax pages left' + description: '_t__AccountQuota::NUM_FAX_PAGES_LEFT' type: integer nullable: true type: object x-internal-class: true AccountResponseUsage: - description: 'Details concerning monthly usage' + description: '_t__Account::USAGE' properties: fax_pages_sent: - description: 'Number of fax pages sent' + description: '_t__AccountUsage::FAX_PAGES_SENT' type: integer nullable: true type: object @@ -11648,33 +11584,33 @@ components: AccountVerifyResponseAccount: properties: email_address: - description: 'The email address associated with the Account.' + description: '_t__Account::EMAIL_ADDRESS' type: string type: object x-internal-class: true ApiAppResponse: - description: 'Contains information about an API App.' + description: '_t__ApiAppResponse::DESCRIPTION' properties: callback_url: - description: 'The app''s callback URL (for events)' + description: '_t__ApiAppResponse::CALLBACK_URL' type: string nullable: true client_id: - description: 'The app''s client id' + description: '_t__ApiAppResponse::CLIENT_ID' type: string created_at: - description: 'The time that the app was created' + description: '_t__ApiAppResponse::CREATED_AT' type: integer domains: - description: 'The domain name(s) associated with the app' + description: '_t__ApiAppResponse::DOMAINS' type: array items: type: string name: - description: 'The name of the app' + description: '_t__ApiAppResponse::NAME' type: string is_approved: - description: 'Boolean to indicate if the app has been approved' + description: '_t__ApiAppResponse::IS_APPROVED' type: boolean oauth: $ref: '#/components/schemas/ApiAppResponseOAuth' @@ -11687,48 +11623,48 @@ components: type: object x-internal-class: true ApiAppResponseOAuth: - description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.' + description: '_t__ApiAppResponseOAuth::DESCRIPTION' properties: callback_url: - description: 'The app''s OAuth callback URL.' + description: '_t__ApiAppResponseOAuth::CALLBACK_URL' type: string secret: - description: 'The app''s OAuth secret, or null if the app does not belong to user.' + description: '_t__ApiAppResponseOAuth::SECRET' type: string nullable: true scopes: - description: 'Array of OAuth scopes used by the app.' + description: '_t__ApiAppResponseOAuth::SCOPES' type: array items: type: string charges_users: - description: 'Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.' + description: '_t__ApiAppResponseOAuth::CHARGES_USERS' type: boolean type: object nullable: true x-internal-class: true ApiAppResponseOptions: - description: 'An object with options that override account settings.' + description: '_t__ApiAppResponseOptions::DESCRIPTION' properties: can_insert_everywhere: - description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' + description: '_t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE' type: boolean type: object nullable: true x-internal-class: true ApiAppResponseOwnerAccount: - description: 'An object describing the app''s owner' + description: '_t__ApiAppResponseOwnerAccount::DESCRIPTION' properties: account_id: - description: 'The owner account''s ID' + description: '_t__ApiAppResponseOwnerAccount::ACCOUNT_ID' type: string email_address: - description: 'The owner account''s email address' + description: '_t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS' type: string type: object x-internal-class: true ApiAppResponseWhiteLabelingOptions: - description: 'An object with options to customize the app''s signer page' + description: '_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION' properties: header_background_color: type: string @@ -11762,20 +11698,20 @@ components: nullable: true x-internal-class: true BulkSendJobResponse: - description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.' + description: '_t__BulkSendJobResponse::DESCRIPTION' properties: bulk_send_job_id: - description: 'The id of the BulkSendJob.' + description: '_t__BulkSendJobResponse::BULK_SEND_JOB_ID' type: string nullable: true total: - description: 'The total amount of Signature Requests queued for sending.' + description: '_t__BulkSendJobResponse::TOTAL' type: integer is_creator: - description: 'True if you are the owner of this BulkSendJob, false if it''s been shared with you by a team member.' + description: '_t__BulkSendJobResponse::IS_CREATOR' type: boolean created_at: - description: 'Time that the BulkSendJob was created.' + description: '_t__BulkSendJobResponse::CREATED_AT' type: integer type: object x-internal-class: true @@ -11788,49 +11724,49 @@ components: - properties: bulk_send_job_id: - description: 'The id of the BulkSendJob.' + description: '_t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID' type: string metadata: - description: 'The metadata attached to the signature request.' + description: '_t__SignatureRequestResponse::METADATA' type: object additionalProperties: {} x-internal-class: true EmbeddedEditUrlResponseEmbedded: - description: 'An embedded template object.' + description: '_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION' properties: edit_url: - description: 'A template url that can be opened in an iFrame.' + description: '_t__EmbeddedEditUrlResponseEmbedded::EDIT_URL' type: string expires_at: - description: 'The specific time that the the `edit_url` link expires, in epoch.' + description: '_t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT' type: integer type: object x-internal-class: true EmbeddedSignUrlResponseEmbedded: - description: 'An object that contains necessary information to set up embedded signing.' + description: '_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION' properties: sign_url: - description: 'A signature url that can be opened in an iFrame.' + description: '_t__EmbeddedSignUrlResponseEmbedded::SIGN_URL' type: string expires_at: - description: 'The specific time that the the `sign_url` link expires, in epoch.' + description: '_t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT' type: integer type: object x-internal-class: true ErrorResponseError: - description: 'Contains information about an error that occurred.' + description: '_t__ErrorResponseError::DESCRIPTION' required: - error_msg - error_name properties: error_msg: - description: 'Message describing an error.' + description: '_t__ErrorResponseError::ERROR_MSG' type: string error_path: - description: 'Path at which an error occurred.' + description: '_t__ErrorResponseError::ERROR_PATH' type: string error_name: - description: 'Name of the error.' + description: '_t__ErrorResponseError::ERROR_NAME' type: string type: object FaxResponse: @@ -11928,156 +11864,153 @@ components: type: object x-internal-class: true ListInfoResponse: - description: 'Contains pagination information about the data returned.' + description: '_t__ListInfoResponse::DESCRIPTION' properties: num_pages: - description: 'Total number of pages available.' + description: '_t__ListInfoResponse::NUM_PAGES' type: integer num_results: - description: 'Total number of objects available.' + description: '_t__ListInfoResponse::NUM_RESULTS' type: integer nullable: true page: - description: 'Number of the page being returned.' + description: '_t__ListInfoResponse::PAGE' type: integer page_size: - description: 'Objects returned per page.' + description: '_t__ListInfoResponse::PAGE_SIZE' type: integer type: object x-internal-class: true ReportResponse: - description: 'Contains information about the report request.' + description: '_t__ReportResponse::DESCRIPTION' properties: success: - description: 'A message indicating the requested operation''s success' + description: '_t__ReportResponse::SUCCESS' type: string start_date: - description: 'The (inclusive) start date for the report data in MM/DD/YYYY format.' + description: '_t__ReportResponse::START_DATE' type: string end_date: - description: 'The (inclusive) end date for the report data in MM/DD/YYYY format.' + description: '_t__ReportResponse::END_DATE' type: string report_type: - description: '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).' + description: '_t__ReportResponse::REPORT_TYPE' type: array items: enum: - user_activity - document_status + - sms_activity type: object x-internal-class: true SignatureRequestResponse: - description: 'Contains information about a signature request.' + description: '_t__SignatureRequestResponse::DESCRIPTION' properties: test_mode: - description: 'Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.' + description: '_t__SignatureRequestResponse::TEST_MODE' type: boolean default: false signature_request_id: - description: 'The id of the SignatureRequest.' + description: '_t__SignatureRequestResponse::SIGNATURE_REQUEST_ID' type: string requester_email_address: - description: 'The email address of the initiator of the SignatureRequest.' + description: '_t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS' type: string nullable: true title: - description: 'The title the specified Account uses for the SignatureRequest.' + description: '_t__SignatureRequestResponse::TITLE' type: string original_title: - description: 'Default Label for account.' + description: '_t__SignatureRequestResponse::ORIGINAL_TITLE' type: string subject: - description: 'The subject in the email that was initially sent to the signers.' + description: '_t__SignatureRequestResponse::SUBJECT' type: string nullable: true message: - description: 'The custom message in the email that was initially sent to the signers.' + description: '_t__SignatureRequestResponse::MESSAGE' type: string nullable: true metadata: - description: 'The metadata attached to the signature request.' + description: '_t__SignatureRequestResponse::METADATA' type: object additionalProperties: {} created_at: - description: 'Time the signature request was created.' + description: '_t__SignatureRequestResponse::CREATED_AT' type: integer expires_at: - description: 'The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + description: '_t__SignatureRequestResponse::EXPIRES_AT' type: integer nullable: true is_complete: - description: 'Whether or not the SignatureRequest has been fully executed by all signers.' + description: '_t__SignatureRequestResponse::IS_COMPLETE' type: boolean is_declined: - description: 'Whether or not the SignatureRequest has been declined by a signer.' + description: '_t__SignatureRequestResponse::IS_DECLINED' type: boolean has_error: - description: 'Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).' + description: '_t__SignatureRequestResponse::HAS_ERROR' type: boolean files_url: - description: 'The URL where a copy of the request''s documents can be downloaded.' + description: '_t__SignatureRequestResponse::FILES_URL' type: string signing_url: - description: 'The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.' + description: '_t__SignatureRequestResponse::SIGNING_URL' type: string nullable: true details_url: - description: 'The URL where the requester and the signers can view the current status of the SignatureRequest.' + description: '_t__SignatureRequestResponse::DETAILS_URL' type: string cc_email_addresses: - description: 'A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.' + description: '_t__SignatureRequestResponse::CC_EMAIL_ADDRESSES' type: array items: type: string signing_redirect_url: - description: 'The URL you want the signer redirected to after they successfully sign.' + description: '_t__SignatureRequestResponse::SIGNING_REDIRECT_URL' type: string nullable: true final_copy_uri: - description: 'The path where the completed document can be downloaded' + description: '_t__SignatureRequestResponse::FINAL_COPY_URI' type: string nullable: true template_ids: - description: 'Templates IDs used in this SignatureRequest (if any).' + description: '_t__SignatureRequestResponse::TEMPLATE_IDS' type: array items: type: string nullable: true custom_fields: - description: |- - An array of Custom Field objects containing the name and type of each custom field. - - * Text Field uses `SignatureRequestResponseCustomFieldText` - * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + description: '_t__SignatureRequestResponseCustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' nullable: true attachments: - description: 'Signer attachments.' + description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseAttachment' nullable: true response_data: - description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.' + description: '_t__SignatureRequestResponseData::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseDataBase' nullable: true signatures: - description: 'An array of signature objects, 1 for each signer.' + description: '_t__SignatureRequestResponseSignatures::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseSignatures' bulk_send_job_id: - description: 'The ID of the Bulk Send job which sent the signature request, if applicable.' + description: '_t__SignatureRequestResponse::BULK_SEND_JOB_ID' type: string nullable: true type: object x-internal-class: true SignatureRequestResponseAttachment: - description: 'Signer attachments.' + description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' required: - id - signer @@ -12085,52 +12018,48 @@ components: - required properties: id: - description: 'The unique ID for this attachment.' + description: '_t__SignatureRequestResponseAttachment::ID' type: string signer: - description: 'The Signer this attachment is assigned to.' + description: '_t__SignatureRequestResponseAttachment::SIGNER' type: string x-int-or-string: true name: - description: 'The name of this attachment.' + description: '_t__SignatureRequestResponseAttachment::NAME' type: string required: - description: 'A boolean value denoting if this attachment is required.' + description: '_t__SignatureRequestResponseAttachment::REQUIRED' type: boolean instructions: - description: 'Instructions for Signer.' + description: '_t__SignatureRequestResponseAttachment::INSTRUCTIONS' type: string nullable: true uploaded_at: - description: 'Timestamp when attachment was uploaded by Signer.' + description: '_t__SignatureRequestResponseAttachment::UPLOADED_AT' type: integer nullable: true type: object x-internal-class: true SignatureRequestResponseCustomFieldBase: - description: |- - An array of Custom Field objects containing the name and type of each custom field. - - * Text Field uses `SignatureRequestResponseCustomFieldText` - * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + description: '_t__SignatureRequestResponseCustomField::DESCRIPTION' required: - name - type properties: type: - description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' + description: '_t__SignatureRequestResponseCustomField::TYPE' type: string name: - description: 'The name of the Custom Field.' + description: '_t__SignatureRequestResponseCustomField::NAME' type: string required: - description: 'A boolean value denoting if this field is required.' + description: '_t__SignatureRequestResponseCustomField::REQUIRED' type: boolean api_id: - description: 'The unique ID for this field.' + description: '_t__SignatureRequestResponseCustomField::API_ID' type: string editor: - description: 'The name of the Role that is able to edit this field.' + description: '_t__SignatureRequestResponseCustomField::EDITOR' type: string nullable: true type: object @@ -12142,7 +12071,7 @@ components: x-internal-class: true x-base-class: true SignatureRequestResponseCustomFieldCheckbox: - description: 'This class extends `SignatureRequestResponseCustomFieldBase`.' + description: '_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12151,15 +12080,15 @@ components: - properties: type: - description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' + description: '_t__SignatureRequestResponseCustomField::TYPE' type: string default: checkbox value: - description: 'A true/false for checkbox fields' + description: '_t__SignatureRequestResponseCustomField::VALUE_CHECKBOX' type: boolean type: object SignatureRequestResponseCustomFieldText: - description: 'This class extends `SignatureRequestResponseCustomFieldBase`.' + description: '_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12168,11 +12097,11 @@ components: - properties: type: - description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' + description: '_t__SignatureRequestResponseCustomField::TYPE' type: string default: text value: - description: 'A text string for text fields' + description: '_t__SignatureRequestResponseCustomField::VALUE_TEXT' type: string type: object SignatureRequestResponseCustomFieldTypeEnum: @@ -12181,19 +12110,19 @@ components: - text - checkbox SignatureRequestResponseDataBase: - description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.' + description: '_t__SignatureRequestResponseData::DESCRIPTION' properties: api_id: - description: 'The unique ID for this field.' + description: '_t__SignatureRequestResponseData::API_ID' type: string signature_id: - description: 'The ID of the signature to which this response is linked.' + description: '_t__SignatureRequestResponseData::SIGNATURE_ID' type: string name: - description: 'The name of the form field.' + description: '_t__SignatureRequestResponseData::NAME' type: string required: - description: 'A boolean value denoting if this field is required.' + description: '_t__SignatureRequestResponseData::REQUIRED' type: boolean type: type: string @@ -12231,11 +12160,11 @@ components: - properties: type: - description: 'A yes/no checkbox' + description: '_t__SignatureRequestResponseDataValue::CHECKBOX_TYPE' type: string default: checkbox value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: boolean type: object SignatureRequestResponseDataValueCheckboxMerge: @@ -12245,11 +12174,11 @@ components: - properties: type: - description: 'A checkbox field that has default value set by the api' + description: '_t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE' type: string default: checkbox-merge value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueDateSigned: @@ -12259,11 +12188,11 @@ components: - properties: type: - description: 'A date' + description: '_t__SignatureRequestResponseDataValue::DATESIGNED_TYPE' type: string default: date_signed value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueDropdown: @@ -12273,11 +12202,11 @@ components: - properties: type: - description: 'An input field for dropdowns' + description: '_t__SignatureRequestResponseDataValue::DROPDOWN_TYPE' type: string default: dropdown value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueInitials: @@ -12287,14 +12216,14 @@ components: - properties: type: - description: 'An input field for initials' + description: '_t__SignatureRequestResponseDataValue::INITIAL_TYPE' type: string default: initials value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string is_signed: - description: 'This field contains the boolean true if the field is signed.' + description: '_t__SignatureRequestResponseDataValue::IS_SIGNED' type: boolean nullable: true type: object @@ -12305,11 +12234,11 @@ components: - properties: type: - description: 'An input field for radios' + description: '_t__SignatureRequestResponseDataValue::RADIO_TYPE' type: string default: radio value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: boolean type: object SignatureRequestResponseDataValueSignature: @@ -12319,14 +12248,14 @@ components: - properties: type: - description: 'A signature input field' + description: '_t__SignatureRequestResponseDataValue::SIGNATURE_TYPE' type: string default: signature value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string is_signed: - description: 'This field contains the boolean true if the field is signed.' + description: '_t__SignatureRequestResponseDataValue::IS_SIGNED' type: boolean nullable: true type: object @@ -12337,11 +12266,11 @@ components: - properties: type: - description: 'A text input field' + description: '_t__SignatureRequestResponseDataValue::TEXT_TYPE' type: string default: text value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueTextMerge: @@ -12351,107 +12280,107 @@ components: - properties: type: - description: 'A text field that has default text set by the api' + description: '_t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE' type: string default: text-merge value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseSignatures: - description: 'An array of signature objects, 1 for each signer.' + description: '_t__SignatureRequestResponseSignatures::DESCRIPTION' properties: signature_id: - description: 'Signature identifier.' + description: '_t__SignatureRequestResponseSignatures::SIGNATURE_ID' type: string signer_group_guid: - description: 'Signer Group GUID' + description: '_t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID' type: string nullable: true signer_email_address: - description: 'The email address of the signer.' + description: '_t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS' type: string signer_name: - description: 'The name of the signer.' + description: '_t__SignatureRequestResponseSignatures::SIGNER_NAME' type: string nullable: true signer_role: - description: 'The role of the signer.' + description: '_t__SignatureRequestResponseSignatures::SIGNER_ROLE' type: string nullable: true order: - description: 'If signer order is assigned this is the 0-based index for this signer.' + description: '_t__SignatureRequestResponseSignatures::ORDER' type: integer nullable: true status_code: - description: 'The current status of the signature. eg: awaiting_signature, signed, declined.' + description: '_t__SignatureRequestResponseSignatures::STATUS_CODE' type: string decline_reason: - description: 'The reason provided by the signer for declining the request.' + description: '_t__SignatureRequestResponseSignatures::DECLINE_REASON' type: string nullable: true signed_at: - description: 'Time that the document was signed or null.' + description: '_t__SignatureRequestResponseSignatures::SIGNED_AT' type: integer nullable: true last_viewed_at: - description: 'The time that the document was last viewed by this signer or null.' + description: '_t__SignatureRequestResponseSignatures::LAST_VIEWED_AT' type: integer nullable: true last_reminded_at: - description: 'The time the last reminder email was sent to the signer or null.' + description: '_t__SignatureRequestResponseSignatures::LAST_REMINDED_AT' type: integer nullable: true has_pin: - description: 'Boolean to indicate whether this signature requires a PIN to access.' + description: '_t__SignatureRequestResponseSignatures::HAS_PIN' type: boolean has_sms_auth: - description: 'Boolean to indicate whether this signature has SMS authentication enabled.' + description: '_t__SignatureRequestResponseSignatures::HAS_SMS_AUTH' type: boolean nullable: true has_sms_delivery: - description: 'Boolean to indicate whether this signature has SMS delivery enabled.' + description: '_t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY' type: boolean nullable: true sms_phone_number: - description: 'The SMS phone number used for authentication or signature request delivery.' + description: '_t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER' type: string nullable: true reassigned_by: - description: 'Email address of original signer who reassigned to this signer.' + description: '_t__SignatureRequestResponseSignatures::REASSIGNED_BY' type: string nullable: true reassignment_reason: - description: 'Reason provided by original signer who reassigned to this signer.' + description: '_t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON' type: string nullable: true reassigned_from: - description: 'Previous signature identifier.' + description: '_t__SignatureRequestResponseSignatures::REASSIGNED_FROM' type: string nullable: true error: - description: 'Error message pertaining to this signer, or null.' + description: '_t__SignatureRequestResponseSignatures::ERROR' type: string nullable: true type: object x-internal-class: true TeamResponse: - description: 'Contains information about your team and its members' + description: '_t__TeamResponse::DESCRIPTION' properties: name: - description: 'The name of your Team' + description: '_t__Team::NAME' type: string accounts: type: array items: $ref: '#/components/schemas/AccountResponse' invited_accounts: - description: '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`.' + description: '_t__Team::INVITED_ACCOUNTS' type: array items: $ref: '#/components/schemas/AccountResponse' invited_emails: - description: 'A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.' + description: '_t__Team::INVITED_EMAILS' type: array items: type: string @@ -12460,18 +12389,18 @@ components: TeamInfoResponse: properties: team_id: - description: 'The id of a team' + description: '_t__TeamGeneral::TEAM_ID' type: string team_parent: $ref: '#/components/schemas/TeamParentResponse' name: - description: 'The name of a team' + description: '_t__TeamGeneral::NAME' type: string num_members: - description: 'Number of members within a team' + description: '_t__TeamGeneral::NUM_MEMBERS' type: integer num_sub_teams: - description: 'Number of sub teams within a team' + description: '_t__TeamGeneral::NUM_SUB_TEAMS' type: integer type: object x-internal-class: true @@ -12514,10 +12443,10 @@ components: description: 'Information about the parent team if a team has one, set to `null` otherwise.' properties: team_id: - description: 'The id of a team' + description: '_t__TeamGeneral::TEAM_ID' type: string name: - description: 'The name of a team' + description: '_t__TeamGeneral::NAME' type: string type: object nullable: true @@ -12525,84 +12454,81 @@ components: SubTeamResponse: properties: team_id: - description: 'The id of a team' + description: '_t__TeamGeneral::TEAM_ID' type: string name: - description: 'The name of a team' + description: '_t__TeamGeneral::NAME' type: string type: object x-internal-class: true TemplateResponse: - description: 'Contains information about the templates you and your team have created.' + description: '_t__TemplateResponse::DESCRIPTION' properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string title: - description: 'The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.' + description: '_t__TemplateResponse::TITLE' type: string message: - description: 'The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.' + description: '_t__TemplateResponse::MESSAGE' type: string updated_at: - description: 'Time the template was last updated.' + description: '_t__TemplateResponse::UPDATED_AT' type: integer is_embedded: - description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.' + description: '_t__TemplateResponse::IS_EMBEDDED' type: boolean nullable: true is_creator: - description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.' + description: '_t__TemplateResponse::IS_CREATOR' type: boolean can_edit: - description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).' + description: '_t__TemplateResponse::CAN_EDIT' type: boolean is_locked: - description: |- - Indicates whether the template is locked. - If `true`, then the template was created outside your quota and can only be used in `test_mode`. - If `false`, then the template is within your quota and can be used to create signature requests. + description: '_t__TemplateResponse::IS_LOCKED' type: boolean metadata: - description: 'The metadata attached to the template.' + description: '_t__TemplateResponse::METADATA' type: object additionalProperties: {} signer_roles: - description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.' + description: '_t__TemplateResponse::SIGNER_ROLES' type: array items: $ref: '#/components/schemas/TemplateResponseSignerRole' cc_roles: - description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' + description: '_t__TemplateResponse::CC_ROLES' type: array items: $ref: '#/components/schemas/TemplateResponseCCRole' documents: - description: 'An array describing each document associated with this Template. Includes form field data for each document.' + description: '_t__TemplateResponse::DOCUMENTS' type: array items: $ref: '#/components/schemas/TemplateResponseDocument' custom_fields: - description: 'Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.' + description: '_t__TemplateResponseCustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' nullable: true deprecated: true named_form_fields: - description: 'Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.' + description: '_t__TemplateResponseNamedFormField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' nullable: true deprecated: true accounts: - description: 'An array of the Accounts that can use this Template.' + description: '_t__TemplateResponse::ACCOUNTS' type: array items: $ref: '#/components/schemas/TemplateResponseAccount' attachments: - description: 'Signer attachments.' + description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseAttachment' @@ -12611,62 +12537,62 @@ components: TemplateResponseAccount: properties: account_id: - description: 'The id of the Account.' + description: '_t__TemplateResponseAccount::ACCOUNT_ID' type: string email_address: - description: 'The email address associated with the Account.' + description: '_t__TemplateResponseAccount::EMAIL_ADDRESS' type: string is_locked: - description: 'Returns `true` if the user has been locked out of their account by a team admin.' + description: '_t__TemplateResponseAccount::IS_LOCKED' type: boolean is_paid_hs: - description: 'Returns `true` if the user has a paid Dropbox Sign account.' + description: '_t__TemplateResponseAccount::IS_PAID_HS' type: boolean is_paid_hf: - description: 'Returns `true` if the user has a paid HelloFax account.' + description: '_t__TemplateResponseAccount::IS_PAID_HF' type: boolean quotas: $ref: '#/components/schemas/TemplateResponseAccountQuota' type: object x-internal-class: true TemplateResponseAccountQuota: - description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' + description: '_t__TemplateResponseAccountQuota::DESCRIPTION' properties: templates_left: - description: 'API templates remaining.' + description: '_t__TemplateResponseAccountQuota::TEMPLATES_LEFT' type: integer api_signature_requests_left: - description: 'API signature requests remaining.' + description: '_t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT' type: integer documents_left: - description: 'Signature requests remaining.' + description: '_t__TemplateResponseAccountQuota::DOCUMENTS_LEFT' type: integer sms_verifications_left: - description: 'SMS verifications remaining.' + description: '_t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT' type: integer type: object x-internal-class: true TemplateResponseCCRole: properties: name: - description: 'The name of the Role.' + description: '_t__TemplateResponseCCRole::NAME' type: string type: object x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: - description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' + description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION' properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string edit_url: - description: 'Link to edit the template.' + description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL' type: string expires_at: - description: 'When the link expires.' + description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT' type: integer warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -12674,78 +12600,78 @@ components: type: object x-internal-class: true TemplateCreateResponseTemplate: - description: 'Template object with parameters: `template_id`.' + description: '_t__TemplateCreateResponseTemplate::DESCRIPTION' properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string type: object x-internal-class: true TemplateResponseDocument: properties: name: - description: 'Name of the associated file.' + description: '_t__TemplateResponseDocument::NAME' type: string index: - description: 'Document ordering, the lowest index is displayed first and the highest last (0-based indexing).' + description: '_t__TemplateResponseDocument::INDEX' type: integer field_groups: - description: 'An array of Form Field Group objects.' + description: '_t__TemplateResponseDocument::FIELD_GROUPS' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFieldGroup' form_fields: - description: 'An array of Form Field objects containing the name and type of each named field.' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' custom_fields: - description: 'An array of Form Field objects containing the name and type of each named field.' + description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' static_fields: - description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' type: object x-internal-class: true TemplateResponseDocumentCustomFieldBase: - description: 'An array of Form Field objects containing the name and type of each named field.' + description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION' required: - type properties: api_id: - description: 'The unique ID for this field.' + description: '_t__TemplateResponseDocumentCustomField::API_ID' type: string name: - description: 'The name of the Custom Field.' + description: '_t__TemplateResponseDocumentCustomField::NAME' type: string type: type: string signer: - description: 'The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).' + description: '_t__TemplateResponseDocumentCustomField::SIGNER' type: string nullable: true x-int-or-string: true x: - description: 'The horizontal offset in pixels for this form field.' + description: '_t__TemplateResponseDocumentCustomField::X' type: integer 'y': - description: 'The vertical offset in pixels for this form field.' + description: '_t__TemplateResponseDocumentCustomField::Y' type: integer width: - description: 'The width in pixels of this form field.' + description: '_t__TemplateResponseDocumentCustomField::WIDTH' type: integer height: - description: 'The height in pixels of this form field.' + description: '_t__TemplateResponseDocumentCustomField::HEIGHT' type: integer required: - description: 'Boolean showing whether or not this field is required.' + description: '_t__TemplateResponseDocumentStaticField::REQUIRED' type: boolean group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.' + description: '_t__TemplateResponseDocumentCustomField::GROUP' type: string nullable: true type: object @@ -12757,7 +12683,7 @@ components: x-internal-class: true x-base-class: true TemplateResponseDocumentCustomFieldCheckbox: - description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' + description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12766,16 +12692,12 @@ components: - properties: type: - description: |- - The type of this Custom Field. Only `text` and `checkbox` are currently supported. - - * Text uses `TemplateResponseDocumentCustomFieldText` - * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + description: '_t__TemplateResponseDocumentCustomField::TYPE' type: string default: checkbox type: object TemplateResponseDocumentCustomFieldText: - description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' + description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12784,81 +12706,72 @@ components: - properties: type: - description: |- - The type of this Custom Field. Only `text` and `checkbox` are currently supported. - - * Text uses `TemplateResponseDocumentCustomFieldText` - * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + description: '_t__TemplateResponseDocumentCustomField::TYPE' type: string default: text avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: - description: 'Whether this form field is multiline text.' + description: '_t__TemplateResponseDocumentCustomField::IS_MULTILINE' type: boolean originalFontSize: - description: 'Original font size used in this form field''s text.' + description: '_t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE' type: integer fontFamily: - description: 'Font family used in this form field''s text.' + description: '_t__TemplateResponseDocumentCustomField::FONT_FAMILY' type: string type: object TemplateResponseDocumentFieldGroup: properties: name: - description: 'The name of the form field group.' + description: '_t__TemplateResponseDocumentFieldGroup::NAME' type: string rule: $ref: '#/components/schemas/TemplateResponseDocumentFieldGroupRule' type: object x-internal-class: true TemplateResponseDocumentFieldGroupRule: - description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' + description: '_t__TemplateResponseDocumentFieldGroup::RULE' properties: requirement: - description: |- - 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. + description: '_t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT' type: string groupLabel: - description: 'Name of the group' + description: '_t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL' type: string type: object x-internal-class: true TemplateResponseDocumentFormFieldBase: - description: 'An array of Form Field objects containing the name and type of each named field.' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION' required: - type properties: api_id: - description: 'A unique id for the form field.' + description: '_t__TemplateResponseDocumentFormField::API_ID' type: string name: - description: 'The name of the form field.' + description: '_t__TemplateResponseDocumentFormField::NAME' type: string type: type: string signer: - description: 'The signer of the Form Field.' + description: '_t__TemplateResponseDocumentFormField::SIGNER' type: string x-int-or-string: true x: - description: 'The horizontal offset in pixels for this form field.' + description: '_t__TemplateResponseDocumentFormField::X' type: integer 'y': - description: 'The vertical offset in pixels for this form field.' + description: '_t__TemplateResponseDocumentFormField::Y' type: integer width: - description: 'The width in pixels of this form field.' + description: '_t__TemplateResponseDocumentFormField::WIDTH' type: integer height: - description: 'The height in pixels of this form field.' + description: '_t__TemplateResponseDocumentFormField::HEIGHT' type: integer required: - description: 'Boolean showing whether or not this field is required.' + description: '_t__TemplateResponseDocumentFormField::REQUIRED' type: boolean type: object discriminator: @@ -12875,7 +12788,7 @@ components: x-internal-class: true x-base-class: true TemplateResponseDocumentFormFieldCheckbox: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12884,26 +12797,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: checkbox group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldDateSigned: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12912,26 +12815,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: date_signed group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldDropdown: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12940,26 +12833,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: dropdown group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldHyperlink: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12968,37 +12851,27 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: hyperlink avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: - description: 'Whether this form field is multiline text.' + description: '_t__TemplateResponseDocumentFormField::IS_MULTILINE' type: boolean originalFontSize: - description: 'Original font size used in this form field''s text.' + description: '_t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE' type: integer fontFamily: - description: 'Font family used in this form field''s text.' + description: '_t__TemplateResponseDocumentFormField::FONT_FAMILY' type: string group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldInitials: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13007,26 +12880,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: initials group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldRadio: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type - group @@ -13036,25 +12899,15 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: radio group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string type: object TemplateResponseDocumentFormFieldSignature: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13063,26 +12916,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: signature group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldText: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13091,32 +12934,22 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: text avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: - description: 'Whether this form field is multiline text.' + description: '_t__TemplateResponseDocumentFormField::IS_MULTILINE' type: boolean originalFontSize: - description: 'Original font size used in this form field''s text.' + description: '_t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE' type: integer fontFamily: - description: 'Font family used in this form field''s text.' + description: '_t__TemplateResponseDocumentFormField::FONT_FAMILY' type: string validation_type: - description: 'Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.' + description: '_t__TemplateResponseDocumentFormField::VALIDATION_TYPE' type: string enum: - numbers_only @@ -13131,52 +12964,52 @@ components: - custom_regex nullable: true validation_custom_regex: - description: 'When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.' + description: '_t__TemplateResponseDocumentFormField::CUSTOM_REGEX' type: string nullable: true validation_custom_regex_format_label: - description: 'When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.' + description: '_t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL' type: string nullable: true group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentStaticFieldBase: - description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION' required: - type properties: api_id: - description: 'A unique id for the static field.' + description: '_t__TemplateResponseDocumentStaticField::API_ID' type: string name: - description: 'The name of the static field.' + description: '_t__TemplateResponseDocumentStaticField::NAME' type: string type: type: string signer: - description: 'The signer of the Static Field.' + description: '_t__TemplateResponseDocumentStaticField::SIGNER' type: string default: me_now x: - description: 'The horizontal offset in pixels for this static field.' + description: '_t__TemplateResponseDocumentStaticField::X' type: integer 'y': - description: 'The vertical offset in pixels for this static field.' + description: '_t__TemplateResponseDocumentStaticField::Y' type: integer width: - description: 'The width in pixels of this static field.' + description: '_t__TemplateResponseDocumentStaticField::WIDTH' type: integer height: - description: 'The height in pixels of this static field.' + description: '_t__TemplateResponseDocumentStaticField::HEIGHT' type: integer required: - description: 'Boolean showing whether or not this field is required.' + description: '_t__TemplateResponseDocumentStaticField::REQUIRED' type: boolean group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.' + description: '_t__TemplateResponseDocumentStaticField::GROUP' type: string nullable: true type: object @@ -13194,7 +13027,7 @@ components: x-internal-class: true x-base-class: true TemplateResponseDocumentStaticFieldCheckbox: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13203,22 +13036,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: checkbox type: object TemplateResponseDocumentStaticFieldDateSigned: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13227,22 +13050,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: date_signed type: object TemplateResponseDocumentStaticFieldDropdown: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13251,22 +13064,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: dropdown type: object TemplateResponseDocumentStaticFieldHyperlink: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13275,22 +13078,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: hyperlink type: object TemplateResponseDocumentStaticFieldInitials: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13299,22 +13092,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: initials type: object TemplateResponseDocumentStaticFieldRadio: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13323,22 +13106,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: radio type: object TemplateResponseDocumentStaticFieldSignature: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13347,22 +13120,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: signature type: object TemplateResponseDocumentStaticFieldText: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13371,49 +13134,39 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: text type: object TemplateResponseFieldAvgTextLength: - description: 'Average text length in this field.' + description: '_t__TemplateResponseFieldAvgTextLength::DESCRIPTION' properties: num_lines: - description: 'Number of lines.' + description: '_t__TemplateResponseFieldAvgTextLength::NUM_LINES' type: integer num_chars_per_line: - description: 'Number of characters per line.' + description: '_t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE' type: integer type: object x-internal-class: true TemplateResponseSignerRole: properties: name: - description: 'The name of the Role.' + description: '_t__TemplateResponseSignerRole::NAME' type: string order: - description: 'If signer order is assigned this is the 0-based index for this role.' + description: '_t__TemplateResponseSignerRole::ORDER' type: integer type: object x-internal-class: true TemplateUpdateFilesResponseTemplate: - description: 'Contains template id' + description: '_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION' properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13421,43 +13174,43 @@ components: type: object x-internal-class: true UnclaimedDraftResponse: - description: 'A group of documents that a user can take ownership of via the claim URL.' + description: '_t__UnclaimedDraftResponse::DESCRIPTION' properties: signature_request_id: - description: 'The ID of the signature request that is represented by this UnclaimedDraft.' + description: '_t__UnclaimedDraft::SIGNATURE_REQUEST_ID' type: string nullable: true claim_url: - description: 'The URL to be used to claim this UnclaimedDraft.' + description: '_t__UnclaimedDraft::CLAIM_URL' type: string signing_redirect_url: - description: 'The URL you want signers redirected to after they successfully sign.' + description: '_t__UnclaimedDraft::SIGNING_REDIRECT_URL' type: string nullable: true requesting_redirect_url: - description: 'The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).' + description: '_t__UnclaimedDraft::REQUESTING_REDIRECT_URL' type: string nullable: true expires_at: - description: 'When the link expires.' + description: '_t__UnclaimedDraft::EXPIRES_AT' type: integer nullable: true test_mode: - description: 'Whether this is a test draft. Signature requests made from test drafts have no legal value.' + description: '_t__UnclaimedDraft::TEST_MODE' type: boolean type: object x-internal-class: true WarningResponse: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' required: - warning_msg - warning_name properties: warning_msg: - description: 'Warning message' + description: '_t__WarningResponse::WARNING_MSG' type: string warning_name: - description: 'Warning name' + description: '_t__WarningResponse::WARNING_NAME' type: string type: object TeamGetResponse: @@ -13467,7 +13220,7 @@ components: team: $ref: '#/components/schemas/TeamResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13480,7 +13233,7 @@ components: team: $ref: '#/components/schemas/TeamInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13544,7 +13297,7 @@ components: template: $ref: '#/components/schemas/TemplateCreateResponseTemplate' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13557,7 +13310,7 @@ components: template: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13568,7 +13321,7 @@ components: - template_id properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string type: object TemplateGetResponse: @@ -13578,7 +13331,7 @@ components: template: $ref: '#/components/schemas/TemplateResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13590,14 +13343,14 @@ components: - list_info properties: templates: - description: 'List of templates that the API caller has access to.' + description: '_t__TemplateListResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13618,7 +13371,7 @@ components: unclaimed_draft: $ref: '#/components/schemas/UnclaimedDraftResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13639,17 +13392,17 @@ components: $ref: '#/components/schemas/TemplateResponse' type: object EventCallbackRequestEvent: - description: 'Basic information about the event that occurred.' + description: '_t__EventCallbackRequestEvent::DESCRIPTION' required: - event_time - event_type - event_hash properties: event_time: - description: 'Time the event was created (using Unix time).' + description: '_t__EventCallbackRequestEvent::EVENT_TIME' type: string event_type: - description: 'Type of callback event that was triggered.' + description: '_t__EventCallbackRequestEvent::EVENT_TYPE' type: string enum: - account_confirmed @@ -13676,28 +13429,28 @@ components: - callback_test - signature_request_signer_removed event_hash: - description: 'Generated hash used to verify source of event data.' + description: '_t__EventCallbackRequestEvent::EVENT_HASH' type: string event_metadata: $ref: '#/components/schemas/EventCallbackRequestEventMetadata' type: object EventCallbackRequestEventMetadata: - description: 'Specific metadata about the event.' + description: '_t__EventCallbackRequestEventMetadata::DESCRIPTION' properties: related_signature_id: - description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.' + description: '_t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID' type: string nullable: true reported_for_account_id: - description: 'Account ID the event was reported for.' + description: '_t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID' type: string nullable: true reported_for_app_id: - description: 'App ID the event was reported for.' + description: '_t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID' type: string nullable: true event_message: - description: 'Message about a declined or failed (due to error) signature flow.' + description: '_t__EventCallbackRequestEventMetadata::EVENT_MESSAGE' type: string nullable: true type: object @@ -13943,87 +13696,87 @@ components: value: $ref: examples/json/UnclaimedDraftEditAndResendRequest.json AccountCreateResponse: - summary: 'Account Create' + summary: '_t__AccountCreateResponseExample::SUMMARY' value: $ref: examples/json/AccountCreateResponse.json AccountCreateOAuthResponse: - summary: 'Account Create with OAuth Authorization' + summary: '_t__AccountCreateOAuthResponseExample::SUMMARY' value: $ref: examples/json/AccountCreateOAuthResponse.json AccountGetResponse: - summary: 'Account Get' + summary: '_t__AccountGetResponseExample::SUMMARY' value: $ref: examples/json/AccountGetResponse.json AccountVerifyFoundResponse: - summary: 'Account Found' + summary: '_t__AccountVerifyFoundResponseExample::SUMMARY' value: $ref: examples/json/AccountVerifyFoundResponse.json AccountVerifyNotFoundResponse: - summary: 'Account Not Found' + summary: '_t__AccountVerifyNotFoundResponseExample::SUMMARY' value: $ref: examples/json/AccountVerifyNotFoundResponse.json ApiAppGetResponse: - summary: 'API App' + summary: '_t__ApiAppGetResponseExample::SUMMARY' value: $ref: examples/json/ApiAppGetResponse.json ApiAppListResponse: - summary: 'API App List' + summary: '_t__ApiAppListResponseExample::SUMMARY' value: $ref: examples/json/ApiAppListResponse.json BulkSendJobGetResponse: - summary: 'Bulk Send Job' + summary: '_t__BulkSendJobGetResponseExample::SUMMARY' value: $ref: examples/json/BulkSendJobGetResponse.json BulkSendJobListResponse: - summary: 'Bulk Send Job List' + summary: '_t__BulkSendJobListResponseExample::SUMMARY' value: $ref: examples/json/BulkSendJobListResponse.json EmbeddedEditUrlResponse: - summary: 'Embedded Edit URL' + summary: '_t__EmbeddedEditUrlResponseExample::SUMMARY' value: $ref: examples/json/EmbeddedEditUrlResponse.json EmbeddedSignUrlResponse: - summary: 'Embedded Sign URL' + summary: '_t__EmbeddedSignUrlResponseExample::SUMMARY' value: $ref: examples/json/EmbeddedSignUrlResponse.json Error400Response: - summary: 'Error 400 bad_request' + summary: '_t__Error::400' value: $ref: examples/json/Error400Response.json Error401Response: - summary: 'Error 401 unauthorized' + summary: '_t__Error::401' value: $ref: examples/json/Error401Response.json Error402Response: - summary: 'Error 402 payment_required' + summary: '_t__Error::402' value: $ref: examples/json/Error402Response.json Error403Response: - summary: 'Error 403 forbidden' + summary: '_t__Error::403' value: $ref: examples/json/Error403Response.json Error404Response: - summary: 'Error 404 not_found' + summary: '_t__Error::404' value: $ref: examples/json/Error404Response.json Error409Response: - summary: 'Error 409 conflict' + summary: '_t__Error::409' value: $ref: examples/json/Error409Response.json Error410Response: - summary: 'Error 410 deleted' + summary: '_t__Error::410' value: $ref: examples/json/Error410Response.json Error422Response: - summary: 'Error 422 unprocessable_entity' + summary: '_t__Error::422' value: $ref: examples/json/Error422Response.json Error429Response: - summary: 'Error 429 exceeded_rate' + summary: '_t__Error::429' value: $ref: examples/json/Error429Response.json Error4XXResponse: - summary: 'Error 4XX failed_operation' + summary: '_t__Error::4XX' value: $ref: examples/json/Error4XXResponse.json FaxGetResponse: @@ -14047,190 +13800,188 @@ components: value: $ref: examples/json/FaxListResponse.json ReportCreateResponse: - summary: Report + summary: '_t__ReportCreateResponseExample::SUMMARY' value: $ref: examples/json/ReportCreateResponse.json SignatureRequestGetResponse: - summary: 'Get Signature Request' + summary: '_t__SignatureRequestGetResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestGetResponse.json SignatureRequestListResponse: - summary: 'List Signature Requests' + summary: '_t__SignatureRequestListResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestListResponse.json AccountUpdateResponse: - summary: 'Account Update' + summary: '_t__AccountUpdateResponseExample::SUMMARY' value: $ref: examples/json/AccountUpdateResponse.json OAuthTokenGenerateResponse: - summary: 'Retrieving the OAuth token' + summary: '_t__OAuthTokenGenerateResponseExample::SUMMARY' value: $ref: examples/json/OAuthTokenGenerateResponse.json OAuthTokenRefreshResponse: - summary: 'Refresh an existing OAuth token' + summary: '_t__OAuthTokenRefreshResponseExample::SUMMARY' value: $ref: examples/json/OAuthTokenRefreshResponse.json ApiAppCreateResponse: - summary: 'API App' + summary: '_t__ApiAppCreateResponseExample::SUMMARY' value: $ref: examples/json/ApiAppCreateResponse.json ApiAppUpdateResponse: - summary: 'API App Update' + summary: '_t__ApiAppUpdateResponseExample::SUMMARY' value: $ref: examples/json/ApiAppUpdateResponse.json SignatureRequestCreateEmbeddedResponse: - summary: 'Create Embedded Signature Request' + summary: '_t__SignatureRequestCreateEmbeddedResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json SignatureRequestCreateEmbeddedWithTemplateResponse: - summary: 'Create Embedded Signature Request With Template' + summary: '_t__SignatureRequestCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json SignatureRequestFilesResponse: - summary: 'Signature Requests Files' + summary: '_t__SignatureRequestFilesResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestFilesResponse.json SignatureRequestReleaseHoldResponse: - summary: 'Send Signature Release Hold' + summary: '_t__SignatureRequestReleaseHoldResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestReleaseHoldResponse.json SignatureRequestRemindResponse: - summary: 'Send Signature Request Reminder' + summary: '_t__SignatureRequestRemindResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestRemindResponse.json SignatureRequestSendResponse: - summary: 'Send Signature Request' + summary: '_t__SignatureRequestSendResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestSendResponse.json SignatureRequestSendWithTemplateResponse: - summary: 'Send Signature Request With Template' + summary: '_t__SignatureRequestSendWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestSendWithTemplateResponse.json SignatureRequestUpdateResponse: - summary: 'Signature Request Update' + summary: '_t__SignatureRequestUpdateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestUpdateResponse.json SignatureRequestBulkSendWithTemplateResponse: - summary: 'Send Signature Request With Template' + summary: '_t__SignatureRequestBulkSendWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json SignatureRequestBulkCreateEmbeddedWithTemplateResponse: - summary: 'Bulk Send Create Embedded Signature Request With Template' + summary: '_t__SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json TeamCreateResponse: - summary: 'Team Create' + summary: '_t__TeamCreateResponseExample::SUMMARY' value: $ref: examples/json/TeamCreateResponse.json TeamMembersResponse: - summary: 'Team Members List' + summary: '_t__TeamMembersResponseExample::SUMMARY' value: $ref: examples/json/TeamMembersResponse.json TeamRemoveMemberResponse: - summary: 'Team Remove Member' + summary: '_t__TeamRemoveMemberResponseExample::SUMMARY' value: $ref: examples/json/TeamRemoveMemberResponse.json TeamUpdateResponse: - summary: 'Team Update' + summary: '_t__TeamUpdateResponseExample::SUMMARY' value: $ref: examples/json/TeamUpdateResponse.json TeamDoesNotExistResponse: - summary: 'Team Does Not Exist' + summary: '_t__TeamDoesNotExistResponseExample::SUMMARY' value: $ref: examples/json/TeamDoesNotExistResponse.json TemplateAddUserResponse: - summary: 'Add User to Template' + summary: '_t__TemplateAddUserResponseExample::SUMMARY' value: $ref: examples/json/TemplateAddUserResponse.json TemplateFilesResponse: - summary: 'Template Files' + summary: '_t__TemplateFilesResponseExample::SUMMARY' value: $ref: examples/json/TemplateFilesResponse.json TemplateRemoveUserResponse: - summary: 'Remove User from Template' + summary: '_t__TemplateRemoveUserResponseExample::SUMMARY' value: $ref: examples/json/TemplateRemoveUserResponse.json UnclaimedDraftCreateEmbeddedResponse: - summary: 'Unclaimed Draft Create Embedded' + summary: '_t__UnclaimedDraftCreateEmbeddedResponseExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json UnclaimedDraftCreateEmbeddedWithTemplateResponse: - summary: 'Unclaimed Draft Create Embedded With Template' + summary: '_t__UnclaimedDraftCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json UnclaimedDraftEditAndResend: - summary: 'Unclaimed Draft Edit and Resend' + summary: '_t__UnclaimedDraftEditAndResendExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftEditAndResend.json TeamGetResponse: - summary: 'Team Get' + summary: '_t__TeamGetResponseExample::SUMMARY' value: $ref: examples/json/TeamGetResponse.json TeamGetInfoResponse: - summary: 'Team Get Info' + summary: '_t__TeamInfoResponseExample::SUMMARY' value: $ref: examples/json/TeamGetInfoResponse.json TeamInvitesResponse: - summary: 'Team Invites' + summary: '_t__TeamInvitesResponseExample::SUMMARY' value: $ref: examples/json/TeamInvitesResponse.json TeamAddMemberResponse: - summary: 'Team Add Member' + summary: '_t__TeamAddMemberResponseExample::SUMMARY' value: $ref: examples/json/TeamAddMemberResponse.json TeamSubTeamsResponse: - summary: 'Team Sub Teams List' + summary: '_t__TeamSubTeamsResponseExample::SUMMARY' value: $ref: examples/json/TeamSubTeamsResponse.json TemplateCreateResponse: - summary: 'Create Template' + summary: '_t__TemplateCreateResponseExample::SUMMARY' value: $ref: examples/json/TemplateCreateResponse.json TemplateCreateEmbeddedDraftResponse: - summary: 'Create Embedded Draft Template' + summary: '_t__TemplateCreateEmbeddedDraftResponseExample::SUMMARY' value: $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json TemplateGetResponse: - summary: 'Get Template' + summary: '_t__TemplateGetResponseExample::SUMMARY' value: $ref: examples/json/TemplateGetResponse.json TemplateListResponse: - summary: 'List Templates' + summary: '_t__TemplateListResponseExample::SUMMARY' value: $ref: examples/json/TemplateListResponse.json TemplateUpdateFilesResponse: - summary: 'Update Template Files' + summary: '_t__TemplateUpdateFilesResponseExample::SUMMARY' value: $ref: examples/json/TemplateUpdateFilesResponse.json UnclaimedDraftCreateResponse: - summary: 'Unclaimed Draft Create' + summary: '_t__UnclaimedDraftCreateResponseExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftCreateResponse.json EventCallbackAccountSignatureRequestSent: - summary: 'Example: signature_request_sent' + summary: '_t__EventCallbackAccountSignatureRequestSentExample::SUMMARY' value: $ref: examples/json/EventCallbackAccountSignatureRequestSent.json EventCallbackAccountTemplateCreated: - summary: 'Example: template_created' + summary: '_t__EventCallbackAccountTemplateCreatedExample::SUMMARY' value: $ref: examples/json/EventCallbackAccountTemplateCreated.json EventCallbackAppAccountConfirmed: - summary: 'Example: account_confirmed' + summary: '_t__EventCallbackAppAccountConfirmedExample::SUMMARY' value: $ref: examples/json/EventCallbackAppAccountConfirmed.json EventCallbackAppSignatureRequestSent: - summary: 'Example: signature_request_sent' + summary: '_t__EventCallbackAppSignatureRequestSentExample::SUMMARY' value: $ref: examples/json/EventCallbackAppSignatureRequestSent.json EventCallbackAppTemplateCreated: - summary: 'Example: template_created' + summary: '_t__EventCallbackAppTemplateCreatedExample::SUMMARY' value: $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: - description: |- - **Account Callback Payloads --** - Events that are reported at the Account level through the the *Account callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api). The *Account callback URL* can also be updated by calling [Update Account](/api/reference/operation/accountUpdate) and passing a `callback_url`. + description: '_t__EventCallbackAccountRequest::DESCRIPTION' content: multipart/form-data: schema: @@ -14241,9 +13992,7 @@ components: template_created_example: $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: - description: |- - **API App Callback Payloads --** - Events that are reported at the API App level through the *Event callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api) for a specific app. The *Event callback URL* can also be updated by calling [Update API App](/api/reference/operation/apiAppUpdate) and passing a `callback_url`. + description: '_t__EventCallbackAppRequest::DESCRIPTION' content: multipart/form-data: schema: @@ -14257,19 +14006,19 @@ components: $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: - description: 'The maximum number of requests per hour that you can make.' + description: '_t__Common::RateLimiting::LIMIT' schema: type: integer format: int32 example: 100 X-RateLimit-Remaining: - description: 'The number of requests remaining in the current rate limit window.' + description: '_t__Common::RateLimiting::REMAINING' schema: type: integer format: int32 example: 99 X-Ratelimit-Reset: - description: 'The Unix time at which the rate limit will reset to its maximum.' + description: '_t__Common::RateLimiting::RESET' schema: type: integer format: int64 @@ -14312,8 +14061,8 @@ x-webhooks: $ref: ./markdown/en/descriptions/account-callback-description.md x-meta: seo: - title: 'Account Callbacks | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the account level, click here.' + title: '_t__accountUpdateEventCallback::SEO::TITLE' + description: '_t__accountUpdateEventCallback::SEO::DESCRIPTION' x-codeSamples: - lang: PHP @@ -14360,8 +14109,8 @@ x-webhooks: operationId: apiAppCreateEventCallback x-meta: seo: - title: 'App Callbacks | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the App level, click here.' + title: '_t__appCreateEventCallback::SEO::TITLE' + description: '_t__appCreateEventCallback::SEO::DESCRIPTION' x-codeSamples: - lang: PHP diff --git a/openapi.yaml b/openapi.yaml index 819e4ec59..96853a840 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -111,8 +111,8 @@ paths: $ref: examples/AccountCreateExample.sh x-meta: seo: - title: 'Create Account | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a range of tools. Find out how to create a new Dropbox Sign Account using the specified `email_address` here.' + title: '_t__AccountCreate::SEO::TITLE' + description: '_t__AccountCreate::SEO::DESCRIPTION' /account: get: tags: @@ -220,8 +220,8 @@ paths: $ref: examples/AccountGetExample.sh x-meta: seo: - title: 'Get Account | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return the properties and settings of your Account, click here.' + title: '_t__AccountGet::SEO::TITLE' + description: '_t__AccountGet::SEO::DESCRIPTION' put: tags: - Account @@ -317,8 +317,8 @@ paths: $ref: examples/AccountUpdateExample.sh x-meta: seo: - title: 'Update Account | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how update the properties and settings of your Account, click here.' + title: '_t__AccountUpdate::SEO::TITLE' + description: '_t__AccountUpdate::SEO::DESCRIPTION' /account/verify: post: tags: @@ -415,8 +415,8 @@ paths: $ref: examples/AccountVerifyExample.sh x-meta: seo: - title: 'Verify Account | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to verify whether an Account exists, click here.' + title: '_t__AccountVerify::SEO::TITLE' + description: '_t__AccountVerify::SEO::DESCRIPTION' /api_app: post: tags: @@ -516,8 +516,8 @@ paths: $ref: examples/ApiAppCreateExample.sh x-meta: seo: - title: 'Create API App | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to create a new API App, click here.' + title: '_t__ApiAppCreate::SEO::TITLE' + description: '_t__ApiAppCreate::SEO::DESCRIPTION' '/api_app/{client_id}': get: tags: @@ -616,8 +616,8 @@ paths: $ref: examples/ApiAppGetExample.sh x-meta: seo: - title: 'Get API App | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return an object with information about an API App, click here.' + title: '_t__ApiAppGet::SEO::TITLE' + description: '_t__ApiAppGet::SEO::DESCRIPTION' put: tags: - 'Api App' @@ -727,8 +727,8 @@ paths: $ref: examples/ApiAppUpdateExample.sh x-meta: seo: - title: 'Update API App | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to update an App that you own, click here.' + title: '_t__ApiAppUpdate::SEO::TITLE' + description: '_t__ApiAppUpdate::SEO::DESCRIPTION' delete: tags: - 'Api App' @@ -817,8 +817,8 @@ paths: $ref: examples/ApiAppDeleteExample.sh x-meta: seo: - title: 'Delete API App | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to delete an API App, click here.' + title: '_t__ApiAppDelete::SEO::TITLE' + description: '_t__ApiAppDelete::SEO::DESCRIPTION' /api_app/list: get: tags: @@ -919,8 +919,8 @@ paths: $ref: examples/ApiAppListExample.sh x-meta: seo: - title: 'List API Apps | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return a list of API Apps that are accessible by you, click here.' + title: '_t__ApiAppList::SEO::TITLE' + description: '_t__ApiAppList::SEO::DESCRIPTION' '/bulk_send_job/{bulk_send_job_id}': get: tags: @@ -1030,8 +1030,8 @@ paths: $ref: examples/BulkSendJobGetExample.sh x-meta: seo: - title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of the BulkSendJob and SignatureRequests, click here.' + title: '_t__BulkSendJobGet::SEO::TITLE' + description: '_t__BulkSendJobGet::SEO::DESCRIPTION' /bulk_send_job/list: get: tags: @@ -1133,8 +1133,8 @@ paths: $ref: examples/BulkSendJobListExample.sh x-meta: seo: - title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of BulkSendJob that you can access, click here.' + title: '_t__BulkSendJobList::SEO::TITLE' + description: '_t__BulkSendJobList::SEO::DESCRIPTION' '/embedded/edit_url/{template_id}': post: tags: @@ -1240,8 +1240,8 @@ paths: $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: - title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a template url, click here.' + title: '_t__EmbeddedEditUrl::SEO::TITLE' + description: '_t__EmbeddedEditUrl::SEO::DESCRIPTION' '/embedded/sign_url/{signature_id}': get: tags: @@ -1342,8 +1342,8 @@ paths: $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: - title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.' + title: '_t__EmbeddedSignUrl::SEO::TITLE' + description: '_t__EmbeddedSignUrl::SEO::DESCRIPTION' '/fax/{fax_id}': get: tags: @@ -1439,8 +1439,8 @@ paths: $ref: examples/FaxGetExample.sh x-meta: seo: - title: 'Get Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' + title: '_t__FaxGet::SEO::TITLE' + description: '_t__FaxGet::SEO::DESCRIPTION' delete: tags: - Fax @@ -1528,8 +1528,8 @@ paths: $ref: examples/FaxDeleteExample.sh x-meta: seo: - title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here.' + title: '_t__FaxDelete::SEO::TITLE' + description: '_t__FaxDelete::SEO::DESCRIPTION' '/fax/files/{fax_id}': get: tags: @@ -1625,8 +1625,8 @@ paths: $ref: examples/FaxFilesExample.sh x-meta: seo: - title: 'Fax Files | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' + title: '_t__FaxFiles::SEO::TITLE' + description: '_t__FaxFiles::SEO::DESCRIPTION' /fax_line/add_user: put: tags: @@ -1720,8 +1720,8 @@ paths: $ref: examples/FaxLineAddUserExample.sh x-meta: seo: - title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here.' + title: '_t__FaxLineAddUser::SEO::TITLE' + description: '_t__FaxLineAddUser::SEO::DESCRIPTION' /fax_line/area_codes: get: tags: @@ -1901,8 +1901,8 @@ paths: $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: - title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' + title: '_t__FaxLineAreaCodeGet::SEO::TITLE' + description: '_t__FaxLineAreaCodeGet::SEO::DESCRIPTION' /fax_line/create: post: tags: @@ -1996,8 +1996,8 @@ paths: $ref: examples/FaxLineCreateExample.sh x-meta: seo: - title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + title: '_t__FaxLineCreate::SEO::TITLE' + description: '_t__FaxLineCreate::SEO::DESCRIPTION' /fax_line: get: tags: @@ -2091,8 +2091,8 @@ paths: $ref: examples/FaxLineGetExample.sh x-meta: seo: - title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' + title: '_t__FaxLineGet::SEO::TITLE' + description: '_t__FaxLineGet::SEO::DESCRIPTION' delete: tags: - 'Fax Line' @@ -2180,8 +2180,8 @@ paths: $ref: examples/FaxLineDeleteExample.sh x-meta: seo: - title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.' + title: '_t__FaxLineDelete::SEO::TITLE' + description: '_t__FaxLineDelete::SEO::DESCRIPTION' /fax_line/list: get: tags: @@ -2294,8 +2294,8 @@ paths: $ref: examples/FaxLineListExample.sh x-meta: seo: - title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.' + title: '_t__FaxLineList::SEO::TITLE' + description: '_t__FaxLineList::SEO::DESCRIPTION' /fax_line/remove_user: put: tags: @@ -2389,8 +2389,8 @@ paths: $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: - title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.' + title: '_t__FaxLineRemoveUser::SEO::TITLE' + description: '_t__FaxLineRemoveUser::SEO::DESCRIPTION' /fax/list: get: tags: @@ -2493,8 +2493,8 @@ paths: $ref: examples/FaxListExample.sh x-meta: seo: - title: 'List Faxes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here.' + title: '_t__FaxList::SEO::TITLE' + description: '_t__FaxList::SEO::DESCRIPTION' /fax/send: post: tags: @@ -2593,8 +2593,8 @@ paths: $ref: examples/FaxSendExample.sh x-meta: seo: - title: 'Send Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' + title: '_t__FaxSend::SEO::TITLE' + description: '_t__FaxSend::SEO::DESCRIPTION' /oauth/token: post: tags: @@ -2687,8 +2687,8 @@ paths: $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: - title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to generate a new OAuth token with the API, click here.' + title: '_t__OAuthTokenGenerate::SEO::TITLE' + description: '_t__OAuthTokenGenerate::SEO::DESCRIPTION' x-hideTryItPanel: true '/oauth/token?refresh': post: @@ -2782,8 +2782,8 @@ paths: $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: - title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to refresh your OAuth token with the API, click here.' + title: '_t__OAuthTokenRefresh::SEO::TITLE' + description: '_t__OAuthTokenRefresh::SEO::DESCRIPTION' x-hideTryItPanel: true /report/create: post: @@ -2879,8 +2879,8 @@ paths: $ref: examples/ReportCreateExample.sh x-meta: seo: - title: 'Create Report | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to request the creation of one or more reports, click here.' + title: '_t__ReportCreate::SEO::TITLE' + description: '_t__ReportCreate::SEO::DESCRIPTION' /signature_request/bulk_create_embedded_with_template: post: tags: @@ -2984,8 +2984,8 @@ paths: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create embedded BulkSendJob signature requests, click here.' + title: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::DESCRIPTION' /signature_request/bulk_send_with_template: post: tags: @@ -3089,8 +3089,8 @@ paths: $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: - title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create BulkSendJob for up to 250 signature requests, click here.' + title: '_t__SignatureRequestBulkSendWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestBulkSendWithTemplate::SEO::DESCRIPTION' '/signature_request/cancel/{signature_request_id}': post: tags: @@ -3196,8 +3196,8 @@ paths: $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: - title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to cancel an incomplete signature request, click here.' + title: '_t__SignatureRequestCancel::SEO::TITLE' + description: '_t__SignatureRequestCancel::SEO::DESCRIPTION' /signature_request/create_embedded: post: tags: @@ -3301,8 +3301,8 @@ paths: $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: - title: 'Create Embedded Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new SignatureRequest in an iFrame, click here.' + title: '_t__SignatureRequestCreateEmbedded::SEO::TITLE' + description: '_t__SignatureRequestCreateEmbedded::SEO::DESCRIPTION' /signature_request/create_embedded_with_template: post: tags: @@ -3404,8 +3404,8 @@ paths: $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Signature Request with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.' + title: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::DESCRIPTION' '/signature_request/edit/{signature_request_id}': put: tags: @@ -3524,8 +3524,8 @@ paths: $ref: examples/SignatureRequestEditExample.sh x-meta: seo: - title: 'Edit Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.' + title: '_t__SignatureRequestEdit::SEO::TITLE' + description: '_t__SignatureRequestEdit::SEO::DESCRIPTION' '/signature_request/edit_embedded/{signature_request_id}': put: tags: @@ -3643,8 +3643,8 @@ paths: $ref: examples/SignatureRequestEditEmbeddedExample.sh x-meta: seo: - title: 'Edit Embedded Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.' + title: '_t__SignatureRequestEditEmbedded::SEO::TITLE' + description: '_t__SignatureRequestEditEmbedded::SEO::DESCRIPTION' '/signature_request/edit_embedded_with_template/{signature_request_id}': put: tags: @@ -3760,8 +3760,8 @@ paths: $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Signature Request with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.' + title: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::DESCRIPTION' '/signature_request/edit_with_template/{signature_request_id}': put: tags: @@ -3878,8 +3878,8 @@ paths: $ref: examples/SignatureRequestEditWithTemplateExample.sh x-meta: seo: - title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.' + title: '_t__SignatureRequestEditWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestEditWithTemplate::SEO::DESCRIPTION' '/signature_request/files/{signature_request_id}': get: tags: @@ -3998,8 +3998,8 @@ paths: $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + title: '_t__SignatureRequestFiles::SEO::TITLE' + description: '_t__SignatureRequestFiles::SEO::DESCRIPTION' '/signature_request/files_as_data_uri/{signature_request_id}': get: tags: @@ -4106,8 +4106,8 @@ paths: $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + title: '_t__SignatureRequestFiles::SEO::TITLE' + description: '_t__SignatureRequestFiles::SEO::DESCRIPTION' '/signature_request/files_as_file_url/{signature_request_id}': get: tags: @@ -4221,8 +4221,8 @@ paths: $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + title: '_t__SignatureRequestFiles::SEO::TITLE' + description: '_t__SignatureRequestFiles::SEO::DESCRIPTION' '/signature_request/{signature_request_id}': get: tags: @@ -4322,8 +4322,8 @@ paths: $ref: examples/SignatureRequestGetExample.sh x-meta: seo: - title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' + title: '_t__SignatureRequestGet::SEO::TITLE' + description: '_t__SignatureRequestGet::SEO::DESCRIPTION' /signature_request/list: get: tags: @@ -4443,8 +4443,8 @@ paths: $ref: examples/SignatureRequestListExample.sh x-meta: seo: - title: 'List Signature Requests | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' + title: '_t__SignatureRequestList::SEO::TITLE' + description: '_t__SignatureRequestList::SEO::DESCRIPTION' '/signature_request/release_hold/{signature_request_id}': post: tags: @@ -4541,8 +4541,8 @@ paths: $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: - title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' + title: '_t__SignatureRequestReleaseHold::SEO::TITLE' + description: '_t__SignatureRequestReleaseHold::SEO::DESCRIPTION' '/signature_request/remind/{signature_request_id}': post: tags: @@ -4658,8 +4658,8 @@ paths: $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: - title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' + title: '_t__SignatureRequestRemind::SEO::TITLE' + description: '_t__SignatureRequestRemind::SEO::DESCRIPTION' '/signature_request/remove/{signature_request_id}': post: tags: @@ -4757,8 +4757,8 @@ paths: $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: - title: 'Remove Signature Request Access | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' + title: '_t__SignatureRequestRemove::SEO::TITLE' + description: '_t__SignatureRequestRemove::SEO::DESCRIPTION' /signature_request/send: post: tags: @@ -4863,8 +4863,8 @@ paths: $ref: examples/SignatureRequestSendExample.sh x-meta: seo: - title: 'Send Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' + title: '_t__SignatureRequestSend::SEO::TITLE' + description: '_t__SignatureRequestSend::SEO::DESCRIPTION' /signature_request/send_with_template: post: tags: @@ -4965,8 +4965,8 @@ paths: $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: - title: 'Send with Template | API Documentation | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' + title: '_t__SignatureRequestSendWithTemplate::SEO::TITLE' + description: '_t__SignatureRequestSendWithTemplate::SEO::DESCRIPTION' '/signature_request/update/{signature_request_id}': post: tags: @@ -5077,8 +5077,8 @@ paths: $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: - title: 'Update Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' + title: '_t__SignatureRequestUpdate::SEO::TITLE' + description: '_t__SignatureRequestUpdate::SEO::DESCRIPTION' /team/add_member: put: tags: @@ -5186,8 +5186,8 @@ paths: $ref: examples/TeamAddMemberExample.sh x-meta: seo: - title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' + title: '_t__TeamAddMember::SEO::TITLE' + description: '_t__TeamAddMember::SEO::DESCRIPTION' /team/create: post: tags: @@ -5282,8 +5282,8 @@ paths: $ref: examples/TeamCreateExample.sh x-meta: seo: - title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' + title: '_t__TeamCreate::SEO::TITLE' + description: '_t__TeamCreate::SEO::DESCRIPTION' /team/destroy: delete: tags: @@ -5362,8 +5362,8 @@ paths: $ref: examples/TeamDeleteExample.sh x-meta: seo: - title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' + title: '_t__TeamDelete::SEO::TITLE' + description: '_t__TeamDelete::SEO::DESCRIPTION' /team: get: tags: @@ -5451,8 +5451,8 @@ paths: $ref: examples/TeamGetExample.sh x-meta: seo: - title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + title: '_t__TeamGet::SEO::TITLE' + description: '_t__TeamGet::SEO::DESCRIPTION' put: tags: - Team @@ -5546,8 +5546,8 @@ paths: $ref: examples/TeamUpdateExample.sh x-meta: seo: - title: 'Update Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' + title: '_t__TeamUpdate::SEO::TITLE' + description: '_t__TeamUpdate::SEO::DESCRIPTION' /team/info: get: tags: @@ -5646,8 +5646,8 @@ paths: $ref: examples/TeamInfoExample.sh x-meta: seo: - title: 'Get Team Info | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' + title: '_t__TeamInfo::SEO::TITLE' + description: '_t__TeamInfo::SEO::DESCRIPTION' /team/invites: get: tags: @@ -5742,8 +5742,8 @@ paths: $ref: examples/TeamInvitesExample.sh x-meta: seo: - title: 'List Team Invites | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' + title: '_t__TeamInvites::SEO::TITLE' + description: '_t__TeamInvites::SEO::DESCRIPTION' '/team/members/{team_id}': get: tags: @@ -5858,8 +5858,8 @@ paths: $ref: examples/TeamMembersExample.sh x-meta: seo: - title: 'List Team Members | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' + title: '_t__TeamMembers::SEO::TITLE' + description: '_t__TeamMembers::SEO::DESCRIPTION' /team/remove_member: post: tags: @@ -5958,8 +5958,8 @@ paths: $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: - title: 'Remove User from Team | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' + title: '_t__TeamRemoveMember::SEO::TITLE' + description: '_t__TeamRemoveMember::SEO::DESCRIPTION' '/team/sub_teams/{team_id}': get: tags: @@ -6074,8 +6074,8 @@ paths: $ref: examples/TeamSubTeamsExample.sh x-meta: seo: - title: 'List Sub Teams | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' + title: '_t__TeamSubTeams::SEO::TITLE' + description: '_t__TeamSubTeams::SEO::DESCRIPTION' '/template/add_user/{template_id}': post: tags: @@ -6181,8 +6181,8 @@ paths: $ref: examples/TemplateAddUserExample.sh x-meta: seo: - title: 'Add User to Template | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' + title: '_t__TemplateAddUser::SEO::TITLE' + description: '_t__TemplateAddUser::SEO::DESCRIPTION' /template/create: post: tags: @@ -6290,8 +6290,8 @@ paths: $ref: examples/TemplateCreateExample.sh x-meta: seo: - title: 'Create Template | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' + title: '_t__TemplateCreate::SEO::TITLE' + description: '_t__TemplateCreate::SEO::DESCRIPTION' /template/create_embedded_draft: post: tags: @@ -6399,8 +6399,8 @@ paths: $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: - title: 'Create Embedded Template Draft | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' + title: '_t__TemplateCreateEmbeddedDraft::SEO::TITLE' + description: '_t__TemplateCreateEmbeddedDraft::SEO::DESCRIPTION' '/template/delete/{template_id}': post: tags: @@ -6494,8 +6494,8 @@ paths: $ref: examples/TemplateDeleteExample.sh x-meta: seo: - title: 'Delete Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' + title: '_t__TemplateDelete::SEO::TITLE' + description: '_t__TemplateDelete::SEO::DESCRIPTION' '/template/files/{template_id}': get: tags: @@ -6612,8 +6612,8 @@ paths: $ref: examples/TemplateFilesExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + title: '_t__TemplateFiles::SEO::TITLE' + description: '_t__TemplateFiles::SEO::DESCRIPTION' '/template/files_as_data_uri/{template_id}': get: tags: @@ -6719,8 +6719,8 @@ paths: $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + title: '_t__TemplateFiles::SEO::TITLE' + description: '_t__TemplateFiles::SEO::DESCRIPTION' '/template/files_as_file_url/{template_id}': get: tags: @@ -6833,8 +6833,8 @@ paths: $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + title: '_t__TemplateFiles::SEO::TITLE' + description: '_t__TemplateFiles::SEO::DESCRIPTION' '/template/{template_id}': get: tags: @@ -6933,8 +6933,8 @@ paths: $ref: examples/TemplateGetExample.sh x-meta: seo: - title: 'Get Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' + title: '_t__TemplateGet::SEO::TITLE' + description: '_t__TemplateGet::SEO::DESCRIPTION' /template/list: get: tags: @@ -7056,8 +7056,8 @@ paths: $ref: examples/TemplateListExample.sh x-meta: seo: - title: 'List Templates | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' + title: '_t__TemplateList::SEO::TITLE' + description: '_t__TemplateList::SEO::DESCRIPTION' '/template/remove_user/{template_id}': post: tags: @@ -7163,8 +7163,8 @@ paths: $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: - title: 'Remove User from Template | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' + title: '_t__TemplateRemoveUser::SEO::TITLE' + description: '_t__TemplateRemoveUser::SEO::DESCRIPTION' '/template/update_files/{template_id}': post: tags: @@ -7289,8 +7289,8 @@ paths: $ref: examples/TemplateUpdateFilesExample.sh x-meta: seo: - title: 'Update Template Files | REST API | Dropbox Sign for Developers' - description: 'Overlays a new file with the overlay of an existing template' + title: '_t__TemplateUpdateFiles::SEO::TITLE' + description: '_t__TemplateUpdateFiles::SEO::DESCRIPTION' /unclaimed_draft/create: post: tags: @@ -7394,8 +7394,8 @@ paths: $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: - title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' + title: '_t__UnclaimedDraftCreate::SEO::TITLE' + description: '_t__UnclaimedDraftCreate::SEO::DESCRIPTION' /unclaimed_draft/create_embedded: post: tags: @@ -7507,8 +7507,8 @@ paths: $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh x-meta: seo: - title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' + title: '_t__UnclaimedDraftCreateEmbedded::SEO::TITLE' + description: '_t__UnclaimedDraftCreateEmbedded::SEO::DESCRIPTION' /unclaimed_draft/create_embedded_with_template: post: tags: @@ -7615,8 +7615,8 @@ paths: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' + title: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SEO::TITLE' + description: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SEO::DESCRIPTION' '/unclaimed_draft/edit_and_resend/{signature_request_id}': post: tags: @@ -7730,8 +7730,8 @@ paths: $ref: examples/UnclaimedDraftEditAndResendExample.sh x-meta: seo: - title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' + title: '_t__UnclaimedDraftEditAndResend::SEO::TITLE' + description: '_t__UnclaimedDraftEditAndResend::SEO::DESCRIPTION' components: schemas: AccountCreateRequest: @@ -7797,7 +7797,7 @@ components: type: array items: type: string - maxItems: 2 + maxItems: 10 minItems: 1 name: description: 'The name you want to assign to the ApiApp.' @@ -7823,7 +7823,7 @@ components: type: array items: type: string - maxItems: 2 + maxItems: 10 name: description: 'The name you want to assign to the ApiApp.' type: string @@ -7840,6 +7840,10 @@ components: description: 'This allows the requester to enable/disable to add or change CC roles when editing the template.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false cc_roles: description: 'The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.' type: array @@ -8135,6 +8139,7 @@ components: enum: - user_activity - document_status + - sms_activity maxItems: 2 minItems: 1 start_date: @@ -8208,10 +8213,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8297,10 +8299,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8342,18 +8341,12 @@ components: items: type: string signers: - description: |- - Add Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: - description: |- - Add Grouped Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' @@ -8361,6 +8354,10 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8369,7 +8366,7 @@ components: type: boolean default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -8435,10 +8432,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8522,15 +8516,12 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' @@ -8576,18 +8567,12 @@ components: items: type: string signers: - description: |- - Add Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: - description: |- - Add Grouped Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' @@ -8595,6 +8580,10 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8603,7 +8592,7 @@ components: type: boolean default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -8677,10 +8666,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8732,18 +8718,12 @@ components: items: type: string signers: - description: |- - Add Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: - description: |- - Add Grouped Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' @@ -8751,6 +8731,10 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8759,7 +8743,7 @@ components: type: boolean default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -8825,10 +8809,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -8912,15 +8893,12 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' @@ -9004,15 +8982,12 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' @@ -9066,18 +9041,12 @@ components: items: type: string signers: - description: |- - Add Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: - description: |- - Add Grouped Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. + description: '_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' @@ -9092,8 +9061,12 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -9167,10 +9140,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -9258,15 +9228,12 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' @@ -9837,10 +9804,7 @@ components: description: 'Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.' type: boolean validation_type: - description: |- - Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. - - **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + description: '_t__Sub::FormFieldsPerDocument::VALIDATION_TYPE' type: string enum: - numbers_only @@ -9898,7 +9862,7 @@ components: - type properties: type: - description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.' + description: '_t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE' type: string default: text-merge font_family: @@ -10023,13 +9987,13 @@ components: type: type: string width: - description: 'Size of the field in pixels.' + description: '_t__Sub::FormFieldsPerDocument::WIDTH' type: integer x: - description: 'Location coordinates of the field in pixels.' + description: '_t__Sub::FormFieldsPerDocument::X' type: integer 'y': - description: 'Location coordinates of the field in pixels.' + description: '_t__Sub::FormFieldsPerDocument::Y' type: integer type: object discriminator: @@ -10053,17 +10017,14 @@ components: - signers properties: group: - description: 'The name of the group.' + description: '_t__Sub::SignatureRequestGroupedSigners::GROUP_NAME' type: string order: - description: 'The order the group is required to sign in. Use this instead of Signer-level `order`.' + description: '_t__Sub::SignatureRequestGroupedSigners::ORDER' type: integer nullable: true signers: - description: |- - 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. + description: '_t__Sub::SignatureRequestGroupedSigners::SIGNERS' type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' @@ -10074,26 +10035,26 @@ components: - type properties: name: - description: 'The name of the merge field. Must be unique.' + description: '_t__Sub::MergeField::NAME' type: string type: - description: 'The type of merge field.' + description: '_t__Sub::MergeField::TYPE' type: string enum: - text - checkbox x-enumDescriptions: - text: 'Sets merge [field type](/api/reference/constants/#field-types) to `text`.' - checkbox: 'Sets merge [field type](/api/reference/constants/#field-types) to `checkbox`.' + text: '_t__Sub::MergeField::EnumDescriptions::TEXT' + checkbox: '_t__Sub::MergeField::EnumDescriptions::CHECKBOX' type: object SubOAuth: - description: 'OAuth related parameters.' + description: '_t__Sub::OAuth::DESCRIPTION' properties: callback_url: - description: 'The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)' + description: '_t__Sub::OAuth::CALLBACK_URL' type: string scopes: - description: 'A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided).' + description: '_t__Sub::OAuth::SCOPES' type: array items: type: string @@ -10108,10 +10069,10 @@ components: - '' type: object SubOptions: - description: 'Additional options supported by API App.' + description: '_t__Sub::Options::DESCRIPTION' properties: can_insert_everywhere: - description: 'Determines if signers can use "Insert Everywhere" when signing a document.' + description: '_t__Sub::Options::CAN_INSERT_EVERYWHERE' type: boolean default: false type: object @@ -10121,36 +10082,26 @@ components: - email_address properties: name: - description: 'The name of the signer.' + description: '_t__Sub::SignatureRequestSigner::SIGNER_NAME' type: string email_address: - description: 'The email address of the signer.' + description: '_t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS' type: string format: email order: - description: 'The order the signer is required to sign in.' + description: '_t__Sub::SignatureRequestSigner::SIGNER_ORDER' type: integer nullable: true pin: - description: 'The 4- to 12-character access code that will secure this signer''s signature page.' + description: '_t__Sub::SignatureRequestSigner::SIGNER_PIN' type: string maxLength: 12 minLength: 4 sms_phone_number: - description: |- - An E.164 formatted phone number. - - By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - - **NOTE:** Not available in test mode and requires a Standard plan or higher. + description: '_t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER' type: string sms_phone_number_type: - description: |- - Specifies the feature used with the `sms_phone_number`. Default `authentication`. - - If `authentication`, signer is sent a verification code via SMS that is required to access the document. - - If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + description: '_t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE' type: string enum: - authentication @@ -10163,35 +10114,25 @@ components: - email_address properties: role: - description: 'Must match an existing role in chosen Template(s). It''s case-sensitive.' + description: '_t__Sub::SignatureRequestTemplateSigner::ROLE' type: string name: - description: 'The name of the signer.' + description: '_t__Sub::SignatureRequestTemplateSigner::NAME' type: string email_address: - description: 'The email address of the signer.' + description: '_t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS' type: string format: email pin: - description: 'The 4- to 12-character access code that will secure this signer''s signature page.' + description: '_t__Sub::SignatureRequestTemplateSigner::PIN' type: string maxLength: 12 minLength: 4 sms_phone_number: - description: |- - An E.164 formatted phone number. - - By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - - **NOTE:** Not available in test mode and requires a Standard plan or higher. + description: '_t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER' type: string sms_phone_number_type: - description: |- - Specifies the feature used with the `sms_phone_number`. Default `authentication`. - - If `authentication`, signer is sent a verification code via SMS that is required to access the document. - - If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + description: '_t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE' type: string enum: - authentication @@ -10203,14 +10144,14 @@ components: - email_address properties: email_address: - description: 'The email address of the signer.' + description: '_t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS' type: string format: email name: - description: 'The name of the signer.' + description: '_t__Sub::UnclaimedDraftSigner::NAME' type: string order: - description: 'The order the signer is required to sign in.' + description: '_t__Sub::UnclaimedDraftSigner::ORDER' type: integer nullable: true type: object @@ -10221,36 +10162,33 @@ components: - email_address properties: role: - description: 'Must match an existing role in chosen Template(s).' + description: '_t__Sub::UnclaimedDraftTemplateSigner::ROLE' type: string name: - description: 'The name of the signer filling the role of `role`.' + description: '_t__Sub::UnclaimedDraftTemplateSigner::NAME' type: string email_address: - description: 'The email address of the signer filling the role of `role`.' + description: '_t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS' type: string format: email type: object SubTemplateRole: properties: name: - description: 'The role name of the signer that will be displayed when the template is used to create a signature request.' + description: '_t__Sub::SignerRole::NAME' type: string order: - description: 'The order in which this signer role is required to sign.' + description: '_t__Sub::SignerRole::ORDER' type: integer nullable: true type: object SubSigningOptions: - description: |- - This allows the requester to specify the types allowed for creating a signature. - - **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + description: '_t__Sub::SigningOptions::DESCRIPTION' required: - default_type properties: default_type: - description: 'The default type shown (limited to the listed types)' + description: '_t__Sub::SigningOptions::DEFAULT' type: string enum: - draw @@ -10258,27 +10196,24 @@ components: - type - upload draw: - description: 'Allows drawing the signature' + description: '_t__Sub::SigningOptions::DRAW' type: boolean default: false phone: - description: 'Allows using a smartphone to email the signature' + description: '_t__Sub::SigningOptions::PHONE' type: boolean default: false type: - description: 'Allows typing the signature' + description: '_t__Sub::SigningOptions::TYPE' type: boolean default: false upload: - description: 'Allows uploading the signature' + description: '_t__Sub::SigningOptions::UPLOAD' type: boolean default: false type: object SubWhiteLabelingOptions: - description: |- - An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) - - Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. + description: '_t__Sub::WhiteLabelingOptions::DESCRIPTION' properties: header_background_color: type: string @@ -10326,7 +10261,7 @@ components: type: string default: '#ffffff' reset_to_default: - description: 'Resets white labeling options to defaults. Only useful when updating an API App.' + description: '_t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT' type: boolean type: object TeamAddMemberRequest: @@ -10453,8 +10388,12 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -10509,10 +10448,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -10569,8 +10505,12 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -10635,10 +10575,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -10750,8 +10687,12 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -10814,10 +10755,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -10826,7 +10764,7 @@ components: type: boolean default: true signers: - description: 'Add Signers to your Unclaimed Draft Signature Request.' + description: '_t__Sub::UnclaimedDraftSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftSigner' @@ -10896,6 +10834,10 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false + allow_form_view: + description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' + type: boolean + default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -10904,7 +10846,7 @@ components: type: boolean default: false attachments: - description: 'A list describing the attachments' + description: '_t__SubAttachment::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/SubAttachment' @@ -10985,10 +10927,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -11011,7 +10950,7 @@ components: type: boolean default: true signers: - description: 'Add Signers to your Unclaimed Draft Signature Request.' + description: '_t__Sub::UnclaimedDraftSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftSigner' @@ -11134,10 +11073,7 @@ components: type: string maxLength: 5000 metadata: - description: |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + description: '_t__Sub::Metadata::DESCRIPTION' type: object maxItems: 10 additionalProperties: {} @@ -11171,7 +11107,7 @@ components: type: boolean default: true signers: - description: 'Add Signers to your Templated-based Signature Request.' + description: '_t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftTemplateSigner' @@ -11253,7 +11189,7 @@ components: oauth_data: $ref: '#/components/schemas/OAuthTokenResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11266,7 +11202,7 @@ components: account: $ref: '#/components/schemas/AccountResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11277,7 +11213,7 @@ components: account: $ref: '#/components/schemas/AccountVerifyResponseAccount' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11290,7 +11226,7 @@ components: api_app: $ref: '#/components/schemas/ApiAppResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11302,14 +11238,14 @@ components: - list_info properties: api_apps: - description: 'Contains information about API Apps.' + description: '_t__ApiAppListResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/ApiAppResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11326,12 +11262,12 @@ components: list_info: $ref: '#/components/schemas/ListInfoResponse' signature_requests: - description: 'Contains information about the Signature Requests sent in bulk.' + description: '_t__BulkSendJobGetResponse::SIGNATURE_REQUESTS' type: array items: $ref: '#/components/schemas/BulkSendJobGetResponseSignatureRequests' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11343,14 +11279,14 @@ components: - list_info properties: bulk_send_jobs: - description: 'Contains a list of BulkSendJobs that the API caller has access to.' + description: '_t__BulkSendJobListResponse::BULK_SEND_JOBS' type: array items: $ref: '#/components/schemas/BulkSendJobResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11363,7 +11299,7 @@ components: bulk_send_job: $ref: '#/components/schemas/BulkSendJobResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11376,7 +11312,7 @@ components: embedded: $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11389,7 +11325,7 @@ components: embedded: $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11409,7 +11345,7 @@ components: fax: $ref: '#/components/schemas/FaxResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11469,10 +11405,10 @@ components: - expires_at properties: file_url: - description: 'URL to the file.' + description: '_t__FileResponse::FILE_URL' type: string expires_at: - description: 'When the link expires.' + description: '_t__FileResponse::EXPIRES_AT' type: integer type: object x-internal-class: true @@ -11481,7 +11417,7 @@ components: - data_uri properties: data_uri: - description: 'File as base64 encoded string.' + description: '_t__FileResponse::DATA_URI' type: string type: object x-internal-class: true @@ -11492,7 +11428,7 @@ components: report: $ref: '#/components/schemas/ReportResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11505,7 +11441,7 @@ components: signature_request: $ref: '#/components/schemas/SignatureRequestResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11517,14 +11453,14 @@ components: - list_info properties: signature_requests: - description: 'Contains information about signature requests.' + description: '_t__SignatureRequestListResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -11533,36 +11469,36 @@ components: AccountResponse: properties: account_id: - description: 'The ID of the Account' + description: '_t__Account::ACCOUNT_ID' type: string email_address: - description: 'The email address associated with the Account.' + description: '_t__Account::EMAIL_ADDRESS' type: string is_locked: - description: 'Returns `true` if the user has been locked out of their account by a team admin.' + description: '_t__Account::IS_LOCKED' type: boolean is_paid_hs: - description: 'Returns `true` if the user has a paid Dropbox Sign account.' + description: '_t__Account::IS_PAID_HS' type: boolean is_paid_hf: - description: 'Returns `true` if the user has a paid HelloFax account.' + description: '_t__Account::IS_PAID_HF' type: boolean quotas: $ref: '#/components/schemas/AccountResponseQuotas' callback_url: - description: 'The URL that Dropbox Sign events will `POST` to.' + description: '_t__Account::CALLBACK_URL' type: string nullable: true role_code: - description: 'The membership role for the team.' + description: '_t__Account::ROLE_CODE' type: string nullable: true team_id: - description: 'The id of the team account belongs to.' + description: '_t__Account::TEAM_ID' type: string nullable: true locale: - description: '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.' + description: '_t__Account::LOCALE' type: string nullable: true usage: @@ -11578,7 +11514,7 @@ components: refresh_token: type: string expires_in: - description: 'Number of seconds until the `access_token` expires. Uses epoch time.' + description: '_t__OAuthTokenResponse::EXPIRES_IN' type: integer state: type: string @@ -11586,39 +11522,39 @@ components: type: object x-internal-class: true AccountResponseQuotas: - description: 'Details concerning remaining monthly quotas.' + description: '_t__Account::QUOTA' properties: api_signature_requests_left: - description: 'API signature requests remaining.' + description: '_t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT' type: integer nullable: true documents_left: - description: 'Signature requests remaining.' + description: '_t__AccountQuota::DOCUMENTS_LEFT' type: integer nullable: true templates_total: - description: 'Total API templates allowed.' + description: '_t__AccountQuota::TEMPLATES_TOTAL' type: integer nullable: true templates_left: - description: 'API templates remaining.' + description: '_t__AccountQuota::TEMPLATES_LEFT' type: integer nullable: true sms_verifications_left: - description: 'SMS verifications remaining.' + description: '_t__AccountQuota::SMS_VERIFICATIONS_LEFT' type: integer nullable: true num_fax_pages_left: - description: 'Number of fax pages left' + description: '_t__AccountQuota::NUM_FAX_PAGES_LEFT' type: integer nullable: true type: object x-internal-class: true AccountResponseUsage: - description: 'Details concerning monthly usage' + description: '_t__Account::USAGE' properties: fax_pages_sent: - description: 'Number of fax pages sent' + description: '_t__AccountUsage::FAX_PAGES_SENT' type: integer nullable: true type: object @@ -11626,33 +11562,33 @@ components: AccountVerifyResponseAccount: properties: email_address: - description: 'The email address associated with the Account.' + description: '_t__Account::EMAIL_ADDRESS' type: string type: object x-internal-class: true ApiAppResponse: - description: 'Contains information about an API App.' + description: '_t__ApiAppResponse::DESCRIPTION' properties: callback_url: - description: 'The app''s callback URL (for events)' + description: '_t__ApiAppResponse::CALLBACK_URL' type: string nullable: true client_id: - description: 'The app''s client id' + description: '_t__ApiAppResponse::CLIENT_ID' type: string created_at: - description: 'The time that the app was created' + description: '_t__ApiAppResponse::CREATED_AT' type: integer domains: - description: 'The domain name(s) associated with the app' + description: '_t__ApiAppResponse::DOMAINS' type: array items: type: string name: - description: 'The name of the app' + description: '_t__ApiAppResponse::NAME' type: string is_approved: - description: 'Boolean to indicate if the app has been approved' + description: '_t__ApiAppResponse::IS_APPROVED' type: boolean oauth: $ref: '#/components/schemas/ApiAppResponseOAuth' @@ -11665,48 +11601,48 @@ components: type: object x-internal-class: true ApiAppResponseOAuth: - description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.' + description: '_t__ApiAppResponseOAuth::DESCRIPTION' properties: callback_url: - description: 'The app''s OAuth callback URL.' + description: '_t__ApiAppResponseOAuth::CALLBACK_URL' type: string secret: - description: 'The app''s OAuth secret, or null if the app does not belong to user.' + description: '_t__ApiAppResponseOAuth::SECRET' type: string nullable: true scopes: - description: 'Array of OAuth scopes used by the app.' + description: '_t__ApiAppResponseOAuth::SCOPES' type: array items: type: string charges_users: - description: 'Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.' + description: '_t__ApiAppResponseOAuth::CHARGES_USERS' type: boolean type: object nullable: true x-internal-class: true ApiAppResponseOptions: - description: 'An object with options that override account settings.' + description: '_t__ApiAppResponseOptions::DESCRIPTION' properties: can_insert_everywhere: - description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' + description: '_t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE' type: boolean type: object nullable: true x-internal-class: true ApiAppResponseOwnerAccount: - description: 'An object describing the app''s owner' + description: '_t__ApiAppResponseOwnerAccount::DESCRIPTION' properties: account_id: - description: 'The owner account''s ID' + description: '_t__ApiAppResponseOwnerAccount::ACCOUNT_ID' type: string email_address: - description: 'The owner account''s email address' + description: '_t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS' type: string type: object x-internal-class: true ApiAppResponseWhiteLabelingOptions: - description: 'An object with options to customize the app''s signer page' + description: '_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION' properties: header_background_color: type: string @@ -11740,20 +11676,20 @@ components: nullable: true x-internal-class: true BulkSendJobResponse: - description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.' + description: '_t__BulkSendJobResponse::DESCRIPTION' properties: bulk_send_job_id: - description: 'The id of the BulkSendJob.' + description: '_t__BulkSendJobResponse::BULK_SEND_JOB_ID' type: string nullable: true total: - description: 'The total amount of Signature Requests queued for sending.' + description: '_t__BulkSendJobResponse::TOTAL' type: integer is_creator: - description: 'True if you are the owner of this BulkSendJob, false if it''s been shared with you by a team member.' + description: '_t__BulkSendJobResponse::IS_CREATOR' type: boolean created_at: - description: 'Time that the BulkSendJob was created.' + description: '_t__BulkSendJobResponse::CREATED_AT' type: integer type: object x-internal-class: true @@ -11766,49 +11702,49 @@ components: - properties: bulk_send_job_id: - description: 'The id of the BulkSendJob.' + description: '_t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID' type: string metadata: - description: 'The metadata attached to the signature request.' + description: '_t__SignatureRequestResponse::METADATA' type: object additionalProperties: {} x-internal-class: true EmbeddedEditUrlResponseEmbedded: - description: 'An embedded template object.' + description: '_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION' properties: edit_url: - description: 'A template url that can be opened in an iFrame.' + description: '_t__EmbeddedEditUrlResponseEmbedded::EDIT_URL' type: string expires_at: - description: 'The specific time that the the `edit_url` link expires, in epoch.' + description: '_t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT' type: integer type: object x-internal-class: true EmbeddedSignUrlResponseEmbedded: - description: 'An object that contains necessary information to set up embedded signing.' + description: '_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION' properties: sign_url: - description: 'A signature url that can be opened in an iFrame.' + description: '_t__EmbeddedSignUrlResponseEmbedded::SIGN_URL' type: string expires_at: - description: 'The specific time that the the `sign_url` link expires, in epoch.' + description: '_t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT' type: integer type: object x-internal-class: true ErrorResponseError: - description: 'Contains information about an error that occurred.' + description: '_t__ErrorResponseError::DESCRIPTION' required: - error_msg - error_name properties: error_msg: - description: 'Message describing an error.' + description: '_t__ErrorResponseError::ERROR_MSG' type: string error_path: - description: 'Path at which an error occurred.' + description: '_t__ErrorResponseError::ERROR_PATH' type: string error_name: - description: 'Name of the error.' + description: '_t__ErrorResponseError::ERROR_NAME' type: string type: object FaxResponse: @@ -11906,156 +11842,153 @@ components: type: object x-internal-class: true ListInfoResponse: - description: 'Contains pagination information about the data returned.' + description: '_t__ListInfoResponse::DESCRIPTION' properties: num_pages: - description: 'Total number of pages available.' + description: '_t__ListInfoResponse::NUM_PAGES' type: integer num_results: - description: 'Total number of objects available.' + description: '_t__ListInfoResponse::NUM_RESULTS' type: integer nullable: true page: - description: 'Number of the page being returned.' + description: '_t__ListInfoResponse::PAGE' type: integer page_size: - description: 'Objects returned per page.' + description: '_t__ListInfoResponse::PAGE_SIZE' type: integer type: object x-internal-class: true ReportResponse: - description: 'Contains information about the report request.' + description: '_t__ReportResponse::DESCRIPTION' properties: success: - description: 'A message indicating the requested operation''s success' + description: '_t__ReportResponse::SUCCESS' type: string start_date: - description: 'The (inclusive) start date for the report data in MM/DD/YYYY format.' + description: '_t__ReportResponse::START_DATE' type: string end_date: - description: 'The (inclusive) end date for the report data in MM/DD/YYYY format.' + description: '_t__ReportResponse::END_DATE' type: string report_type: - description: '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).' + description: '_t__ReportResponse::REPORT_TYPE' type: array items: enum: - user_activity - document_status + - sms_activity type: object x-internal-class: true SignatureRequestResponse: - description: 'Contains information about a signature request.' + description: '_t__SignatureRequestResponse::DESCRIPTION' properties: test_mode: - description: 'Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.' + description: '_t__SignatureRequestResponse::TEST_MODE' type: boolean default: false signature_request_id: - description: 'The id of the SignatureRequest.' + description: '_t__SignatureRequestResponse::SIGNATURE_REQUEST_ID' type: string requester_email_address: - description: 'The email address of the initiator of the SignatureRequest.' + description: '_t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS' type: string nullable: true title: - description: 'The title the specified Account uses for the SignatureRequest.' + description: '_t__SignatureRequestResponse::TITLE' type: string original_title: - description: 'Default Label for account.' + description: '_t__SignatureRequestResponse::ORIGINAL_TITLE' type: string subject: - description: 'The subject in the email that was initially sent to the signers.' + description: '_t__SignatureRequestResponse::SUBJECT' type: string nullable: true message: - description: 'The custom message in the email that was initially sent to the signers.' + description: '_t__SignatureRequestResponse::MESSAGE' type: string nullable: true metadata: - description: 'The metadata attached to the signature request.' + description: '_t__SignatureRequestResponse::METADATA' type: object additionalProperties: {} created_at: - description: 'Time the signature request was created.' + description: '_t__SignatureRequestResponse::CREATED_AT' type: integer expires_at: - description: 'The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' + description: '_t__SignatureRequestResponse::EXPIRES_AT' type: integer nullable: true is_complete: - description: 'Whether or not the SignatureRequest has been fully executed by all signers.' + description: '_t__SignatureRequestResponse::IS_COMPLETE' type: boolean is_declined: - description: 'Whether or not the SignatureRequest has been declined by a signer.' + description: '_t__SignatureRequestResponse::IS_DECLINED' type: boolean has_error: - description: 'Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).' + description: '_t__SignatureRequestResponse::HAS_ERROR' type: boolean files_url: - description: 'The URL where a copy of the request''s documents can be downloaded.' + description: '_t__SignatureRequestResponse::FILES_URL' type: string signing_url: - description: 'The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.' + description: '_t__SignatureRequestResponse::SIGNING_URL' type: string nullable: true details_url: - description: 'The URL where the requester and the signers can view the current status of the SignatureRequest.' + description: '_t__SignatureRequestResponse::DETAILS_URL' type: string cc_email_addresses: - description: 'A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.' + description: '_t__SignatureRequestResponse::CC_EMAIL_ADDRESSES' type: array items: type: string signing_redirect_url: - description: 'The URL you want the signer redirected to after they successfully sign.' + description: '_t__SignatureRequestResponse::SIGNING_REDIRECT_URL' type: string nullable: true final_copy_uri: - description: 'The path where the completed document can be downloaded' + description: '_t__SignatureRequestResponse::FINAL_COPY_URI' type: string nullable: true template_ids: - description: 'Templates IDs used in this SignatureRequest (if any).' + description: '_t__SignatureRequestResponse::TEMPLATE_IDS' type: array items: type: string nullable: true custom_fields: - description: |- - An array of Custom Field objects containing the name and type of each custom field. - - * Text Field uses `SignatureRequestResponseCustomFieldText` - * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + description: '_t__SignatureRequestResponseCustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' nullable: true attachments: - description: 'Signer attachments.' + description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseAttachment' nullable: true response_data: - description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.' + description: '_t__SignatureRequestResponseData::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseDataBase' nullable: true signatures: - description: 'An array of signature objects, 1 for each signer.' + description: '_t__SignatureRequestResponseSignatures::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseSignatures' bulk_send_job_id: - description: 'The ID of the Bulk Send job which sent the signature request, if applicable.' + description: '_t__SignatureRequestResponse::BULK_SEND_JOB_ID' type: string nullable: true type: object x-internal-class: true SignatureRequestResponseAttachment: - description: 'Signer attachments.' + description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' required: - id - signer @@ -12063,52 +11996,48 @@ components: - required properties: id: - description: 'The unique ID for this attachment.' + description: '_t__SignatureRequestResponseAttachment::ID' type: string signer: - description: 'The Signer this attachment is assigned to.' + description: '_t__SignatureRequestResponseAttachment::SIGNER' type: string x-int-or-string: true name: - description: 'The name of this attachment.' + description: '_t__SignatureRequestResponseAttachment::NAME' type: string required: - description: 'A boolean value denoting if this attachment is required.' + description: '_t__SignatureRequestResponseAttachment::REQUIRED' type: boolean instructions: - description: 'Instructions for Signer.' + description: '_t__SignatureRequestResponseAttachment::INSTRUCTIONS' type: string nullable: true uploaded_at: - description: 'Timestamp when attachment was uploaded by Signer.' + description: '_t__SignatureRequestResponseAttachment::UPLOADED_AT' type: integer nullable: true type: object x-internal-class: true SignatureRequestResponseCustomFieldBase: - description: |- - An array of Custom Field objects containing the name and type of each custom field. - - * Text Field uses `SignatureRequestResponseCustomFieldText` - * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + description: '_t__SignatureRequestResponseCustomField::DESCRIPTION' required: - name - type properties: type: - description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' + description: '_t__SignatureRequestResponseCustomField::TYPE' type: string name: - description: 'The name of the Custom Field.' + description: '_t__SignatureRequestResponseCustomField::NAME' type: string required: - description: 'A boolean value denoting if this field is required.' + description: '_t__SignatureRequestResponseCustomField::REQUIRED' type: boolean api_id: - description: 'The unique ID for this field.' + description: '_t__SignatureRequestResponseCustomField::API_ID' type: string editor: - description: 'The name of the Role that is able to edit this field.' + description: '_t__SignatureRequestResponseCustomField::EDITOR' type: string nullable: true type: object @@ -12120,7 +12049,7 @@ components: x-internal-class: true x-base-class: true SignatureRequestResponseCustomFieldCheckbox: - description: 'This class extends `SignatureRequestResponseCustomFieldBase`.' + description: '_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12129,15 +12058,15 @@ components: - properties: type: - description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' + description: '_t__SignatureRequestResponseCustomField::TYPE' type: string default: checkbox value: - description: 'A true/false for checkbox fields' + description: '_t__SignatureRequestResponseCustomField::VALUE_CHECKBOX' type: boolean type: object SignatureRequestResponseCustomFieldText: - description: 'This class extends `SignatureRequestResponseCustomFieldBase`.' + description: '_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12146,11 +12075,11 @@ components: - properties: type: - description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' + description: '_t__SignatureRequestResponseCustomField::TYPE' type: string default: text value: - description: 'A text string for text fields' + description: '_t__SignatureRequestResponseCustomField::VALUE_TEXT' type: string type: object SignatureRequestResponseCustomFieldTypeEnum: @@ -12159,19 +12088,19 @@ components: - text - checkbox SignatureRequestResponseDataBase: - description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.' + description: '_t__SignatureRequestResponseData::DESCRIPTION' properties: api_id: - description: 'The unique ID for this field.' + description: '_t__SignatureRequestResponseData::API_ID' type: string signature_id: - description: 'The ID of the signature to which this response is linked.' + description: '_t__SignatureRequestResponseData::SIGNATURE_ID' type: string name: - description: 'The name of the form field.' + description: '_t__SignatureRequestResponseData::NAME' type: string required: - description: 'A boolean value denoting if this field is required.' + description: '_t__SignatureRequestResponseData::REQUIRED' type: boolean type: type: string @@ -12209,11 +12138,11 @@ components: - properties: type: - description: 'A yes/no checkbox' + description: '_t__SignatureRequestResponseDataValue::CHECKBOX_TYPE' type: string default: checkbox value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: boolean type: object SignatureRequestResponseDataValueCheckboxMerge: @@ -12223,11 +12152,11 @@ components: - properties: type: - description: 'A checkbox field that has default value set by the api' + description: '_t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE' type: string default: checkbox-merge value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueDateSigned: @@ -12237,11 +12166,11 @@ components: - properties: type: - description: 'A date' + description: '_t__SignatureRequestResponseDataValue::DATESIGNED_TYPE' type: string default: date_signed value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueDropdown: @@ -12251,11 +12180,11 @@ components: - properties: type: - description: 'An input field for dropdowns' + description: '_t__SignatureRequestResponseDataValue::DROPDOWN_TYPE' type: string default: dropdown value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueInitials: @@ -12265,14 +12194,14 @@ components: - properties: type: - description: 'An input field for initials' + description: '_t__SignatureRequestResponseDataValue::INITIAL_TYPE' type: string default: initials value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string is_signed: - description: 'This field contains the boolean true if the field is signed.' + description: '_t__SignatureRequestResponseDataValue::IS_SIGNED' type: boolean nullable: true type: object @@ -12283,11 +12212,11 @@ components: - properties: type: - description: 'An input field for radios' + description: '_t__SignatureRequestResponseDataValue::RADIO_TYPE' type: string default: radio value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: boolean type: object SignatureRequestResponseDataValueSignature: @@ -12297,14 +12226,14 @@ components: - properties: type: - description: 'A signature input field' + description: '_t__SignatureRequestResponseDataValue::SIGNATURE_TYPE' type: string default: signature value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string is_signed: - description: 'This field contains the boolean true if the field is signed.' + description: '_t__SignatureRequestResponseDataValue::IS_SIGNED' type: boolean nullable: true type: object @@ -12315,11 +12244,11 @@ components: - properties: type: - description: 'A text input field' + description: '_t__SignatureRequestResponseDataValue::TEXT_TYPE' type: string default: text value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseDataValueTextMerge: @@ -12329,107 +12258,107 @@ components: - properties: type: - description: 'A text field that has default text set by the api' + description: '_t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE' type: string default: text-merge value: - description: 'The value of the form field.' + description: '_t__SignatureRequestResponseDataValue::VALUE' type: string type: object SignatureRequestResponseSignatures: - description: 'An array of signature objects, 1 for each signer.' + description: '_t__SignatureRequestResponseSignatures::DESCRIPTION' properties: signature_id: - description: 'Signature identifier.' + description: '_t__SignatureRequestResponseSignatures::SIGNATURE_ID' type: string signer_group_guid: - description: 'Signer Group GUID' + description: '_t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID' type: string nullable: true signer_email_address: - description: 'The email address of the signer.' + description: '_t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS' type: string signer_name: - description: 'The name of the signer.' + description: '_t__SignatureRequestResponseSignatures::SIGNER_NAME' type: string nullable: true signer_role: - description: 'The role of the signer.' + description: '_t__SignatureRequestResponseSignatures::SIGNER_ROLE' type: string nullable: true order: - description: 'If signer order is assigned this is the 0-based index for this signer.' + description: '_t__SignatureRequestResponseSignatures::ORDER' type: integer nullable: true status_code: - description: 'The current status of the signature. eg: awaiting_signature, signed, declined.' + description: '_t__SignatureRequestResponseSignatures::STATUS_CODE' type: string decline_reason: - description: 'The reason provided by the signer for declining the request.' + description: '_t__SignatureRequestResponseSignatures::DECLINE_REASON' type: string nullable: true signed_at: - description: 'Time that the document was signed or null.' + description: '_t__SignatureRequestResponseSignatures::SIGNED_AT' type: integer nullable: true last_viewed_at: - description: 'The time that the document was last viewed by this signer or null.' + description: '_t__SignatureRequestResponseSignatures::LAST_VIEWED_AT' type: integer nullable: true last_reminded_at: - description: 'The time the last reminder email was sent to the signer or null.' + description: '_t__SignatureRequestResponseSignatures::LAST_REMINDED_AT' type: integer nullable: true has_pin: - description: 'Boolean to indicate whether this signature requires a PIN to access.' + description: '_t__SignatureRequestResponseSignatures::HAS_PIN' type: boolean has_sms_auth: - description: 'Boolean to indicate whether this signature has SMS authentication enabled.' + description: '_t__SignatureRequestResponseSignatures::HAS_SMS_AUTH' type: boolean nullable: true has_sms_delivery: - description: 'Boolean to indicate whether this signature has SMS delivery enabled.' + description: '_t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY' type: boolean nullable: true sms_phone_number: - description: 'The SMS phone number used for authentication or signature request delivery.' + description: '_t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER' type: string nullable: true reassigned_by: - description: 'Email address of original signer who reassigned to this signer.' + description: '_t__SignatureRequestResponseSignatures::REASSIGNED_BY' type: string nullable: true reassignment_reason: - description: 'Reason provided by original signer who reassigned to this signer.' + description: '_t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON' type: string nullable: true reassigned_from: - description: 'Previous signature identifier.' + description: '_t__SignatureRequestResponseSignatures::REASSIGNED_FROM' type: string nullable: true error: - description: 'Error message pertaining to this signer, or null.' + description: '_t__SignatureRequestResponseSignatures::ERROR' type: string nullable: true type: object x-internal-class: true TeamResponse: - description: 'Contains information about your team and its members' + description: '_t__TeamResponse::DESCRIPTION' properties: name: - description: 'The name of your Team' + description: '_t__Team::NAME' type: string accounts: type: array items: $ref: '#/components/schemas/AccountResponse' invited_accounts: - description: '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`.' + description: '_t__Team::INVITED_ACCOUNTS' type: array items: $ref: '#/components/schemas/AccountResponse' invited_emails: - description: 'A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.' + description: '_t__Team::INVITED_EMAILS' type: array items: type: string @@ -12438,18 +12367,18 @@ components: TeamInfoResponse: properties: team_id: - description: 'The id of a team' + description: '_t__TeamGeneral::TEAM_ID' type: string team_parent: $ref: '#/components/schemas/TeamParentResponse' name: - description: 'The name of a team' + description: '_t__TeamGeneral::NAME' type: string num_members: - description: 'Number of members within a team' + description: '_t__TeamGeneral::NUM_MEMBERS' type: integer num_sub_teams: - description: 'Number of sub teams within a team' + description: '_t__TeamGeneral::NUM_SUB_TEAMS' type: integer type: object x-internal-class: true @@ -12492,10 +12421,10 @@ components: description: 'Information about the parent team if a team has one, set to `null` otherwise.' properties: team_id: - description: 'The id of a team' + description: '_t__TeamGeneral::TEAM_ID' type: string name: - description: 'The name of a team' + description: '_t__TeamGeneral::NAME' type: string type: object nullable: true @@ -12503,84 +12432,81 @@ components: SubTeamResponse: properties: team_id: - description: 'The id of a team' + description: '_t__TeamGeneral::TEAM_ID' type: string name: - description: 'The name of a team' + description: '_t__TeamGeneral::NAME' type: string type: object x-internal-class: true TemplateResponse: - description: 'Contains information about the templates you and your team have created.' + description: '_t__TemplateResponse::DESCRIPTION' properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string title: - description: 'The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.' + description: '_t__TemplateResponse::TITLE' type: string message: - description: 'The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.' + description: '_t__TemplateResponse::MESSAGE' type: string updated_at: - description: 'Time the template was last updated.' + description: '_t__TemplateResponse::UPDATED_AT' type: integer is_embedded: - description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.' + description: '_t__TemplateResponse::IS_EMBEDDED' type: boolean nullable: true is_creator: - description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.' + description: '_t__TemplateResponse::IS_CREATOR' type: boolean can_edit: - description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).' + description: '_t__TemplateResponse::CAN_EDIT' type: boolean is_locked: - description: |- - Indicates whether the template is locked. - If `true`, then the template was created outside your quota and can only be used in `test_mode`. - If `false`, then the template is within your quota and can be used to create signature requests. + description: '_t__TemplateResponse::IS_LOCKED' type: boolean metadata: - description: 'The metadata attached to the template.' + description: '_t__TemplateResponse::METADATA' type: object additionalProperties: {} signer_roles: - description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.' + description: '_t__TemplateResponse::SIGNER_ROLES' type: array items: $ref: '#/components/schemas/TemplateResponseSignerRole' cc_roles: - description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' + description: '_t__TemplateResponse::CC_ROLES' type: array items: $ref: '#/components/schemas/TemplateResponseCCRole' documents: - description: 'An array describing each document associated with this Template. Includes form field data for each document.' + description: '_t__TemplateResponse::DOCUMENTS' type: array items: $ref: '#/components/schemas/TemplateResponseDocument' custom_fields: - description: 'Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.' + description: '_t__TemplateResponseCustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' nullable: true deprecated: true named_form_fields: - description: 'Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.' + description: '_t__TemplateResponseNamedFormField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' nullable: true deprecated: true accounts: - description: 'An array of the Accounts that can use this Template.' + description: '_t__TemplateResponse::ACCOUNTS' type: array items: $ref: '#/components/schemas/TemplateResponseAccount' attachments: - description: 'Signer attachments.' + description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' type: array items: $ref: '#/components/schemas/SignatureRequestResponseAttachment' @@ -12589,62 +12515,62 @@ components: TemplateResponseAccount: properties: account_id: - description: 'The id of the Account.' + description: '_t__TemplateResponseAccount::ACCOUNT_ID' type: string email_address: - description: 'The email address associated with the Account.' + description: '_t__TemplateResponseAccount::EMAIL_ADDRESS' type: string is_locked: - description: 'Returns `true` if the user has been locked out of their account by a team admin.' + description: '_t__TemplateResponseAccount::IS_LOCKED' type: boolean is_paid_hs: - description: 'Returns `true` if the user has a paid Dropbox Sign account.' + description: '_t__TemplateResponseAccount::IS_PAID_HS' type: boolean is_paid_hf: - description: 'Returns `true` if the user has a paid HelloFax account.' + description: '_t__TemplateResponseAccount::IS_PAID_HF' type: boolean quotas: $ref: '#/components/schemas/TemplateResponseAccountQuota' type: object x-internal-class: true TemplateResponseAccountQuota: - description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' + description: '_t__TemplateResponseAccountQuota::DESCRIPTION' properties: templates_left: - description: 'API templates remaining.' + description: '_t__TemplateResponseAccountQuota::TEMPLATES_LEFT' type: integer api_signature_requests_left: - description: 'API signature requests remaining.' + description: '_t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT' type: integer documents_left: - description: 'Signature requests remaining.' + description: '_t__TemplateResponseAccountQuota::DOCUMENTS_LEFT' type: integer sms_verifications_left: - description: 'SMS verifications remaining.' + description: '_t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT' type: integer type: object x-internal-class: true TemplateResponseCCRole: properties: name: - description: 'The name of the Role.' + description: '_t__TemplateResponseCCRole::NAME' type: string type: object x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: - description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' + description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION' properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string edit_url: - description: 'Link to edit the template.' + description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL' type: string expires_at: - description: 'When the link expires.' + description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT' type: integer warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -12652,78 +12578,78 @@ components: type: object x-internal-class: true TemplateCreateResponseTemplate: - description: 'Template object with parameters: `template_id`.' + description: '_t__TemplateCreateResponseTemplate::DESCRIPTION' properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string type: object x-internal-class: true TemplateResponseDocument: properties: name: - description: 'Name of the associated file.' + description: '_t__TemplateResponseDocument::NAME' type: string index: - description: 'Document ordering, the lowest index is displayed first and the highest last (0-based indexing).' + description: '_t__TemplateResponseDocument::INDEX' type: integer field_groups: - description: 'An array of Form Field Group objects.' + description: '_t__TemplateResponseDocument::FIELD_GROUPS' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFieldGroup' form_fields: - description: 'An array of Form Field objects containing the name and type of each named field.' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' custom_fields: - description: 'An array of Form Field objects containing the name and type of each named field.' + description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' static_fields: - description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' type: object x-internal-class: true TemplateResponseDocumentCustomFieldBase: - description: 'An array of Form Field objects containing the name and type of each named field.' + description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION' required: - type properties: api_id: - description: 'The unique ID for this field.' + description: '_t__TemplateResponseDocumentCustomField::API_ID' type: string name: - description: 'The name of the Custom Field.' + description: '_t__TemplateResponseDocumentCustomField::NAME' type: string type: type: string signer: - description: 'The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).' + description: '_t__TemplateResponseDocumentCustomField::SIGNER' type: string nullable: true x-int-or-string: true x: - description: 'The horizontal offset in pixels for this form field.' + description: '_t__TemplateResponseDocumentCustomField::X' type: integer 'y': - description: 'The vertical offset in pixels for this form field.' + description: '_t__TemplateResponseDocumentCustomField::Y' type: integer width: - description: 'The width in pixels of this form field.' + description: '_t__TemplateResponseDocumentCustomField::WIDTH' type: integer height: - description: 'The height in pixels of this form field.' + description: '_t__TemplateResponseDocumentCustomField::HEIGHT' type: integer required: - description: 'Boolean showing whether or not this field is required.' + description: '_t__TemplateResponseDocumentStaticField::REQUIRED' type: boolean group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.' + description: '_t__TemplateResponseDocumentCustomField::GROUP' type: string nullable: true type: object @@ -12735,7 +12661,7 @@ components: x-internal-class: true x-base-class: true TemplateResponseDocumentCustomFieldCheckbox: - description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' + description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12744,16 +12670,12 @@ components: - properties: type: - description: |- - The type of this Custom Field. Only `text` and `checkbox` are currently supported. - - * Text uses `TemplateResponseDocumentCustomFieldText` - * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + description: '_t__TemplateResponseDocumentCustomField::TYPE' type: string default: checkbox type: object TemplateResponseDocumentCustomFieldText: - description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' + description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12762,81 +12684,72 @@ components: - properties: type: - description: |- - The type of this Custom Field. Only `text` and `checkbox` are currently supported. - - * Text uses `TemplateResponseDocumentCustomFieldText` - * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + description: '_t__TemplateResponseDocumentCustomField::TYPE' type: string default: text avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: - description: 'Whether this form field is multiline text.' + description: '_t__TemplateResponseDocumentCustomField::IS_MULTILINE' type: boolean originalFontSize: - description: 'Original font size used in this form field''s text.' + description: '_t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE' type: integer fontFamily: - description: 'Font family used in this form field''s text.' + description: '_t__TemplateResponseDocumentCustomField::FONT_FAMILY' type: string type: object TemplateResponseDocumentFieldGroup: properties: name: - description: 'The name of the form field group.' + description: '_t__TemplateResponseDocumentFieldGroup::NAME' type: string rule: $ref: '#/components/schemas/TemplateResponseDocumentFieldGroupRule' type: object x-internal-class: true TemplateResponseDocumentFieldGroupRule: - description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' + description: '_t__TemplateResponseDocumentFieldGroup::RULE' properties: requirement: - description: |- - 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. + description: '_t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT' type: string groupLabel: - description: 'Name of the group' + description: '_t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL' type: string type: object x-internal-class: true TemplateResponseDocumentFormFieldBase: - description: 'An array of Form Field objects containing the name and type of each named field.' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION' required: - type properties: api_id: - description: 'A unique id for the form field.' + description: '_t__TemplateResponseDocumentFormField::API_ID' type: string name: - description: 'The name of the form field.' + description: '_t__TemplateResponseDocumentFormField::NAME' type: string type: type: string signer: - description: 'The signer of the Form Field.' + description: '_t__TemplateResponseDocumentFormField::SIGNER' type: string x-int-or-string: true x: - description: 'The horizontal offset in pixels for this form field.' + description: '_t__TemplateResponseDocumentFormField::X' type: integer 'y': - description: 'The vertical offset in pixels for this form field.' + description: '_t__TemplateResponseDocumentFormField::Y' type: integer width: - description: 'The width in pixels of this form field.' + description: '_t__TemplateResponseDocumentFormField::WIDTH' type: integer height: - description: 'The height in pixels of this form field.' + description: '_t__TemplateResponseDocumentFormField::HEIGHT' type: integer required: - description: 'Boolean showing whether or not this field is required.' + description: '_t__TemplateResponseDocumentFormField::REQUIRED' type: boolean type: object discriminator: @@ -12853,7 +12766,7 @@ components: x-internal-class: true x-base-class: true TemplateResponseDocumentFormFieldCheckbox: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12862,26 +12775,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: checkbox group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldDateSigned: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12890,26 +12793,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: date_signed group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldDropdown: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12918,26 +12811,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: dropdown group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldHyperlink: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12946,37 +12829,27 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: hyperlink avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: - description: 'Whether this form field is multiline text.' + description: '_t__TemplateResponseDocumentFormField::IS_MULTILINE' type: boolean originalFontSize: - description: 'Original font size used in this form field''s text.' + description: '_t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE' type: integer fontFamily: - description: 'Font family used in this form field''s text.' + description: '_t__TemplateResponseDocumentFormField::FONT_FAMILY' type: string group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldInitials: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -12985,26 +12858,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: initials group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldRadio: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type - group @@ -13014,25 +12877,15 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: radio group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string type: object TemplateResponseDocumentFormFieldSignature: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13041,26 +12894,16 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: signature group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentFormFieldText: - description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13069,32 +12912,22 @@ components: - properties: type: - description: |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: text avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: - description: 'Whether this form field is multiline text.' + description: '_t__TemplateResponseDocumentFormField::IS_MULTILINE' type: boolean originalFontSize: - description: 'Original font size used in this form field''s text.' + description: '_t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE' type: integer fontFamily: - description: 'Font family used in this form field''s text.' + description: '_t__TemplateResponseDocumentFormField::FONT_FAMILY' type: string validation_type: - description: 'Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.' + description: '_t__TemplateResponseDocumentFormField::VALIDATION_TYPE' type: string enum: - numbers_only @@ -13109,52 +12942,52 @@ components: - custom_regex nullable: true validation_custom_regex: - description: 'When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.' + description: '_t__TemplateResponseDocumentFormField::CUSTOM_REGEX' type: string nullable: true validation_custom_regex_format_label: - description: 'When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.' + description: '_t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL' type: string nullable: true group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + description: '_t__TemplateResponseDocumentFormField::GROUP' type: string nullable: true type: object TemplateResponseDocumentStaticFieldBase: - description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION' required: - type properties: api_id: - description: 'A unique id for the static field.' + description: '_t__TemplateResponseDocumentStaticField::API_ID' type: string name: - description: 'The name of the static field.' + description: '_t__TemplateResponseDocumentStaticField::NAME' type: string type: type: string signer: - description: 'The signer of the Static Field.' + description: '_t__TemplateResponseDocumentStaticField::SIGNER' type: string default: me_now x: - description: 'The horizontal offset in pixels for this static field.' + description: '_t__TemplateResponseDocumentStaticField::X' type: integer 'y': - description: 'The vertical offset in pixels for this static field.' + description: '_t__TemplateResponseDocumentStaticField::Y' type: integer width: - description: 'The width in pixels of this static field.' + description: '_t__TemplateResponseDocumentStaticField::WIDTH' type: integer height: - description: 'The height in pixels of this static field.' + description: '_t__TemplateResponseDocumentStaticField::HEIGHT' type: integer required: - description: 'Boolean showing whether or not this field is required.' + description: '_t__TemplateResponseDocumentStaticField::REQUIRED' type: boolean group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.' + description: '_t__TemplateResponseDocumentStaticField::GROUP' type: string nullable: true type: object @@ -13172,7 +13005,7 @@ components: x-internal-class: true x-base-class: true TemplateResponseDocumentStaticFieldCheckbox: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13181,22 +13014,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: checkbox type: object TemplateResponseDocumentStaticFieldDateSigned: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13205,22 +13028,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: date_signed type: object TemplateResponseDocumentStaticFieldDropdown: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13229,22 +13042,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: dropdown type: object TemplateResponseDocumentStaticFieldHyperlink: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13253,22 +13056,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: hyperlink type: object TemplateResponseDocumentStaticFieldInitials: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13277,22 +13070,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: initials type: object TemplateResponseDocumentStaticFieldRadio: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13301,22 +13084,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: radio type: object TemplateResponseDocumentStaticFieldSignature: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13325,22 +13098,12 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: signature type: object TemplateResponseDocumentStaticFieldText: - description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' + description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS' required: - type allOf: @@ -13349,49 +13112,39 @@ components: - properties: type: - description: |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + description: '_t__TemplateResponseDocumentStaticField::TYPE' type: string default: text type: object TemplateResponseFieldAvgTextLength: - description: 'Average text length in this field.' + description: '_t__TemplateResponseFieldAvgTextLength::DESCRIPTION' properties: num_lines: - description: 'Number of lines.' + description: '_t__TemplateResponseFieldAvgTextLength::NUM_LINES' type: integer num_chars_per_line: - description: 'Number of characters per line.' + description: '_t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE' type: integer type: object x-internal-class: true TemplateResponseSignerRole: properties: name: - description: 'The name of the Role.' + description: '_t__TemplateResponseSignerRole::NAME' type: string order: - description: 'If signer order is assigned this is the 0-based index for this role.' + description: '_t__TemplateResponseSignerRole::ORDER' type: integer type: object x-internal-class: true TemplateUpdateFilesResponseTemplate: - description: 'Contains template id' + description: '_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION' properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13399,43 +13152,43 @@ components: type: object x-internal-class: true UnclaimedDraftResponse: - description: 'A group of documents that a user can take ownership of via the claim URL.' + description: '_t__UnclaimedDraftResponse::DESCRIPTION' properties: signature_request_id: - description: 'The ID of the signature request that is represented by this UnclaimedDraft.' + description: '_t__UnclaimedDraft::SIGNATURE_REQUEST_ID' type: string nullable: true claim_url: - description: 'The URL to be used to claim this UnclaimedDraft.' + description: '_t__UnclaimedDraft::CLAIM_URL' type: string signing_redirect_url: - description: 'The URL you want signers redirected to after they successfully sign.' + description: '_t__UnclaimedDraft::SIGNING_REDIRECT_URL' type: string nullable: true requesting_redirect_url: - description: 'The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).' + description: '_t__UnclaimedDraft::REQUESTING_REDIRECT_URL' type: string nullable: true expires_at: - description: 'When the link expires.' + description: '_t__UnclaimedDraft::EXPIRES_AT' type: integer nullable: true test_mode: - description: 'Whether this is a test draft. Signature requests made from test drafts have no legal value.' + description: '_t__UnclaimedDraft::TEST_MODE' type: boolean type: object x-internal-class: true WarningResponse: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' required: - warning_msg - warning_name properties: warning_msg: - description: 'Warning message' + description: '_t__WarningResponse::WARNING_MSG' type: string warning_name: - description: 'Warning name' + description: '_t__WarningResponse::WARNING_NAME' type: string type: object TeamGetResponse: @@ -13445,7 +13198,7 @@ components: team: $ref: '#/components/schemas/TeamResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13458,7 +13211,7 @@ components: team: $ref: '#/components/schemas/TeamInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13522,7 +13275,7 @@ components: template: $ref: '#/components/schemas/TemplateCreateResponseTemplate' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13535,7 +13288,7 @@ components: template: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13546,7 +13299,7 @@ components: - template_id properties: template_id: - description: 'The id of the Template.' + description: '_t__TemplateResponse::TEMPLATE_ID' type: string type: object TemplateGetResponse: @@ -13556,7 +13309,7 @@ components: template: $ref: '#/components/schemas/TemplateResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13568,14 +13321,14 @@ components: - list_info properties: templates: - description: 'List of templates that the API caller has access to.' + description: '_t__TemplateListResponse::DESCRIPTION' type: array items: $ref: '#/components/schemas/TemplateResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13596,7 +13349,7 @@ components: unclaimed_draft: $ref: '#/components/schemas/UnclaimedDraftResponse' warnings: - description: 'A list of warnings.' + description: '_t__WarningResponse::LIST_DESCRIPTION' type: array items: $ref: '#/components/schemas/WarningResponse' @@ -13617,17 +13370,17 @@ components: $ref: '#/components/schemas/TemplateResponse' type: object EventCallbackRequestEvent: - description: 'Basic information about the event that occurred.' + description: '_t__EventCallbackRequestEvent::DESCRIPTION' required: - event_time - event_type - event_hash properties: event_time: - description: 'Time the event was created (using Unix time).' + description: '_t__EventCallbackRequestEvent::EVENT_TIME' type: string event_type: - description: 'Type of callback event that was triggered.' + description: '_t__EventCallbackRequestEvent::EVENT_TYPE' type: string enum: - account_confirmed @@ -13654,28 +13407,28 @@ components: - callback_test - signature_request_signer_removed event_hash: - description: 'Generated hash used to verify source of event data.' + description: '_t__EventCallbackRequestEvent::EVENT_HASH' type: string event_metadata: $ref: '#/components/schemas/EventCallbackRequestEventMetadata' type: object EventCallbackRequestEventMetadata: - description: 'Specific metadata about the event.' + description: '_t__EventCallbackRequestEventMetadata::DESCRIPTION' properties: related_signature_id: - description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.' + description: '_t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID' type: string nullable: true reported_for_account_id: - description: 'Account ID the event was reported for.' + description: '_t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID' type: string nullable: true reported_for_app_id: - description: 'App ID the event was reported for.' + description: '_t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID' type: string nullable: true event_message: - description: 'Message about a declined or failed (due to error) signature flow.' + description: '_t__EventCallbackRequestEventMetadata::EVENT_MESSAGE' type: string nullable: true type: object @@ -13921,87 +13674,87 @@ components: value: $ref: examples/json/UnclaimedDraftEditAndResendRequest.json AccountCreateResponse: - summary: 'Account Create' + summary: '_t__AccountCreateResponseExample::SUMMARY' value: $ref: examples/json/AccountCreateResponse.json AccountCreateOAuthResponse: - summary: 'Account Create with OAuth Authorization' + summary: '_t__AccountCreateOAuthResponseExample::SUMMARY' value: $ref: examples/json/AccountCreateOAuthResponse.json AccountGetResponse: - summary: 'Account Get' + summary: '_t__AccountGetResponseExample::SUMMARY' value: $ref: examples/json/AccountGetResponse.json AccountVerifyFoundResponse: - summary: 'Account Found' + summary: '_t__AccountVerifyFoundResponseExample::SUMMARY' value: $ref: examples/json/AccountVerifyFoundResponse.json AccountVerifyNotFoundResponse: - summary: 'Account Not Found' + summary: '_t__AccountVerifyNotFoundResponseExample::SUMMARY' value: $ref: examples/json/AccountVerifyNotFoundResponse.json ApiAppGetResponse: - summary: 'API App' + summary: '_t__ApiAppGetResponseExample::SUMMARY' value: $ref: examples/json/ApiAppGetResponse.json ApiAppListResponse: - summary: 'API App List' + summary: '_t__ApiAppListResponseExample::SUMMARY' value: $ref: examples/json/ApiAppListResponse.json BulkSendJobGetResponse: - summary: 'Bulk Send Job' + summary: '_t__BulkSendJobGetResponseExample::SUMMARY' value: $ref: examples/json/BulkSendJobGetResponse.json BulkSendJobListResponse: - summary: 'Bulk Send Job List' + summary: '_t__BulkSendJobListResponseExample::SUMMARY' value: $ref: examples/json/BulkSendJobListResponse.json EmbeddedEditUrlResponse: - summary: 'Embedded Edit URL' + summary: '_t__EmbeddedEditUrlResponseExample::SUMMARY' value: $ref: examples/json/EmbeddedEditUrlResponse.json EmbeddedSignUrlResponse: - summary: 'Embedded Sign URL' + summary: '_t__EmbeddedSignUrlResponseExample::SUMMARY' value: $ref: examples/json/EmbeddedSignUrlResponse.json Error400Response: - summary: 'Error 400 bad_request' + summary: '_t__Error::400' value: $ref: examples/json/Error400Response.json Error401Response: - summary: 'Error 401 unauthorized' + summary: '_t__Error::401' value: $ref: examples/json/Error401Response.json Error402Response: - summary: 'Error 402 payment_required' + summary: '_t__Error::402' value: $ref: examples/json/Error402Response.json Error403Response: - summary: 'Error 403 forbidden' + summary: '_t__Error::403' value: $ref: examples/json/Error403Response.json Error404Response: - summary: 'Error 404 not_found' + summary: '_t__Error::404' value: $ref: examples/json/Error404Response.json Error409Response: - summary: 'Error 409 conflict' + summary: '_t__Error::409' value: $ref: examples/json/Error409Response.json Error410Response: - summary: 'Error 410 deleted' + summary: '_t__Error::410' value: $ref: examples/json/Error410Response.json Error422Response: - summary: 'Error 422 unprocessable_entity' + summary: '_t__Error::422' value: $ref: examples/json/Error422Response.json Error429Response: - summary: 'Error 429 exceeded_rate' + summary: '_t__Error::429' value: $ref: examples/json/Error429Response.json Error4XXResponse: - summary: 'Error 4XX failed_operation' + summary: '_t__Error::4XX' value: $ref: examples/json/Error4XXResponse.json FaxGetResponse: @@ -14025,190 +13778,188 @@ components: value: $ref: examples/json/FaxListResponse.json ReportCreateResponse: - summary: Report + summary: '_t__ReportCreateResponseExample::SUMMARY' value: $ref: examples/json/ReportCreateResponse.json SignatureRequestGetResponse: - summary: 'Get Signature Request' + summary: '_t__SignatureRequestGetResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestGetResponse.json SignatureRequestListResponse: - summary: 'List Signature Requests' + summary: '_t__SignatureRequestListResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestListResponse.json AccountUpdateResponse: - summary: 'Account Update' + summary: '_t__AccountUpdateResponseExample::SUMMARY' value: $ref: examples/json/AccountUpdateResponse.json OAuthTokenGenerateResponse: - summary: 'Retrieving the OAuth token' + summary: '_t__OAuthTokenGenerateResponseExample::SUMMARY' value: $ref: examples/json/OAuthTokenGenerateResponse.json OAuthTokenRefreshResponse: - summary: 'Refresh an existing OAuth token' + summary: '_t__OAuthTokenRefreshResponseExample::SUMMARY' value: $ref: examples/json/OAuthTokenRefreshResponse.json ApiAppCreateResponse: - summary: 'API App' + summary: '_t__ApiAppCreateResponseExample::SUMMARY' value: $ref: examples/json/ApiAppCreateResponse.json ApiAppUpdateResponse: - summary: 'API App Update' + summary: '_t__ApiAppUpdateResponseExample::SUMMARY' value: $ref: examples/json/ApiAppUpdateResponse.json SignatureRequestCreateEmbeddedResponse: - summary: 'Create Embedded Signature Request' + summary: '_t__SignatureRequestCreateEmbeddedResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json SignatureRequestCreateEmbeddedWithTemplateResponse: - summary: 'Create Embedded Signature Request With Template' + summary: '_t__SignatureRequestCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json SignatureRequestFilesResponse: - summary: 'Signature Requests Files' + summary: '_t__SignatureRequestFilesResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestFilesResponse.json SignatureRequestReleaseHoldResponse: - summary: 'Send Signature Release Hold' + summary: '_t__SignatureRequestReleaseHoldResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestReleaseHoldResponse.json SignatureRequestRemindResponse: - summary: 'Send Signature Request Reminder' + summary: '_t__SignatureRequestRemindResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestRemindResponse.json SignatureRequestSendResponse: - summary: 'Send Signature Request' + summary: '_t__SignatureRequestSendResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestSendResponse.json SignatureRequestSendWithTemplateResponse: - summary: 'Send Signature Request With Template' + summary: '_t__SignatureRequestSendWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestSendWithTemplateResponse.json SignatureRequestUpdateResponse: - summary: 'Signature Request Update' + summary: '_t__SignatureRequestUpdateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestUpdateResponse.json SignatureRequestBulkSendWithTemplateResponse: - summary: 'Send Signature Request With Template' + summary: '_t__SignatureRequestBulkSendWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json SignatureRequestBulkCreateEmbeddedWithTemplateResponse: - summary: 'Bulk Send Create Embedded Signature Request With Template' + summary: '_t__SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json TeamCreateResponse: - summary: 'Team Create' + summary: '_t__TeamCreateResponseExample::SUMMARY' value: $ref: examples/json/TeamCreateResponse.json TeamMembersResponse: - summary: 'Team Members List' + summary: '_t__TeamMembersResponseExample::SUMMARY' value: $ref: examples/json/TeamMembersResponse.json TeamRemoveMemberResponse: - summary: 'Team Remove Member' + summary: '_t__TeamRemoveMemberResponseExample::SUMMARY' value: $ref: examples/json/TeamRemoveMemberResponse.json TeamUpdateResponse: - summary: 'Team Update' + summary: '_t__TeamUpdateResponseExample::SUMMARY' value: $ref: examples/json/TeamUpdateResponse.json TeamDoesNotExistResponse: - summary: 'Team Does Not Exist' + summary: '_t__TeamDoesNotExistResponseExample::SUMMARY' value: $ref: examples/json/TeamDoesNotExistResponse.json TemplateAddUserResponse: - summary: 'Add User to Template' + summary: '_t__TemplateAddUserResponseExample::SUMMARY' value: $ref: examples/json/TemplateAddUserResponse.json TemplateFilesResponse: - summary: 'Template Files' + summary: '_t__TemplateFilesResponseExample::SUMMARY' value: $ref: examples/json/TemplateFilesResponse.json TemplateRemoveUserResponse: - summary: 'Remove User from Template' + summary: '_t__TemplateRemoveUserResponseExample::SUMMARY' value: $ref: examples/json/TemplateRemoveUserResponse.json UnclaimedDraftCreateEmbeddedResponse: - summary: 'Unclaimed Draft Create Embedded' + summary: '_t__UnclaimedDraftCreateEmbeddedResponseExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json UnclaimedDraftCreateEmbeddedWithTemplateResponse: - summary: 'Unclaimed Draft Create Embedded With Template' + summary: '_t__UnclaimedDraftCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json UnclaimedDraftEditAndResend: - summary: 'Unclaimed Draft Edit and Resend' + summary: '_t__UnclaimedDraftEditAndResendExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftEditAndResend.json TeamGetResponse: - summary: 'Team Get' + summary: '_t__TeamGetResponseExample::SUMMARY' value: $ref: examples/json/TeamGetResponse.json TeamGetInfoResponse: - summary: 'Team Get Info' + summary: '_t__TeamInfoResponseExample::SUMMARY' value: $ref: examples/json/TeamGetInfoResponse.json TeamInvitesResponse: - summary: 'Team Invites' + summary: '_t__TeamInvitesResponseExample::SUMMARY' value: $ref: examples/json/TeamInvitesResponse.json TeamAddMemberResponse: - summary: 'Team Add Member' + summary: '_t__TeamAddMemberResponseExample::SUMMARY' value: $ref: examples/json/TeamAddMemberResponse.json TeamSubTeamsResponse: - summary: 'Team Sub Teams List' + summary: '_t__TeamSubTeamsResponseExample::SUMMARY' value: $ref: examples/json/TeamSubTeamsResponse.json TemplateCreateResponse: - summary: 'Create Template' + summary: '_t__TemplateCreateResponseExample::SUMMARY' value: $ref: examples/json/TemplateCreateResponse.json TemplateCreateEmbeddedDraftResponse: - summary: 'Create Embedded Draft Template' + summary: '_t__TemplateCreateEmbeddedDraftResponseExample::SUMMARY' value: $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json TemplateGetResponse: - summary: 'Get Template' + summary: '_t__TemplateGetResponseExample::SUMMARY' value: $ref: examples/json/TemplateGetResponse.json TemplateListResponse: - summary: 'List Templates' + summary: '_t__TemplateListResponseExample::SUMMARY' value: $ref: examples/json/TemplateListResponse.json TemplateUpdateFilesResponse: - summary: 'Update Template Files' + summary: '_t__TemplateUpdateFilesResponseExample::SUMMARY' value: $ref: examples/json/TemplateUpdateFilesResponse.json UnclaimedDraftCreateResponse: - summary: 'Unclaimed Draft Create' + summary: '_t__UnclaimedDraftCreateResponseExample::SUMMARY' value: $ref: examples/json/UnclaimedDraftCreateResponse.json EventCallbackAccountSignatureRequestSent: - summary: 'Example: signature_request_sent' + summary: '_t__EventCallbackAccountSignatureRequestSentExample::SUMMARY' value: $ref: examples/json/EventCallbackAccountSignatureRequestSent.json EventCallbackAccountTemplateCreated: - summary: 'Example: template_created' + summary: '_t__EventCallbackAccountTemplateCreatedExample::SUMMARY' value: $ref: examples/json/EventCallbackAccountTemplateCreated.json EventCallbackAppAccountConfirmed: - summary: 'Example: account_confirmed' + summary: '_t__EventCallbackAppAccountConfirmedExample::SUMMARY' value: $ref: examples/json/EventCallbackAppAccountConfirmed.json EventCallbackAppSignatureRequestSent: - summary: 'Example: signature_request_sent' + summary: '_t__EventCallbackAppSignatureRequestSentExample::SUMMARY' value: $ref: examples/json/EventCallbackAppSignatureRequestSent.json EventCallbackAppTemplateCreated: - summary: 'Example: template_created' + summary: '_t__EventCallbackAppTemplateCreatedExample::SUMMARY' value: $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: - description: |- - **Account Callback Payloads --** - Events that are reported at the Account level through the the *Account callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api). The *Account callback URL* can also be updated by calling [Update Account](/api/reference/operation/accountUpdate) and passing a `callback_url`. + description: '_t__EventCallbackAccountRequest::DESCRIPTION' content: multipart/form-data: schema: @@ -14219,9 +13970,7 @@ components: template_created_example: $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: - description: |- - **API App Callback Payloads --** - Events that are reported at the API App level through the *Event callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api) for a specific app. The *Event callback URL* can also be updated by calling [Update API App](/api/reference/operation/apiAppUpdate) and passing a `callback_url`. + description: '_t__EventCallbackAppRequest::DESCRIPTION' content: multipart/form-data: schema: @@ -14235,19 +13984,19 @@ components: $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: - description: 'The maximum number of requests per hour that you can make.' + description: '_t__Common::RateLimiting::LIMIT' schema: type: integer format: int32 example: 100 X-RateLimit-Remaining: - description: 'The number of requests remaining in the current rate limit window.' + description: '_t__Common::RateLimiting::REMAINING' schema: type: integer format: int32 example: 99 X-Ratelimit-Reset: - description: 'The Unix time at which the rate limit will reset to its maximum.' + description: '_t__Common::RateLimiting::RESET' schema: type: integer format: int64 @@ -14339,8 +14088,8 @@ x-webhooks: $ref: ./markdown/en/descriptions/account-callback-description.md x-meta: seo: - title: 'Account Callbacks | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the account level, click here.' + title: '_t__accountUpdateEventCallback::SEO::TITLE' + description: '_t__accountUpdateEventCallback::SEO::DESCRIPTION' x-codeSamples: - lang: PHP @@ -14387,8 +14136,8 @@ x-webhooks: operationId: apiAppCreateEventCallback x-meta: seo: - title: 'App Callbacks | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the App level, click here.' + title: '_t__appCreateEventCallback::SEO::TITLE' + description: '_t__appCreateEventCallback::SEO::DESCRIPTION' x-codeSamples: - lang: PHP diff --git a/sdks/dotnet/docs/AccountCreateResponse.md b/sdks/dotnet/docs/AccountCreateResponse.md index b7a73e614..92c3b236d 100644 --- a/sdks/dotnet/docs/AccountCreateResponse.md +++ b/sdks/dotnet/docs/AccountCreateResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Account** | [**AccountResponse**](AccountResponse.md) | | **OauthData** | [**OAuthTokenResponse**](OAuthTokenResponse.md) | | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Account** | [**AccountResponse**](AccountResponse.md) | | **OauthData** | [**OAuthTokenResponse**](OAuthTokenResponse.md) | | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/AccountGetResponse.md b/sdks/dotnet/docs/AccountGetResponse.md index 1cca9a309..5c91808d0 100644 --- a/sdks/dotnet/docs/AccountGetResponse.md +++ b/sdks/dotnet/docs/AccountGetResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Account** | [**AccountResponse**](AccountResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Account** | [**AccountResponse**](AccountResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/AccountResponse.md b/sdks/dotnet/docs/AccountResponse.md index 2f9672466..5ca015d14 100644 --- a/sdks/dotnet/docs/AccountResponse.md +++ b/sdks/dotnet/docs/AccountResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | **string** | The ID of the Account | [optional] **EmailAddress** | **string** | The email address associated with the Account. | [optional] **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | [optional] **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | [optional] **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | [optional] **Quotas** | [**AccountResponseQuotas**](AccountResponseQuotas.md) | | [optional] **CallbackUrl** | **string** | The URL that Dropbox Sign events will `POST` to. | [optional] **RoleCode** | **string** | The membership role for the team. | [optional] **TeamId** | **string** | The id of the team account belongs to. | [optional] **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. | [optional] **Usage** | [**AccountResponseUsage**](AccountResponseUsage.md) | | [optional] +**AccountId** | **string** | _t__Account::ACCOUNT_ID | [optional] **EmailAddress** | **string** | _t__Account::EMAIL_ADDRESS | [optional] **IsLocked** | **bool** | _t__Account::IS_LOCKED | [optional] **IsPaidHs** | **bool** | _t__Account::IS_PAID_HS | [optional] **IsPaidHf** | **bool** | _t__Account::IS_PAID_HF | [optional] **Quotas** | [**AccountResponseQuotas**](AccountResponseQuotas.md) | | [optional] **CallbackUrl** | **string** | _t__Account::CALLBACK_URL | [optional] **RoleCode** | **string** | _t__Account::ROLE_CODE | [optional] **TeamId** | **string** | _t__Account::TEAM_ID | [optional] **Locale** | **string** | _t__Account::LOCALE | [optional] **Usage** | [**AccountResponseUsage**](AccountResponseUsage.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/AccountResponseQuotas.md b/sdks/dotnet/docs/AccountResponseQuotas.md index 8fc9dcf9b..847f18949 100644 --- a/sdks/dotnet/docs/AccountResponseQuotas.md +++ b/sdks/dotnet/docs/AccountResponseQuotas.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.AccountResponseQuotas -Details concerning remaining monthly quotas. +_t__Account::QUOTA ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiSignatureRequestsLeft** | **int?** | API signature requests remaining. | [optional] **DocumentsLeft** | **int?** | Signature requests remaining. | [optional] **TemplatesTotal** | **int?** | Total API templates allowed. | [optional] **TemplatesLeft** | **int?** | API templates remaining. | [optional] **SmsVerificationsLeft** | **int?** | SMS verifications remaining. | [optional] **NumFaxPagesLeft** | **int?** | Number of fax pages left | [optional] +**ApiSignatureRequestsLeft** | **int?** | _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT | [optional] **DocumentsLeft** | **int?** | _t__AccountQuota::DOCUMENTS_LEFT | [optional] **TemplatesTotal** | **int?** | _t__AccountQuota::TEMPLATES_TOTAL | [optional] **TemplatesLeft** | **int?** | _t__AccountQuota::TEMPLATES_LEFT | [optional] **SmsVerificationsLeft** | **int?** | _t__AccountQuota::SMS_VERIFICATIONS_LEFT | [optional] **NumFaxPagesLeft** | **int?** | _t__AccountQuota::NUM_FAX_PAGES_LEFT | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/AccountResponseUsage.md b/sdks/dotnet/docs/AccountResponseUsage.md index fa5536881..31206de6b 100644 --- a/sdks/dotnet/docs/AccountResponseUsage.md +++ b/sdks/dotnet/docs/AccountResponseUsage.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.AccountResponseUsage -Details concerning monthly usage +_t__Account::USAGE ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**FaxPagesSent** | **int?** | Number of fax pages sent | [optional] +**FaxPagesSent** | **int?** | _t__AccountUsage::FAX_PAGES_SENT | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/AccountVerifyResponse.md b/sdks/dotnet/docs/AccountVerifyResponse.md index 3337b0cdf..b477fb128 100644 --- a/sdks/dotnet/docs/AccountVerifyResponse.md +++ b/sdks/dotnet/docs/AccountVerifyResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Account** | [**AccountVerifyResponseAccount**](AccountVerifyResponseAccount.md) | | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Account** | [**AccountVerifyResponseAccount**](AccountVerifyResponseAccount.md) | | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/AccountVerifyResponseAccount.md b/sdks/dotnet/docs/AccountVerifyResponseAccount.md index 881f1e733..016882fe9 100644 --- a/sdks/dotnet/docs/AccountVerifyResponseAccount.md +++ b/sdks/dotnet/docs/AccountVerifyResponseAccount.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**EmailAddress** | **string** | The email address associated with the Account. | [optional] +**EmailAddress** | **string** | _t__Account::EMAIL_ADDRESS | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ApiAppGetResponse.md b/sdks/dotnet/docs/ApiAppGetResponse.md index 9677b8922..e9e45c925 100644 --- a/sdks/dotnet/docs/ApiAppGetResponse.md +++ b/sdks/dotnet/docs/ApiAppGetResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiApp** | [**ApiAppResponse**](ApiAppResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**ApiApp** | [**ApiAppResponse**](ApiAppResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ApiAppListResponse.md b/sdks/dotnet/docs/ApiAppListResponse.md index c53c3e482..0abbe0798 100644 --- a/sdks/dotnet/docs/ApiAppListResponse.md +++ b/sdks/dotnet/docs/ApiAppListResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiApps** | [**List<ApiAppResponse>**](ApiAppResponse.md) | Contains information about API Apps. | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**ApiApps** | [**List<ApiAppResponse>**](ApiAppResponse.md) | _t__ApiAppListResponse::DESCRIPTION | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ApiAppResponse.md b/sdks/dotnet/docs/ApiAppResponse.md index f27ff0659..6915ccc43 100644 --- a/sdks/dotnet/docs/ApiAppResponse.md +++ b/sdks/dotnet/docs/ApiAppResponse.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.ApiAppResponse -Contains information about an API App. +_t__ApiAppResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CallbackUrl** | **string** | The app's callback URL (for events) | [optional] **ClientId** | **string** | The app's client id | [optional] **CreatedAt** | **int** | The time that the app was created | [optional] **Domains** | **List<string>** | The domain name(s) associated with the app | [optional] **Name** | **string** | The name of the app | [optional] **IsApproved** | **bool** | Boolean to indicate if the app has been approved | [optional] **Oauth** | [**ApiAppResponseOAuth**](ApiAppResponseOAuth.md) | | [optional] **Options** | [**ApiAppResponseOptions**](ApiAppResponseOptions.md) | | [optional] **OwnerAccount** | [**ApiAppResponseOwnerAccount**](ApiAppResponseOwnerAccount.md) | | [optional] **WhiteLabelingOptions** | [**ApiAppResponseWhiteLabelingOptions**](ApiAppResponseWhiteLabelingOptions.md) | | [optional] +**CallbackUrl** | **string** | _t__ApiAppResponse::CALLBACK_URL | [optional] **ClientId** | **string** | _t__ApiAppResponse::CLIENT_ID | [optional] **CreatedAt** | **int** | _t__ApiAppResponse::CREATED_AT | [optional] **Domains** | **List<string>** | _t__ApiAppResponse::DOMAINS | [optional] **Name** | **string** | _t__ApiAppResponse::NAME | [optional] **IsApproved** | **bool** | _t__ApiAppResponse::IS_APPROVED | [optional] **Oauth** | [**ApiAppResponseOAuth**](ApiAppResponseOAuth.md) | | [optional] **Options** | [**ApiAppResponseOptions**](ApiAppResponseOptions.md) | | [optional] **OwnerAccount** | [**ApiAppResponseOwnerAccount**](ApiAppResponseOwnerAccount.md) | | [optional] **WhiteLabelingOptions** | [**ApiAppResponseWhiteLabelingOptions**](ApiAppResponseWhiteLabelingOptions.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ApiAppResponseOAuth.md b/sdks/dotnet/docs/ApiAppResponseOAuth.md index cffe8900f..b21db8cc5 100644 --- a/sdks/dotnet/docs/ApiAppResponseOAuth.md +++ b/sdks/dotnet/docs/ApiAppResponseOAuth.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.ApiAppResponseOAuth -An object describing the app's OAuth properties, or null if OAuth is not configured for the app. +_t__ApiAppResponseOAuth::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CallbackUrl** | **string** | The app's OAuth callback URL. | [optional] **Secret** | **string** | The app's OAuth secret, or null if the app does not belong to user. | [optional] **Scopes** | **List<string>** | Array of OAuth scopes used by the app. | [optional] **ChargesUsers** | **bool** | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | [optional] +**CallbackUrl** | **string** | _t__ApiAppResponseOAuth::CALLBACK_URL | [optional] **Secret** | **string** | _t__ApiAppResponseOAuth::SECRET | [optional] **Scopes** | **List<string>** | _t__ApiAppResponseOAuth::SCOPES | [optional] **ChargesUsers** | **bool** | _t__ApiAppResponseOAuth::CHARGES_USERS | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ApiAppResponseOptions.md b/sdks/dotnet/docs/ApiAppResponseOptions.md index e484ad16b..4aa5a4d9b 100644 --- a/sdks/dotnet/docs/ApiAppResponseOptions.md +++ b/sdks/dotnet/docs/ApiAppResponseOptions.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.ApiAppResponseOptions -An object with options that override account settings. +_t__ApiAppResponseOptions::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CanInsertEverywhere** | **bool** | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | [optional] +**CanInsertEverywhere** | **bool** | _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md b/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md index eee4afc3e..93c89010f 100644 --- a/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/dotnet/docs/ApiAppResponseOwnerAccount.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.ApiAppResponseOwnerAccount -An object describing the app's owner +_t__ApiAppResponseOwnerAccount::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | **string** | The owner account's ID | [optional] **EmailAddress** | **string** | The owner account's email address | [optional] +**AccountId** | **string** | _t__ApiAppResponseOwnerAccount::ACCOUNT_ID | [optional] **EmailAddress** | **string** | _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md index 3f3eb34a3..1d333784d 100644 --- a/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/dotnet/docs/ApiAppResponseWhiteLabelingOptions.md @@ -1,5 +1,5 @@ # Dropbox.Sign.Model.ApiAppResponseWhiteLabelingOptions -An object with options to customize the app's signer page +_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION ## Properties diff --git a/sdks/dotnet/docs/BulkSendJobGetResponse.md b/sdks/dotnet/docs/BulkSendJobGetResponse.md index 9d23309a8..e5734f0e7 100644 --- a/sdks/dotnet/docs/BulkSendJobGetResponse.md +++ b/sdks/dotnet/docs/BulkSendJobGetResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BulkSendJob** | [**BulkSendJobResponse**](BulkSendJobResponse.md) | | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **SignatureRequests** | [**List<BulkSendJobGetResponseSignatureRequests>**](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**BulkSendJob** | [**BulkSendJobResponse**](BulkSendJobResponse.md) | | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **SignatureRequests** | [**List<BulkSendJobGetResponseSignatureRequests>**](BulkSendJobGetResponseSignatureRequests.md) | _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/dotnet/docs/BulkSendJobGetResponseSignatureRequests.md index 5ba89617f..f128247a2 100644 --- a/sdks/dotnet/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/dotnet/docs/BulkSendJobGetResponseSignatureRequests.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TestMode** | **bool** | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [optional] [default to false]**SignatureRequestId** | **string** | The id of the SignatureRequest. | [optional] **RequesterEmailAddress** | **string** | The email address of the initiator of the SignatureRequest. | [optional] **Title** | **string** | The title the specified Account uses for the SignatureRequest. | [optional] **OriginalTitle** | **string** | Default Label for account. | [optional] **Subject** | **string** | The subject in the email that was initially sent to the signers. | [optional] **Message** | **string** | The custom message in the email that was initially sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the signature request. | [optional] **CreatedAt** | **int** | Time the signature request was created. | [optional] **ExpiresAt** | **int?** | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **IsComplete** | **bool** | Whether or not the SignatureRequest has been fully executed by all signers. | [optional] **IsDeclined** | **bool** | Whether or not the SignatureRequest has been declined by a signer. | [optional] **HasError** | **bool** | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | [optional] **FilesUrl** | **string** | The URL where a copy of the request's documents can be downloaded. | [optional] **SigningUrl** | **string** | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | [optional] **DetailsUrl** | **string** | The URL where the requester and the signers can view the current status of the SignatureRequest. | [optional] **CcEmailAddresses** | **List<string>** | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | [optional] **SigningRedirectUrl** | **string** | The URL you want the signer redirected to after they successfully sign. | [optional] **FinalCopyUri** | **string** | The path where the completed document can be downloaded | [optional] **TemplateIds** | **List<string>** | Templates IDs used in this SignatureRequest (if any). | [optional] **CustomFields** | [**List<SignatureRequestResponseCustomFieldBase>**](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **ResponseData** | [**List<SignatureRequestResponseDataBase>**](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | [optional] **Signatures** | [**List<SignatureRequestResponseSignatures>**](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | [optional] **BulkSendJobId** | **string** | The id of the BulkSendJob. | [optional] +**TestMode** | **bool** | _t__SignatureRequestResponse::TEST_MODE | [optional] [default to false]**SignatureRequestId** | **string** | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | [optional] **RequesterEmailAddress** | **string** | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | [optional] **Title** | **string** | _t__SignatureRequestResponse::TITLE | [optional] **OriginalTitle** | **string** | _t__SignatureRequestResponse::ORIGINAL_TITLE | [optional] **Subject** | **string** | _t__SignatureRequestResponse::SUBJECT | [optional] **Message** | **string** | _t__SignatureRequestResponse::MESSAGE | [optional] **Metadata** | **Dictionary<string, Object>** | _t__SignatureRequestResponse::METADATA | [optional] **CreatedAt** | **int** | _t__SignatureRequestResponse::CREATED_AT | [optional] **ExpiresAt** | **int?** | _t__SignatureRequestResponse::EXPIRES_AT | [optional] **IsComplete** | **bool** | _t__SignatureRequestResponse::IS_COMPLETE | [optional] **IsDeclined** | **bool** | _t__SignatureRequestResponse::IS_DECLINED | [optional] **HasError** | **bool** | _t__SignatureRequestResponse::HAS_ERROR | [optional] **FilesUrl** | **string** | _t__SignatureRequestResponse::FILES_URL | [optional] **SigningUrl** | **string** | _t__SignatureRequestResponse::SIGNING_URL | [optional] **DetailsUrl** | **string** | _t__SignatureRequestResponse::DETAILS_URL | [optional] **CcEmailAddresses** | **List<string>** | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | [optional] **SigningRedirectUrl** | **string** | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | [optional] **FinalCopyUri** | **string** | _t__SignatureRequestResponse::FINAL_COPY_URI | [optional] **TemplateIds** | **List<string>** | _t__SignatureRequestResponse::TEMPLATE_IDS | [optional] **CustomFields** | [**List<SignatureRequestResponseCustomFieldBase>**](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | [optional] **ResponseData** | [**List<SignatureRequestResponseDataBase>**](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | [optional] **Signatures** | [**List<SignatureRequestResponseSignatures>**](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | [optional] **BulkSendJobId** | **string** | _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/BulkSendJobListResponse.md b/sdks/dotnet/docs/BulkSendJobListResponse.md index 0c353ddd0..e7a765a8a 100644 --- a/sdks/dotnet/docs/BulkSendJobListResponse.md +++ b/sdks/dotnet/docs/BulkSendJobListResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BulkSendJobs** | [**List<BulkSendJobResponse>**](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**BulkSendJobs** | [**List<BulkSendJobResponse>**](BulkSendJobResponse.md) | _t__BulkSendJobListResponse::BULK_SEND_JOBS | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/BulkSendJobResponse.md b/sdks/dotnet/docs/BulkSendJobResponse.md index 6a9e580db..79986ac75 100644 --- a/sdks/dotnet/docs/BulkSendJobResponse.md +++ b/sdks/dotnet/docs/BulkSendJobResponse.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.BulkSendJobResponse -Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. +_t__BulkSendJobResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BulkSendJobId** | **string** | The id of the BulkSendJob. | [optional] **Total** | **int** | The total amount of Signature Requests queued for sending. | [optional] **IsCreator** | **bool** | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | [optional] **CreatedAt** | **int** | Time that the BulkSendJob was created. | [optional] +**BulkSendJobId** | **string** | _t__BulkSendJobResponse::BULK_SEND_JOB_ID | [optional] **Total** | **int** | _t__BulkSendJobResponse::TOTAL | [optional] **IsCreator** | **bool** | _t__BulkSendJobResponse::IS_CREATOR | [optional] **CreatedAt** | **int** | _t__BulkSendJobResponse::CREATED_AT | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/BulkSendJobSendResponse.md b/sdks/dotnet/docs/BulkSendJobSendResponse.md index 1649dc405..7f37b09fa 100644 --- a/sdks/dotnet/docs/BulkSendJobSendResponse.md +++ b/sdks/dotnet/docs/BulkSendJobSendResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**BulkSendJob** | [**BulkSendJobResponse**](BulkSendJobResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**BulkSendJob** | [**BulkSendJobResponse**](BulkSendJobResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/EmbeddedEditUrlRequest.md b/sdks/dotnet/docs/EmbeddedEditUrlRequest.md index 43b4c3e10..b62194404 100644 --- a/sdks/dotnet/docs/EmbeddedEditUrlRequest.md +++ b/sdks/dotnet/docs/EmbeddedEditUrlRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AllowEditCcs** | **bool** | This allows the requester to enable/disable to add or change CC roles when editing the template. | [optional] [default to false]**CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.

Remove all merge fields on the template by passing an empty array `[]`. | [optional] **PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

**NOTE:** This parameter overwrites `show_preview=true` (if set). | [optional] [default to false]**ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**TestMode** | **bool** | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [optional] [default to false] +**AllowEditCcs** | **bool** | This allows the requester to enable/disable to add or change CC roles when editing the template. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.

Remove all merge fields on the template by passing an empty array `[]`. | [optional] **PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

**NOTE:** This parameter overwrites `show_preview=true` (if set). | [optional] [default to false]**ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**TestMode** | **bool** | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [optional] [default to false] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/EmbeddedEditUrlResponse.md b/sdks/dotnet/docs/EmbeddedEditUrlResponse.md index d2c1d5fae..4d847d851 100644 --- a/sdks/dotnet/docs/EmbeddedEditUrlResponse.md +++ b/sdks/dotnet/docs/EmbeddedEditUrlResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Embedded** | [**EmbeddedEditUrlResponseEmbedded**](EmbeddedEditUrlResponseEmbedded.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Embedded** | [**EmbeddedEditUrlResponseEmbedded**](EmbeddedEditUrlResponseEmbedded.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/EmbeddedEditUrlResponseEmbedded.md b/sdks/dotnet/docs/EmbeddedEditUrlResponseEmbedded.md index 7750157e9..636beb320 100644 --- a/sdks/dotnet/docs/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/dotnet/docs/EmbeddedEditUrlResponseEmbedded.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.EmbeddedEditUrlResponseEmbedded -An embedded template object. +_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**EditUrl** | **string** | A template url that can be opened in an iFrame. | [optional] **ExpiresAt** | **int** | The specific time that the the `edit_url` link expires, in epoch. | [optional] +**EditUrl** | **string** | _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL | [optional] **ExpiresAt** | **int** | _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/EmbeddedSignUrlResponse.md b/sdks/dotnet/docs/EmbeddedSignUrlResponse.md index 2bd6732b3..3cb864cb8 100644 --- a/sdks/dotnet/docs/EmbeddedSignUrlResponse.md +++ b/sdks/dotnet/docs/EmbeddedSignUrlResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Embedded** | [**EmbeddedSignUrlResponseEmbedded**](EmbeddedSignUrlResponseEmbedded.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Embedded** | [**EmbeddedSignUrlResponseEmbedded**](EmbeddedSignUrlResponseEmbedded.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/EmbeddedSignUrlResponseEmbedded.md b/sdks/dotnet/docs/EmbeddedSignUrlResponseEmbedded.md index 319edfa14..6dcfec6bc 100644 --- a/sdks/dotnet/docs/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/dotnet/docs/EmbeddedSignUrlResponseEmbedded.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.EmbeddedSignUrlResponseEmbedded -An object that contains necessary information to set up embedded signing. +_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**SignUrl** | **string** | A signature url that can be opened in an iFrame. | [optional] **ExpiresAt** | **int** | The specific time that the the `sign_url` link expires, in epoch. | [optional] +**SignUrl** | **string** | _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL | [optional] **ExpiresAt** | **int** | _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ErrorResponseError.md b/sdks/dotnet/docs/ErrorResponseError.md index 13dacc1bf..a47b96449 100644 --- a/sdks/dotnet/docs/ErrorResponseError.md +++ b/sdks/dotnet/docs/ErrorResponseError.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.ErrorResponseError -Contains information about an error that occurred. +_t__ErrorResponseError::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ErrorMsg** | **string** | Message describing an error. | **ErrorName** | **string** | Name of the error. | **ErrorPath** | **string** | Path at which an error occurred. | [optional] +**ErrorMsg** | **string** | _t__ErrorResponseError::ERROR_MSG | **ErrorName** | **string** | _t__ErrorResponseError::ERROR_NAME | **ErrorPath** | **string** | _t__ErrorResponseError::ERROR_PATH | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/EventCallbackRequestEvent.md b/sdks/dotnet/docs/EventCallbackRequestEvent.md index ca1780ac9..6c3334013 100644 --- a/sdks/dotnet/docs/EventCallbackRequestEvent.md +++ b/sdks/dotnet/docs/EventCallbackRequestEvent.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.EventCallbackRequestEvent -Basic information about the event that occurred. +_t__EventCallbackRequestEvent::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**EventTime** | **string** | Time the event was created (using Unix time). | **EventType** | **string** | Type of callback event that was triggered. | **EventHash** | **string** | Generated hash used to verify source of event data. | **EventMetadata** | [**EventCallbackRequestEventMetadata**](EventCallbackRequestEventMetadata.md) | | [optional] +**EventTime** | **string** | _t__EventCallbackRequestEvent::EVENT_TIME | **EventType** | **string** | _t__EventCallbackRequestEvent::EVENT_TYPE | **EventHash** | **string** | _t__EventCallbackRequestEvent::EVENT_HASH | **EventMetadata** | [**EventCallbackRequestEventMetadata**](EventCallbackRequestEventMetadata.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/EventCallbackRequestEventMetadata.md b/sdks/dotnet/docs/EventCallbackRequestEventMetadata.md index cf78a668c..188a1a6b1 100644 --- a/sdks/dotnet/docs/EventCallbackRequestEventMetadata.md +++ b/sdks/dotnet/docs/EventCallbackRequestEventMetadata.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.EventCallbackRequestEventMetadata -Specific metadata about the event. +_t__EventCallbackRequestEventMetadata::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**RelatedSignatureId** | **string** | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | [optional] **ReportedForAccountId** | **string** | Account ID the event was reported for. | [optional] **ReportedForAppId** | **string** | App ID the event was reported for. | [optional] **EventMessage** | **string** | Message about a declined or failed (due to error) signature flow. | [optional] +**RelatedSignatureId** | **string** | _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID | [optional] **ReportedForAccountId** | **string** | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID | [optional] **ReportedForAppId** | **string** | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID | [optional] **EventMessage** | **string** | _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/FaxGetResponse.md b/sdks/dotnet/docs/FaxGetResponse.md index 42b82e12c..6b09def3b 100644 --- a/sdks/dotnet/docs/FaxGetResponse.md +++ b/sdks/dotnet/docs/FaxGetResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Fax** | [**FaxResponse**](FaxResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Fax** | [**FaxResponse**](FaxResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/FileResponse.md b/sdks/dotnet/docs/FileResponse.md index 8ce1da078..244689669 100644 --- a/sdks/dotnet/docs/FileResponse.md +++ b/sdks/dotnet/docs/FileResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**FileUrl** | **string** | URL to the file. | **ExpiresAt** | **int** | When the link expires. | +**FileUrl** | **string** | _t__FileResponse::FILE_URL | **ExpiresAt** | **int** | _t__FileResponse::EXPIRES_AT | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/FileResponseDataUri.md b/sdks/dotnet/docs/FileResponseDataUri.md index 784c396f4..2c4ac7866 100644 --- a/sdks/dotnet/docs/FileResponseDataUri.md +++ b/sdks/dotnet/docs/FileResponseDataUri.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**DataUri** | **string** | File as base64 encoded string. | +**DataUri** | **string** | _t__FileResponse::DATA_URI | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ListInfoResponse.md b/sdks/dotnet/docs/ListInfoResponse.md index 59b6e3a67..6f149be9e 100644 --- a/sdks/dotnet/docs/ListInfoResponse.md +++ b/sdks/dotnet/docs/ListInfoResponse.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.ListInfoResponse -Contains pagination information about the data returned. +_t__ListInfoResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**NumPages** | **int** | Total number of pages available. | [optional] **NumResults** | **int?** | Total number of objects available. | [optional] **Page** | **int** | Number of the page being returned. | [optional] **PageSize** | **int** | Objects returned per page. | [optional] +**NumPages** | **int** | _t__ListInfoResponse::NUM_PAGES | [optional] **NumResults** | **int?** | _t__ListInfoResponse::NUM_RESULTS | [optional] **Page** | **int** | _t__ListInfoResponse::PAGE | [optional] **PageSize** | **int** | _t__ListInfoResponse::PAGE_SIZE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/OAuthTokenResponse.md b/sdks/dotnet/docs/OAuthTokenResponse.md index 52a050158..80f4e1c5c 100644 --- a/sdks/dotnet/docs/OAuthTokenResponse.md +++ b/sdks/dotnet/docs/OAuthTokenResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccessToken** | **string** | | [optional] **TokenType** | **string** | | [optional] **RefreshToken** | **string** | | [optional] **ExpiresIn** | **int** | Number of seconds until the `access_token` expires. Uses epoch time. | [optional] **State** | **string** | | [optional] +**AccessToken** | **string** | | [optional] **TokenType** | **string** | | [optional] **RefreshToken** | **string** | | [optional] **ExpiresIn** | **int** | _t__OAuthTokenResponse::EXPIRES_IN | [optional] **State** | **string** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ReportCreateResponse.md b/sdks/dotnet/docs/ReportCreateResponse.md index a6416fe7a..adbf346cc 100644 --- a/sdks/dotnet/docs/ReportCreateResponse.md +++ b/sdks/dotnet/docs/ReportCreateResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Report** | [**ReportResponse**](ReportResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Report** | [**ReportResponse**](ReportResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/ReportResponse.md b/sdks/dotnet/docs/ReportResponse.md index 9f6aec6c6..b30eb3a99 100644 --- a/sdks/dotnet/docs/ReportResponse.md +++ b/sdks/dotnet/docs/ReportResponse.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.ReportResponse -Contains information about the report request. +_t__ReportResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Success** | **string** | A message indicating the requested operation's success | [optional] **StartDate** | **string** | The (inclusive) start date for the report data in MM/DD/YYYY format. | [optional] **EndDate** | **string** | The (inclusive) end date for the report data in MM/DD/YYYY format. | [optional] **ReportType** | **List<ReportResponse.ReportTypeEnum>** | 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). | [optional] +**Success** | **string** | _t__ReportResponse::SUCCESS | [optional] **StartDate** | **string** | _t__ReportResponse::START_DATE | [optional] **EndDate** | **string** | _t__ReportResponse::END_DATE | [optional] **ReportType** | **List<ReportResponse.ReportTypeEnum>** | _t__ReportResponse::REPORT_TYPE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index 002d9501a..af7f7dbb6 100644 --- a/sdks/dotnet/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | [optional] **SignerList** | [**List<SubBulkSignerList>**](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | [optional] **SignerList** | [**List<SubBulkSignerList>**](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestBulkSendWithTemplateRequest.md index 8e108215e..08558869d 100644 --- a/sdks/dotnet/docs/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestBulkSendWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | [optional] **SignerList** | [**List<SubBulkSignerList>**](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:

- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)

You may only specify field values here, any other options should be set in the custom_fields request parameter.

Example CSV:

``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | [optional] **SignerList** | [**List<SubBulkSignerList>**](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md index babeb4eb2..0f565d5c9 100644 --- a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] +**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 61bab9b3a..b87843ef7 100644 --- a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md index 3d7e41773..4630b4d22 100644 --- a/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] +**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index 8be8d1b17..81882c3db 100644 --- a/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditRequest.md b/sdks/dotnet/docs/SignatureRequestEditRequest.md index 20f216403..1d09df000 100644 --- a/sdks/dotnet/docs/SignatureRequestEditRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] +**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md index d9ac882ee..142295930 100644 --- a/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestGetResponse.md b/sdks/dotnet/docs/SignatureRequestGetResponse.md index b43aebe70..fe4d7ce59 100644 --- a/sdks/dotnet/docs/SignatureRequestGetResponse.md +++ b/sdks/dotnet/docs/SignatureRequestGetResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**SignatureRequest** | [**SignatureRequestResponse**](SignatureRequestResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**SignatureRequest** | [**SignatureRequestResponse**](SignatureRequestResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestListResponse.md b/sdks/dotnet/docs/SignatureRequestListResponse.md index d3cda99bc..84992738a 100644 --- a/sdks/dotnet/docs/SignatureRequestListResponse.md +++ b/sdks/dotnet/docs/SignatureRequestListResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**SignatureRequests** | [**List<SignatureRequestResponse>**](SignatureRequestResponse.md) | Contains information about signature requests. | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**SignatureRequests** | [**List<SignatureRequestResponse>**](SignatureRequestResponse.md) | _t__SignatureRequestListResponse::DESCRIPTION | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponse.md b/sdks/dotnet/docs/SignatureRequestResponse.md index e2b6d0a31..1d6ca64bc 100644 --- a/sdks/dotnet/docs/SignatureRequestResponse.md +++ b/sdks/dotnet/docs/SignatureRequestResponse.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SignatureRequestResponse -Contains information about a signature request. +_t__SignatureRequestResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TestMode** | **bool** | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [optional] [default to false]**SignatureRequestId** | **string** | The id of the SignatureRequest. | [optional] **RequesterEmailAddress** | **string** | The email address of the initiator of the SignatureRequest. | [optional] **Title** | **string** | The title the specified Account uses for the SignatureRequest. | [optional] **OriginalTitle** | **string** | Default Label for account. | [optional] **Subject** | **string** | The subject in the email that was initially sent to the signers. | [optional] **Message** | **string** | The custom message in the email that was initially sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the signature request. | [optional] **CreatedAt** | **int** | Time the signature request was created. | [optional] **ExpiresAt** | **int?** | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **IsComplete** | **bool** | Whether or not the SignatureRequest has been fully executed by all signers. | [optional] **IsDeclined** | **bool** | Whether or not the SignatureRequest has been declined by a signer. | [optional] **HasError** | **bool** | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | [optional] **FilesUrl** | **string** | The URL where a copy of the request's documents can be downloaded. | [optional] **SigningUrl** | **string** | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | [optional] **DetailsUrl** | **string** | The URL where the requester and the signers can view the current status of the SignatureRequest. | [optional] **CcEmailAddresses** | **List<string>** | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | [optional] **SigningRedirectUrl** | **string** | The URL you want the signer redirected to after they successfully sign. | [optional] **FinalCopyUri** | **string** | The path where the completed document can be downloaded | [optional] **TemplateIds** | **List<string>** | Templates IDs used in this SignatureRequest (if any). | [optional] **CustomFields** | [**List<SignatureRequestResponseCustomFieldBase>**](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **ResponseData** | [**List<SignatureRequestResponseDataBase>**](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | [optional] **Signatures** | [**List<SignatureRequestResponseSignatures>**](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | [optional] **BulkSendJobId** | **string** | The ID of the Bulk Send job which sent the signature request, if applicable. | [optional] +**TestMode** | **bool** | _t__SignatureRequestResponse::TEST_MODE | [optional] [default to false]**SignatureRequestId** | **string** | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | [optional] **RequesterEmailAddress** | **string** | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | [optional] **Title** | **string** | _t__SignatureRequestResponse::TITLE | [optional] **OriginalTitle** | **string** | _t__SignatureRequestResponse::ORIGINAL_TITLE | [optional] **Subject** | **string** | _t__SignatureRequestResponse::SUBJECT | [optional] **Message** | **string** | _t__SignatureRequestResponse::MESSAGE | [optional] **Metadata** | **Dictionary<string, Object>** | _t__SignatureRequestResponse::METADATA | [optional] **CreatedAt** | **int** | _t__SignatureRequestResponse::CREATED_AT | [optional] **ExpiresAt** | **int?** | _t__SignatureRequestResponse::EXPIRES_AT | [optional] **IsComplete** | **bool** | _t__SignatureRequestResponse::IS_COMPLETE | [optional] **IsDeclined** | **bool** | _t__SignatureRequestResponse::IS_DECLINED | [optional] **HasError** | **bool** | _t__SignatureRequestResponse::HAS_ERROR | [optional] **FilesUrl** | **string** | _t__SignatureRequestResponse::FILES_URL | [optional] **SigningUrl** | **string** | _t__SignatureRequestResponse::SIGNING_URL | [optional] **DetailsUrl** | **string** | _t__SignatureRequestResponse::DETAILS_URL | [optional] **CcEmailAddresses** | **List<string>** | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | [optional] **SigningRedirectUrl** | **string** | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | [optional] **FinalCopyUri** | **string** | _t__SignatureRequestResponse::FINAL_COPY_URI | [optional] **TemplateIds** | **List<string>** | _t__SignatureRequestResponse::TEMPLATE_IDS | [optional] **CustomFields** | [**List<SignatureRequestResponseCustomFieldBase>**](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | [optional] **ResponseData** | [**List<SignatureRequestResponseDataBase>**](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | [optional] **Signatures** | [**List<SignatureRequestResponseSignatures>**](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | [optional] **BulkSendJobId** | **string** | _t__SignatureRequestResponse::BULK_SEND_JOB_ID | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseAttachment.md b/sdks/dotnet/docs/SignatureRequestResponseAttachment.md index cf0956931..0d9b9a978 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseAttachment.md +++ b/sdks/dotnet/docs/SignatureRequestResponseAttachment.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SignatureRequestResponseAttachment -Signer attachments. +_t__SignatureRequestResponseAttachment::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **string** | The unique ID for this attachment. | **Signer** | **string** | The Signer this attachment is assigned to. | **Name** | **string** | The name of this attachment. | **Required** | **bool** | A boolean value denoting if this attachment is required. | **Instructions** | **string** | Instructions for Signer. | [optional] **UploadedAt** | **int?** | Timestamp when attachment was uploaded by Signer. | [optional] +**Id** | **string** | _t__SignatureRequestResponseAttachment::ID | **Signer** | **string** | _t__SignatureRequestResponseAttachment::SIGNER | **Name** | **string** | _t__SignatureRequestResponseAttachment::NAME | **Required** | **bool** | _t__SignatureRequestResponseAttachment::REQUIRED | **Instructions** | **string** | _t__SignatureRequestResponseAttachment::INSTRUCTIONS | [optional] **UploadedAt** | **int?** | _t__SignatureRequestResponseAttachment::UPLOADED_AT | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseCustomFieldBase.md b/sdks/dotnet/docs/SignatureRequestResponseCustomFieldBase.md index 02072d8aa..5e8d5a323 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/dotnet/docs/SignatureRequestResponseCustomFieldBase.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SignatureRequestResponseCustomFieldBase -An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` +_t__SignatureRequestResponseCustomField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | **Name** | **string** | The name of the Custom Field. | **Required** | **bool** | A boolean value denoting if this field is required. | [optional] **ApiId** | **string** | The unique ID for this field. | [optional] **Editor** | **string** | The name of the Role that is able to edit this field. | [optional] +**Type** | **string** | _t__SignatureRequestResponseCustomField::TYPE | **Name** | **string** | _t__SignatureRequestResponseCustomField::NAME | **Required** | **bool** | _t__SignatureRequestResponseCustomField::REQUIRED | [optional] **ApiId** | **string** | _t__SignatureRequestResponseCustomField::API_ID | [optional] **Editor** | **string** | _t__SignatureRequestResponseCustomField::EDITOR | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/dotnet/docs/SignatureRequestResponseCustomFieldCheckbox.md index 42a1a3004..bf3b94028 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/dotnet/docs/SignatureRequestResponseCustomFieldCheckbox.md @@ -1,15 +1,15 @@ # Dropbox.Sign.Model.SignatureRequestResponseCustomFieldCheckbox -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Custom Field. | -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**ApiId** | **string** | The unique ID for this field. | [optional] -**Editor** | **string** | The name of the Role that is able to edit this field. | [optional] -**Type** | **string** | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to "checkbox"]**Value** | **bool** | A true/false for checkbox fields | [optional] +**Name** | **string** | _t__SignatureRequestResponseCustomField::NAME | +**Required** | **bool** | _t__SignatureRequestResponseCustomField::REQUIRED | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseCustomField::API_ID | [optional] +**Editor** | **string** | _t__SignatureRequestResponseCustomField::EDITOR | [optional] +**Type** | **string** | _t__SignatureRequestResponseCustomField::TYPE | [default to "checkbox"]**Value** | **bool** | _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseCustomFieldText.md b/sdks/dotnet/docs/SignatureRequestResponseCustomFieldText.md index c3c9ca8af..7e0db9e93 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseCustomFieldText.md +++ b/sdks/dotnet/docs/SignatureRequestResponseCustomFieldText.md @@ -1,15 +1,15 @@ # Dropbox.Sign.Model.SignatureRequestResponseCustomFieldText -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Custom Field. | -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**ApiId** | **string** | The unique ID for this field. | [optional] -**Editor** | **string** | The name of the Role that is able to edit this field. | [optional] -**Type** | **string** | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to "text"]**Value** | **string** | A text string for text fields | [optional] +**Name** | **string** | _t__SignatureRequestResponseCustomField::NAME | +**Required** | **bool** | _t__SignatureRequestResponseCustomField::REQUIRED | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseCustomField::API_ID | [optional] +**Editor** | **string** | _t__SignatureRequestResponseCustomField::EDITOR | [optional] +**Type** | **string** | _t__SignatureRequestResponseCustomField::TYPE | [default to "text"]**Value** | **string** | _t__SignatureRequestResponseCustomField::VALUE_TEXT | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataBase.md b/sdks/dotnet/docs/SignatureRequestResponseDataBase.md index 63c965df9..6332a6524 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataBase.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataBase.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SignatureRequestResponseDataBase -An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. +_t__SignatureRequestResponseData::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] **SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] **Name** | **string** | The name of the form field. | [optional] **Required** | **bool** | A boolean value denoting if this field is required. | [optional] **Type** | **string** | | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] **SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] **Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] **Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] **Type** | **string** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataValueCheckbox.md b/sdks/dotnet/docs/SignatureRequestResponseDataValueCheckbox.md index 57d02ae42..d8b27e74d 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataValueCheckbox.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**Type** | **string** | A yes/no checkbox | [optional] [default to "checkbox"]**Value** | **bool** | The value of the form field. | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] +**Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] +**Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] +**Type** | **string** | _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE | [optional] [default to "checkbox"]**Value** | **bool** | _t__SignatureRequestResponseDataValue::VALUE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/dotnet/docs/SignatureRequestResponseDataValueCheckboxMerge.md index 7e96757d7..f57309f93 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataValueCheckboxMerge.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**Type** | **string** | A checkbox field that has default value set by the api | [optional] [default to "checkbox-merge"]**Value** | **string** | The value of the form field. | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] +**Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] +**Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] +**Type** | **string** | _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE | [optional] [default to "checkbox-merge"]**Value** | **string** | _t__SignatureRequestResponseDataValue::VALUE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataValueDateSigned.md b/sdks/dotnet/docs/SignatureRequestResponseDataValueDateSigned.md index 3bc2e553e..64b99507d 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataValueDateSigned.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**Type** | **string** | A date | [optional] [default to "date_signed"]**Value** | **string** | The value of the form field. | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] +**Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] +**Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] +**Type** | **string** | _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE | [optional] [default to "date_signed"]**Value** | **string** | _t__SignatureRequestResponseDataValue::VALUE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataValueDropdown.md b/sdks/dotnet/docs/SignatureRequestResponseDataValueDropdown.md index 13473c22d..f090f6f70 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataValueDropdown.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**Type** | **string** | An input field for dropdowns | [optional] [default to "dropdown"]**Value** | **string** | The value of the form field. | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] +**Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] +**Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] +**Type** | **string** | _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE | [optional] [default to "dropdown"]**Value** | **string** | _t__SignatureRequestResponseDataValue::VALUE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataValueInitials.md b/sdks/dotnet/docs/SignatureRequestResponseDataValueInitials.md index 74ef6e094..61b3eae00 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataValueInitials.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataValueInitials.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**Type** | **string** | An input field for initials | [optional] [default to "initials"]**Value** | **string** | The value of the form field. | [optional] **IsSigned** | **bool?** | This field contains the boolean true if the field is signed. | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] +**Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] +**Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] +**Type** | **string** | _t__SignatureRequestResponseDataValue::INITIAL_TYPE | [optional] [default to "initials"]**Value** | **string** | _t__SignatureRequestResponseDataValue::VALUE | [optional] **IsSigned** | **bool?** | _t__SignatureRequestResponseDataValue::IS_SIGNED | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataValueRadio.md b/sdks/dotnet/docs/SignatureRequestResponseDataValueRadio.md index ccc7520e2..2829b00f9 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataValueRadio.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataValueRadio.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**Type** | **string** | An input field for radios | [optional] [default to "radio"]**Value** | **bool** | The value of the form field. | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] +**Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] +**Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] +**Type** | **string** | _t__SignatureRequestResponseDataValue::RADIO_TYPE | [optional] [default to "radio"]**Value** | **bool** | _t__SignatureRequestResponseDataValue::VALUE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataValueSignature.md b/sdks/dotnet/docs/SignatureRequestResponseDataValueSignature.md index 8e921bf9b..81ac24ec0 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataValueSignature.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataValueSignature.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**Type** | **string** | A signature input field | [optional] [default to "signature"]**Value** | **string** | The value of the form field. | [optional] **IsSigned** | **bool?** | This field contains the boolean true if the field is signed. | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] +**Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] +**Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] +**Type** | **string** | _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE | [optional] [default to "signature"]**Value** | **string** | _t__SignatureRequestResponseDataValue::VALUE | [optional] **IsSigned** | **bool?** | _t__SignatureRequestResponseDataValue::IS_SIGNED | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataValueText.md b/sdks/dotnet/docs/SignatureRequestResponseDataValueText.md index 14e685ea2..26ba39f52 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataValueText.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataValueText.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**Type** | **string** | A text input field | [optional] [default to "text"]**Value** | **string** | The value of the form field. | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] +**Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] +**Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] +**Type** | **string** | _t__SignatureRequestResponseDataValue::TEXT_TYPE | [optional] [default to "text"]**Value** | **string** | _t__SignatureRequestResponseDataValue::VALUE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseDataValueTextMerge.md b/sdks/dotnet/docs/SignatureRequestResponseDataValueTextMerge.md index 2c8ab326b..437873abf 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/dotnet/docs/SignatureRequestResponseDataValueTextMerge.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**SignatureId** | **string** | The ID of the signature to which this response is linked. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Required** | **bool** | A boolean value denoting if this field is required. | [optional] -**Type** | **string** | A text field that has default text set by the api | [optional] [default to "text-merge"]**Value** | **string** | The value of the form field. | [optional] +**ApiId** | **string** | _t__SignatureRequestResponseData::API_ID | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseData::SIGNATURE_ID | [optional] +**Name** | **string** | _t__SignatureRequestResponseData::NAME | [optional] +**Required** | **bool** | _t__SignatureRequestResponseData::REQUIRED | [optional] +**Type** | **string** | _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE | [optional] [default to "text-merge"]**Value** | **string** | _t__SignatureRequestResponseDataValue::VALUE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponseSignatures.md b/sdks/dotnet/docs/SignatureRequestResponseSignatures.md index 0956244ab..00c9f6f21 100644 --- a/sdks/dotnet/docs/SignatureRequestResponseSignatures.md +++ b/sdks/dotnet/docs/SignatureRequestResponseSignatures.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SignatureRequestResponseSignatures -An array of signature objects, 1 for each signer. +_t__SignatureRequestResponseSignatures::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**SignatureId** | **string** | Signature identifier. | [optional] **SignerGroupGuid** | **string** | Signer Group GUID | [optional] **SignerEmailAddress** | **string** | The email address of the signer. | [optional] **SignerName** | **string** | The name of the signer. | [optional] **SignerRole** | **string** | The role of the signer. | [optional] **Order** | **int?** | If signer order is assigned this is the 0-based index for this signer. | [optional] **StatusCode** | **string** | The current status of the signature. eg: awaiting_signature, signed, declined. | [optional] **DeclineReason** | **string** | The reason provided by the signer for declining the request. | [optional] **SignedAt** | **int?** | Time that the document was signed or null. | [optional] **LastViewedAt** | **int?** | The time that the document was last viewed by this signer or null. | [optional] **LastRemindedAt** | **int?** | The time the last reminder email was sent to the signer or null. | [optional] **HasPin** | **bool** | Boolean to indicate whether this signature requires a PIN to access. | [optional] **HasSmsAuth** | **bool?** | Boolean to indicate whether this signature has SMS authentication enabled. | [optional] **HasSmsDelivery** | **bool?** | Boolean to indicate whether this signature has SMS delivery enabled. | [optional] **SmsPhoneNumber** | **string** | The SMS phone number used for authentication or signature request delivery. | [optional] **ReassignedBy** | **string** | Email address of original signer who reassigned to this signer. | [optional] **ReassignmentReason** | **string** | Reason provided by original signer who reassigned to this signer. | [optional] **ReassignedFrom** | **string** | Previous signature identifier. | [optional] **Error** | **string** | Error message pertaining to this signer, or null. | [optional] +**SignatureId** | **string** | _t__SignatureRequestResponseSignatures::SIGNATURE_ID | [optional] **SignerGroupGuid** | **string** | _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID | [optional] **SignerEmailAddress** | **string** | _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS | [optional] **SignerName** | **string** | _t__SignatureRequestResponseSignatures::SIGNER_NAME | [optional] **SignerRole** | **string** | _t__SignatureRequestResponseSignatures::SIGNER_ROLE | [optional] **Order** | **int?** | _t__SignatureRequestResponseSignatures::ORDER | [optional] **StatusCode** | **string** | _t__SignatureRequestResponseSignatures::STATUS_CODE | [optional] **DeclineReason** | **string** | _t__SignatureRequestResponseSignatures::DECLINE_REASON | [optional] **SignedAt** | **int?** | _t__SignatureRequestResponseSignatures::SIGNED_AT | [optional] **LastViewedAt** | **int?** | _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT | [optional] **LastRemindedAt** | **int?** | _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT | [optional] **HasPin** | **bool** | _t__SignatureRequestResponseSignatures::HAS_PIN | [optional] **HasSmsAuth** | **bool?** | _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH | [optional] **HasSmsDelivery** | **bool?** | _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY | [optional] **SmsPhoneNumber** | **string** | _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER | [optional] **ReassignedBy** | **string** | _t__SignatureRequestResponseSignatures::REASSIGNED_BY | [optional] **ReassignmentReason** | **string** | _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON | [optional] **ReassignedFrom** | **string** | _t__SignatureRequestResponseSignatures::REASSIGNED_FROM | [optional] **Error** | **string** | _t__SignatureRequestResponseSignatures::ERROR | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestSendRequest.md b/sdks/dotnet/docs/SignatureRequestSendRequest.md index 000c7adec..35eebb4c4 100644 --- a/sdks/dotnet/docs/SignatureRequestSendRequest.md +++ b/sdks/dotnet/docs/SignatureRequestSendRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] +**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md index 12fc09be5..f345c0424 100644 --- a/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentBase.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentBase.md index e684c8b85..018b368fc 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentBase.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentBase.md @@ -5,7 +5,7 @@ The fields that should appear on the document, expressed as an array of objects. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**DocumentIndex** | **int** | Represents the integer index of the `file` or `file_url` document the field should be attached to. | **ApiId** | **string** | An identifier for the field that is unique across all documents in the request. | **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | **Type** | **string** | | **Width** | **int** | Size of the field in pixels. | **X** | **int** | Location coordinates of the field in pixels. | **Y** | **int** | Location coordinates of the field in pixels. | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] +**DocumentIndex** | **int** | Represents the integer index of the `file` or `file_url` document the field should be attached to. | **ApiId** | **string** | An identifier for the field that is unique across all documents in the request. | **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | **Type** | **string** | | **Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | **X** | **int** | _t__Sub::FormFieldsPerDocument::X | **Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentCheckbox.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentCheckbox.md index 3e099fb3d..a974edaef 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentCheckbox.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentCheckbox.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] **Type** | **string** | A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class. | [default to "checkbox"]**IsChecked** | **bool** | `true` for checking the checkbox field by default, otherwise `false`. | **Group** | **string** | String referencing group defined in `form_field_groups` parameter. | [optional] diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentCheckboxMerge.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentCheckboxMerge.md index 61cd72325..139e6d38c 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentCheckboxMerge.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentCheckboxMerge.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] **Type** | **string** | A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class. | [default to "checkbox-merge"] diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentDateSigned.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentDateSigned.md index 1e7bf6477..40a3abcd2 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentDateSigned.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentDateSigned.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] **Type** | **string** | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to "date_signed"]**FontFamily** | **string** | Font family for the field. | [optional] **FontSize** | **int** | 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. | [optional] [default to 12] diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentDropdown.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentDropdown.md index d23c8c62c..1b6f503fe 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentDropdown.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentDropdown.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] **Type** | **string** | An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. | [default to "dropdown"]**Options** | **List<string>** | Array of string values representing dropdown values. | **Content** | **string** | Selected value in `options` array. Value must exist in array. | [optional] **FontFamily** | **string** | Font family for the field. | [optional] **FontSize** | **int** | 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. | [optional] [default to 12] diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentHyperlink.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentHyperlink.md index aea6fa4e5..103c06443 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentHyperlink.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentHyperlink.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] **Type** | **string** | A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. | [default to "hyperlink"]**Content** | **string** | Link Text. | **ContentUrl** | **string** | Link URL. | **FontFamily** | **string** | Font family for the field. | [optional] **FontSize** | **int** | 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. | [optional] [default to 12] diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentInitials.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentInitials.md index 804786051..27fddf1a6 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentInitials.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentInitials.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] **Type** | **string** | An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class. | [default to "initials"] diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentRadio.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentRadio.md index d8b4ec7d1..fa19aa6ee 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentRadio.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentRadio.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] **Type** | **string** | An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. | [default to "radio"]**Group** | **string** | String referencing group defined in `form_field_groups` parameter. | **IsChecked** | **bool** | `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`. | diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentSignature.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentSignature.md index ed8823d70..0e7682af1 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentSignature.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentSignature.md @@ -10,9 +10,9 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] **Type** | **string** | A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. | [default to "signature"] diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentText.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentText.md index c025afe54..a50689070 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentText.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentText.md @@ -10,12 +10,12 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] -**Type** | **string** | A text input field. Use the `SubFormFieldsPerDocumentText` class. | [default to "text"]**Placeholder** | **string** | Placeholder value for text field. | [optional] **AutoFillType** | **string** | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | [optional] **LinkId** | **string** | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | [optional] **Masked** | **bool** | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | [optional] **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.

**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | [optional] **ValidationCustomRegex** | **string** | | [optional] **ValidationCustomRegexFormatLabel** | **string** | | [optional] **Content** | **string** | Content of a `me_now` text field | [optional] **FontFamily** | **string** | Font family for the field. | [optional] **FontSize** | **int** | 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. | [optional] [default to 12] +**Type** | **string** | A text input field. Use the `SubFormFieldsPerDocumentText` class. | [default to "text"]**Placeholder** | **string** | Placeholder value for text field. | [optional] **AutoFillType** | **string** | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | [optional] **LinkId** | **string** | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | [optional] **Masked** | **bool** | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | [optional] **ValidationType** | **string** | _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE | [optional] **ValidationCustomRegex** | **string** | | [optional] **ValidationCustomRegexFormatLabel** | **string** | | [optional] **Content** | **string** | Content of a `me_now` text field | [optional] **FontFamily** | **string** | Font family for the field. | [optional] **FontSize** | **int** | 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. | [optional] [default to 12] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubFormFieldsPerDocumentTextMerge.md b/sdks/dotnet/docs/SubFormFieldsPerDocumentTextMerge.md index 20fd61464..c5a8c0100 100644 --- a/sdks/dotnet/docs/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/dotnet/docs/SubFormFieldsPerDocumentTextMerge.md @@ -10,12 +10,12 @@ Name | Type | Description | Notes **Height** | **int** | Size of the field in pixels. | **Required** | **bool** | Whether this field is required. | **Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | -**Width** | **int** | Size of the field in pixels. | -**X** | **int** | Location coordinates of the field in pixels. | -**Y** | **int** | Location coordinates of the field in pixels. | +**Width** | **int** | _t__Sub::FormFieldsPerDocument::WIDTH | +**X** | **int** | _t__Sub::FormFieldsPerDocument::X | +**Y** | **int** | _t__Sub::FormFieldsPerDocument::Y | **Name** | **string** | Display name for the field. | [optional] **Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional] -**Type** | **string** | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to "text-merge"]**FontFamily** | **string** | Font family for the field. | [optional] **FontSize** | **int** | 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. | [optional] [default to 12] +**Type** | **string** | _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE | [default to "text-merge"]**FontFamily** | **string** | Font family for the field. | [optional] **FontSize** | **int** | 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. | [optional] [default to 12] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubMergeField.md b/sdks/dotnet/docs/SubMergeField.md index d87cc9044..3c88a73cf 100644 --- a/sdks/dotnet/docs/SubMergeField.md +++ b/sdks/dotnet/docs/SubMergeField.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the merge field. Must be unique. | **Type** | **string** | The type of merge field. | +**Name** | **string** | _t__Sub::MergeField::NAME | **Type** | **string** | _t__Sub::MergeField::TYPE | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubOAuth.md b/sdks/dotnet/docs/SubOAuth.md index 6c5bf7d33..f42701e78 100644 --- a/sdks/dotnet/docs/SubOAuth.md +++ b/sdks/dotnet/docs/SubOAuth.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SubOAuth -OAuth related parameters. +_t__Sub::OAuth::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CallbackUrl** | **string** | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | [optional] **Scopes** | **List<SubOAuth.ScopesEnum>** | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | [optional] +**CallbackUrl** | **string** | _t__Sub::OAuth::CALLBACK_URL | [optional] **Scopes** | **List<SubOAuth.ScopesEnum>** | _t__Sub::OAuth::SCOPES | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubOptions.md b/sdks/dotnet/docs/SubOptions.md index c38a7f9b5..38fd3b3de 100644 --- a/sdks/dotnet/docs/SubOptions.md +++ b/sdks/dotnet/docs/SubOptions.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SubOptions -Additional options supported by API App. +_t__Sub::Options::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CanInsertEverywhere** | **bool** | Determines if signers can use "Insert Everywhere" when signing a document. | [optional] [default to false] +**CanInsertEverywhere** | **bool** | _t__Sub::Options::CAN_INSERT_EVERYWHERE | [optional] [default to false] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubSignatureRequestGroupedSigners.md b/sdks/dotnet/docs/SubSignatureRequestGroupedSigners.md index b37cae03b..cb9655ab1 100644 --- a/sdks/dotnet/docs/SubSignatureRequestGroupedSigners.md +++ b/sdks/dotnet/docs/SubSignatureRequestGroupedSigners.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Group** | **string** | The name of the group. | **Signers** | [**List<SubSignatureRequestSigner>**](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. | **Order** | **int?** | The order the group is required to sign in. Use this instead of Signer-level `order`. | [optional] +**Group** | **string** | _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME | **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestGroupedSigners::SIGNERS | **Order** | **int?** | _t__Sub::SignatureRequestGroupedSigners::ORDER | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubSignatureRequestSigner.md b/sdks/dotnet/docs/SubSignatureRequestSigner.md index 4357879ce..29c56cdd4 100644 --- a/sdks/dotnet/docs/SubSignatureRequestSigner.md +++ b/sdks/dotnet/docs/SubSignatureRequestSigner.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the signer. | **EmailAddress** | **string** | The email address of the signer. | **Order** | **int?** | The order the signer is required to sign in. | [optional] **Pin** | **string** | The 4- to 12-character access code that will secure this signer's signature page. | [optional] **SmsPhoneNumber** | **string** | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | [optional] **SmsPhoneNumberType** | **string** | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | [optional] +**Name** | **string** | _t__Sub::SignatureRequestSigner::SIGNER_NAME | **EmailAddress** | **string** | _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS | **Order** | **int?** | _t__Sub::SignatureRequestSigner::SIGNER_ORDER | [optional] **Pin** | **string** | _t__Sub::SignatureRequestSigner::SIGNER_PIN | [optional] **SmsPhoneNumber** | **string** | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER | [optional] **SmsPhoneNumberType** | **string** | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubSignatureRequestTemplateSigner.md b/sdks/dotnet/docs/SubSignatureRequestTemplateSigner.md index 5789681fb..ff9ae9613 100644 --- a/sdks/dotnet/docs/SubSignatureRequestTemplateSigner.md +++ b/sdks/dotnet/docs/SubSignatureRequestTemplateSigner.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Role** | **string** | Must match an existing role in chosen Template(s). It's case-sensitive. | **Name** | **string** | The name of the signer. | **EmailAddress** | **string** | The email address of the signer. | **Pin** | **string** | The 4- to 12-character access code that will secure this signer's signature page. | [optional] **SmsPhoneNumber** | **string** | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | [optional] **SmsPhoneNumberType** | **string** | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | [optional] +**Role** | **string** | _t__Sub::SignatureRequestTemplateSigner::ROLE | **Name** | **string** | _t__Sub::SignatureRequestTemplateSigner::NAME | **EmailAddress** | **string** | _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS | **Pin** | **string** | _t__Sub::SignatureRequestTemplateSigner::PIN | [optional] **SmsPhoneNumber** | **string** | _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER | [optional] **SmsPhoneNumberType** | **string** | _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubSigningOptions.md b/sdks/dotnet/docs/SubSigningOptions.md index a65674196..10b9320cf 100644 --- a/sdks/dotnet/docs/SubSigningOptions.md +++ b/sdks/dotnet/docs/SubSigningOptions.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +_t__Sub::SigningOptions::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**DefaultType** | **string** | The default type shown (limited to the listed types) | **Draw** | **bool** | Allows drawing the signature | [optional] [default to false]**Phone** | **bool** | Allows using a smartphone to email the signature | [optional] [default to false]**Type** | **bool** | Allows typing the signature | [optional] [default to false]**Upload** | **bool** | Allows uploading the signature | [optional] [default to false] +**DefaultType** | **string** | _t__Sub::SigningOptions::DEFAULT | **Draw** | **bool** | _t__Sub::SigningOptions::DRAW | [optional] [default to false]**Phone** | **bool** | _t__Sub::SigningOptions::PHONE | [optional] [default to false]**Type** | **bool** | _t__Sub::SigningOptions::TYPE | [optional] [default to false]**Upload** | **bool** | _t__Sub::SigningOptions::UPLOAD | [optional] [default to false] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubTeamResponse.md b/sdks/dotnet/docs/SubTeamResponse.md index b2c09e6c7..ae81f6af0 100644 --- a/sdks/dotnet/docs/SubTeamResponse.md +++ b/sdks/dotnet/docs/SubTeamResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TeamId** | **string** | The id of a team | [optional] **Name** | **string** | The name of a team | [optional] +**TeamId** | **string** | _t__TeamGeneral::TEAM_ID | [optional] **Name** | **string** | _t__TeamGeneral::NAME | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubTemplateRole.md b/sdks/dotnet/docs/SubTemplateRole.md index ecf59c54c..b2554e664 100644 --- a/sdks/dotnet/docs/SubTemplateRole.md +++ b/sdks/dotnet/docs/SubTemplateRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The role name of the signer that will be displayed when the template is used to create a signature request. | [optional] **Order** | **int?** | The order in which this signer role is required to sign. | [optional] +**Name** | **string** | _t__Sub::SignerRole::NAME | [optional] **Order** | **int?** | _t__Sub::SignerRole::ORDER | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubUnclaimedDraftSigner.md b/sdks/dotnet/docs/SubUnclaimedDraftSigner.md index 46bdfda3b..815d7af6b 100644 --- a/sdks/dotnet/docs/SubUnclaimedDraftSigner.md +++ b/sdks/dotnet/docs/SubUnclaimedDraftSigner.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**EmailAddress** | **string** | The email address of the signer. | **Name** | **string** | The name of the signer. | **Order** | **int?** | The order the signer is required to sign in. | [optional] +**EmailAddress** | **string** | _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS | **Name** | **string** | _t__Sub::UnclaimedDraftSigner::NAME | **Order** | **int?** | _t__Sub::UnclaimedDraftSigner::ORDER | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubUnclaimedDraftTemplateSigner.md b/sdks/dotnet/docs/SubUnclaimedDraftTemplateSigner.md index 43be64a68..324f70942 100644 --- a/sdks/dotnet/docs/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/dotnet/docs/SubUnclaimedDraftTemplateSigner.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Role** | **string** | Must match an existing role in chosen Template(s). | **Name** | **string** | The name of the signer filling the role of `role`. | **EmailAddress** | **string** | The email address of the signer filling the role of `role`. | +**Role** | **string** | _t__Sub::UnclaimedDraftTemplateSigner::ROLE | **Name** | **string** | _t__Sub::UnclaimedDraftTemplateSigner::NAME | **EmailAddress** | **string** | _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SubWhiteLabelingOptions.md b/sdks/dotnet/docs/SubWhiteLabelingOptions.md index 1634a1afb..0bf5a4812 100644 --- a/sdks/dotnet/docs/SubWhiteLabelingOptions.md +++ b/sdks/dotnet/docs/SubWhiteLabelingOptions.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SubWhiteLabelingOptions -An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. +_t__Sub::WhiteLabelingOptions::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**HeaderBackgroundColor** | **string** | | [optional] [default to "#1a1a1a"]**LegalVersion** | **string** | | [optional] [default to LegalVersionEnum.Terms1]**LinkColor** | **string** | | [optional] [default to "#0061FE"]**PageBackgroundColor** | **string** | | [optional] [default to "#f7f8f9"]**PrimaryButtonColor** | **string** | | [optional] [default to "#0061FE"]**PrimaryButtonColorHover** | **string** | | [optional] [default to "#0061FE"]**PrimaryButtonTextColor** | **string** | | [optional] [default to "#ffffff"]**PrimaryButtonTextColorHover** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonColor** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonColorHover** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonTextColor** | **string** | | [optional] [default to "#0061FE"]**SecondaryButtonTextColorHover** | **string** | | [optional] [default to "#0061FE"]**TextColor1** | **string** | | [optional] [default to "#808080"]**TextColor2** | **string** | | [optional] [default to "#ffffff"]**ResetToDefault** | **bool** | Resets white labeling options to defaults. Only useful when updating an API App. | [optional] +**HeaderBackgroundColor** | **string** | | [optional] [default to "#1a1a1a"]**LegalVersion** | **string** | | [optional] [default to LegalVersionEnum.Terms1]**LinkColor** | **string** | | [optional] [default to "#0061FE"]**PageBackgroundColor** | **string** | | [optional] [default to "#f7f8f9"]**PrimaryButtonColor** | **string** | | [optional] [default to "#0061FE"]**PrimaryButtonColorHover** | **string** | | [optional] [default to "#0061FE"]**PrimaryButtonTextColor** | **string** | | [optional] [default to "#ffffff"]**PrimaryButtonTextColorHover** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonColor** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonColorHover** | **string** | | [optional] [default to "#ffffff"]**SecondaryButtonTextColor** | **string** | | [optional] [default to "#0061FE"]**SecondaryButtonTextColorHover** | **string** | | [optional] [default to "#0061FE"]**TextColor1** | **string** | | [optional] [default to "#808080"]**TextColor2** | **string** | | [optional] [default to "#ffffff"]**ResetToDefault** | **bool** | _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TeamGetInfoResponse.md b/sdks/dotnet/docs/TeamGetInfoResponse.md index b0f876e55..bbb6c92a0 100644 --- a/sdks/dotnet/docs/TeamGetInfoResponse.md +++ b/sdks/dotnet/docs/TeamGetInfoResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Team** | [**TeamInfoResponse**](TeamInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Team** | [**TeamInfoResponse**](TeamInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TeamGetResponse.md b/sdks/dotnet/docs/TeamGetResponse.md index a3a82936a..a56c3a763 100644 --- a/sdks/dotnet/docs/TeamGetResponse.md +++ b/sdks/dotnet/docs/TeamGetResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Team** | [**TeamResponse**](TeamResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Team** | [**TeamResponse**](TeamResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TeamInfoResponse.md b/sdks/dotnet/docs/TeamInfoResponse.md index 8f487d8bf..ed1671a8c 100644 --- a/sdks/dotnet/docs/TeamInfoResponse.md +++ b/sdks/dotnet/docs/TeamInfoResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TeamId** | **string** | The id of a team | [optional] **TeamParent** | [**TeamParentResponse**](TeamParentResponse.md) | | [optional] **Name** | **string** | The name of a team | [optional] **NumMembers** | **int** | Number of members within a team | [optional] **NumSubTeams** | **int** | Number of sub teams within a team | [optional] +**TeamId** | **string** | _t__TeamGeneral::TEAM_ID | [optional] **TeamParent** | [**TeamParentResponse**](TeamParentResponse.md) | | [optional] **Name** | **string** | _t__TeamGeneral::NAME | [optional] **NumMembers** | **int** | _t__TeamGeneral::NUM_MEMBERS | [optional] **NumSubTeams** | **int** | _t__TeamGeneral::NUM_SUB_TEAMS | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TeamParentResponse.md b/sdks/dotnet/docs/TeamParentResponse.md index 6db34d85e..319f4d7b2 100644 --- a/sdks/dotnet/docs/TeamParentResponse.md +++ b/sdks/dotnet/docs/TeamParentResponse.md @@ -5,7 +5,7 @@ Information about the parent team if a team has one, set to `null` otherwise. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TeamId** | **string** | The id of a team | [optional] **Name** | **string** | The name of a team | [optional] +**TeamId** | **string** | _t__TeamGeneral::TEAM_ID | [optional] **Name** | **string** | _t__TeamGeneral::NAME | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TeamResponse.md b/sdks/dotnet/docs/TeamResponse.md index 977696c0a..edc2edf59 100644 --- a/sdks/dotnet/docs/TeamResponse.md +++ b/sdks/dotnet/docs/TeamResponse.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TeamResponse -Contains information about your team and its members +_t__TeamResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of your Team | [optional] **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | [optional] **InvitedAccounts** | [**List<AccountResponse>**](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`. | [optional] **InvitedEmails** | **List<string>** | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | [optional] +**Name** | **string** | _t__Team::NAME | [optional] **Accounts** | [**List<AccountResponse>**](AccountResponse.md) | | [optional] **InvitedAccounts** | [**List<AccountResponse>**](AccountResponse.md) | _t__Team::INVITED_ACCOUNTS | [optional] **InvitedEmails** | **List<string>** | _t__Team::INVITED_EMAILS | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md index 299d6feef..c76ea1e4f 100644 --- a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [optional] [default to true]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | [optional] **Message** | **string** | The default template email message. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**SignerRoles** | [**List<SubTemplateRole>**](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The template title (alias). | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UsePreexistingFields** | **bool** | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [optional] [default to false] +**ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [optional] [default to true]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | [optional] **CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | [optional] **Message** | **string** | The default template email message. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**SignerRoles** | [**List<SubTemplateRole>**](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The template title (alias). | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UsePreexistingFields** | **bool** | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [optional] [default to false] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponse.md b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponse.md index b3a03c05a..8c82a53aa 100644 --- a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Template** | [**TemplateCreateEmbeddedDraftResponseTemplate**](TemplateCreateEmbeddedDraftResponseTemplate.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Template** | [**TemplateCreateEmbeddedDraftResponseTemplate**](TemplateCreateEmbeddedDraftResponseTemplate.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index d23893dd3..1a60e95fe 100644 --- a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateCreateEmbeddedDraftResponseTemplate -Template object with parameters: `template_id`, `edit_url`, `expires_at`. +_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **EditUrl** | **string** | Link to edit the template. | [optional] **ExpiresAt** | **int** | When the link expires. | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**TemplateId** | **string** | _t__TemplateResponse::TEMPLATE_ID | [optional] **EditUrl** | **string** | _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL | [optional] **ExpiresAt** | **int** | _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateCreateRequest.md b/sdks/dotnet/docs/TemplateCreateRequest.md index 9a80d0c9a..038ef8d3d 100644 --- a/sdks/dotnet/docs/TemplateCreateRequest.md +++ b/sdks/dotnet/docs/TemplateCreateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | **SignerRoles** | [**List<SubTemplateRole>**](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional] **ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | [optional] **Message** | **string** | The default template email message. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **Subject** | **string** | The template title (alias). | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UsePreexistingFields** | **bool** | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [optional] [default to false] +**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | **SignerRoles** | [**List<SubTemplateRole>**](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | [optional] **CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional] **ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | [optional] **Message** | **string** | The default template email message. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **Subject** | **string** | The template title (alias). | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UsePreexistingFields** | **bool** | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [optional] [default to false] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateCreateResponse.md b/sdks/dotnet/docs/TemplateCreateResponse.md index 75bab14de..6d6abd48d 100644 --- a/sdks/dotnet/docs/TemplateCreateResponse.md +++ b/sdks/dotnet/docs/TemplateCreateResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Template** | [**TemplateCreateResponseTemplate**](TemplateCreateResponseTemplate.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Template** | [**TemplateCreateResponseTemplate**](TemplateCreateResponseTemplate.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateCreateResponseTemplate.md b/sdks/dotnet/docs/TemplateCreateResponseTemplate.md index 85941fc4e..8a9217b0a 100644 --- a/sdks/dotnet/docs/TemplateCreateResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateCreateResponseTemplate.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateCreateResponseTemplate -Template object with parameters: `template_id`. +_t__TemplateCreateResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] +**TemplateId** | **string** | _t__TemplateResponse::TEMPLATE_ID | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateEditResponse.md b/sdks/dotnet/docs/TemplateEditResponse.md index 830c7a9ed..d142128ef 100644 --- a/sdks/dotnet/docs/TemplateEditResponse.md +++ b/sdks/dotnet/docs/TemplateEditResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | +**TemplateId** | **string** | _t__TemplateResponse::TEMPLATE_ID | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateGetResponse.md b/sdks/dotnet/docs/TemplateGetResponse.md index 7a301e17d..b73677265 100644 --- a/sdks/dotnet/docs/TemplateGetResponse.md +++ b/sdks/dotnet/docs/TemplateGetResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Template** | [**TemplateResponse**](TemplateResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Template** | [**TemplateResponse**](TemplateResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateListResponse.md b/sdks/dotnet/docs/TemplateListResponse.md index 7bb37dc6b..a847011ee 100644 --- a/sdks/dotnet/docs/TemplateListResponse.md +++ b/sdks/dotnet/docs/TemplateListResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Templates** | [**List<TemplateResponse>**](TemplateResponse.md) | List of templates that the API caller has access to. | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**Templates** | [**List<TemplateResponse>**](TemplateResponse.md) | _t__TemplateListResponse::DESCRIPTION | **ListInfo** | [**ListInfoResponse**](ListInfoResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponse.md b/sdks/dotnet/docs/TemplateResponse.md index e801ef14b..680f03b8a 100644 --- a/sdks/dotnet/docs/TemplateResponse.md +++ b/sdks/dotnet/docs/TemplateResponse.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateResponse -Contains information about the templates you and your team have created. +_t__TemplateResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] +**TemplateId** | **string** | _t__TemplateResponse::TEMPLATE_ID | [optional] **Title** | **string** | _t__TemplateResponse::TITLE | [optional] **Message** | **string** | _t__TemplateResponse::MESSAGE | [optional] **UpdatedAt** | **int** | _t__TemplateResponse::UPDATED_AT | [optional] **IsEmbedded** | **bool?** | _t__TemplateResponse::IS_EMBEDDED | [optional] **IsCreator** | **bool** | _t__TemplateResponse::IS_CREATOR | [optional] **CanEdit** | **bool** | _t__TemplateResponse::CAN_EDIT | [optional] **IsLocked** | **bool** | _t__TemplateResponse::IS_LOCKED | [optional] **Metadata** | **Dictionary<string, Object>** | _t__TemplateResponse::METADATA | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | _t__TemplateResponse::SIGNER_ROLES | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | _t__TemplateResponse::CC_ROLES | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | _t__TemplateResponse::DOCUMENTS | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseCustomField::DESCRIPTION | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseNamedFormField::DESCRIPTION | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | _t__TemplateResponse::ACCOUNTS | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseAccount.md b/sdks/dotnet/docs/TemplateResponseAccount.md index b69b4ebaa..85c514bde 100644 --- a/sdks/dotnet/docs/TemplateResponseAccount.md +++ b/sdks/dotnet/docs/TemplateResponseAccount.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | **string** | The id of the Account. | [optional] **EmailAddress** | **string** | The email address associated with the Account. | [optional] **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | [optional] **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | [optional] **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | [optional] **Quotas** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.md) | | [optional] +**AccountId** | **string** | _t__TemplateResponseAccount::ACCOUNT_ID | [optional] **EmailAddress** | **string** | _t__TemplateResponseAccount::EMAIL_ADDRESS | [optional] **IsLocked** | **bool** | _t__TemplateResponseAccount::IS_LOCKED | [optional] **IsPaidHs** | **bool** | _t__TemplateResponseAccount::IS_PAID_HS | [optional] **IsPaidHf** | **bool** | _t__TemplateResponseAccount::IS_PAID_HF | [optional] **Quotas** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseAccountQuota.md b/sdks/dotnet/docs/TemplateResponseAccountQuota.md index 5051dc54f..eb64aee69 100644 --- a/sdks/dotnet/docs/TemplateResponseAccountQuota.md +++ b/sdks/dotnet/docs/TemplateResponseAccountQuota.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateResponseAccountQuota -An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. +_t__TemplateResponseAccountQuota::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplatesLeft** | **int** | API templates remaining. | [optional] **ApiSignatureRequestsLeft** | **int** | API signature requests remaining. | [optional] **DocumentsLeft** | **int** | Signature requests remaining. | [optional] **SmsVerificationsLeft** | **int** | SMS verifications remaining. | [optional] +**TemplatesLeft** | **int** | _t__TemplateResponseAccountQuota::TEMPLATES_LEFT | [optional] **ApiSignatureRequestsLeft** | **int** | _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT | [optional] **DocumentsLeft** | **int** | _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT | [optional] **SmsVerificationsLeft** | **int** | _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseCCRole.md b/sdks/dotnet/docs/TemplateResponseCCRole.md index 1e8067443..d6335dc7f 100644 --- a/sdks/dotnet/docs/TemplateResponseCCRole.md +++ b/sdks/dotnet/docs/TemplateResponseCCRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Role. | [optional] +**Name** | **string** | _t__TemplateResponseCCRole::NAME | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocument.md b/sdks/dotnet/docs/TemplateResponseDocument.md index 6847d7b3c..7e4808545 100644 --- a/sdks/dotnet/docs/TemplateResponseDocument.md +++ b/sdks/dotnet/docs/TemplateResponseDocument.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | Name of the associated file. | [optional] **Index** | **int** | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | [optional] **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | [optional] **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | [optional] +**Name** | **string** | _t__TemplateResponseDocument::NAME | [optional] **Index** | **int** | _t__TemplateResponseDocument::INDEX | [optional] **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | _t__TemplateResponseDocument::FIELD_GROUPS | [optional] **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseDocumentFormField::DESCRIPTION | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseDocumentCustomField::DESCRIPTION | [optional] **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | _t__TemplateResponseDocumentStaticField::DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md index 9f349a7ab..f4cee1399 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateResponseDocumentCustomFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentCustomField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | | **ApiId** | **string** | The unique ID for this field. | [optional] **Name** | **string** | The name of the Custom Field. | [optional] **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] +**Type** | **string** | | **ApiId** | **string** | _t__TemplateResponseDocumentCustomField::API_ID | [optional] **Name** | **string** | _t__TemplateResponseDocumentCustomField::NAME | [optional] **Signer** | **string** | _t__TemplateResponseDocumentCustomField::SIGNER | [optional] **X** | **int** | _t__TemplateResponseDocumentCustomField::X | [optional] **Y** | **int** | _t__TemplateResponseDocumentCustomField::Y | [optional] **Width** | **int** | _t__TemplateResponseDocumentCustomField::WIDTH | [optional] **Height** | **int** | _t__TemplateResponseDocumentCustomField::HEIGHT | [optional] **Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] **Group** | **string** | _t__TemplateResponseDocumentCustomField::GROUP | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md index 11a948265..1b2a89bc7 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentCustomFieldCheckbox -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**Name** | **string** | The name of the Custom Field. | [optional] -**Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "checkbox"] +**ApiId** | **string** | _t__TemplateResponseDocumentCustomField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentCustomField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentCustomField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentCustomField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentCustomField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentCustomField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentCustomField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentCustomField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentCustomField::TYPE | [default to "checkbox"] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md index 8db16365b..b4a001070 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentCustomFieldText -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**Name** | **string** | The name of the Custom Field. | [optional] -**Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] +**ApiId** | **string** | _t__TemplateResponseDocumentCustomField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentCustomField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentCustomField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentCustomField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentCustomField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentCustomField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentCustomField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentCustomField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentCustomField::TYPE | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | _t__TemplateResponseDocumentCustomField::IS_MULTILINE | [optional] **OriginalFontSize** | **int** | _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE | [optional] **FontFamily** | **string** | _t__TemplateResponseDocumentCustomField::FONT_FAMILY | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md index 0dfac711c..7d404982b 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the form field group. | [optional] **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.md) | | [optional] +**Name** | **string** | _t__TemplateResponseDocumentFieldGroup::NAME | [optional] **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md index 44dd2eb4a..ad00fb9fc 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFieldGroupRule -The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). +_t__TemplateResponseDocumentFieldGroup::RULE ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. | [optional] **GroupLabel** | **string** | Name of the group | [optional] +**Requirement** | **string** | _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT | [optional] **GroupLabel** | **string** | _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md index 191f73cd2..39444105f 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFormFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentFormField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | | **ApiId** | **string** | A unique id for the form field. | [optional] **Name** | **string** | The name of the form field. | [optional] **Signer** | **string** | The signer of the Form Field. | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**Type** | **string** | | **ApiId** | **string** | _t__TemplateResponseDocumentFormField::API_ID | [optional] **Name** | **string** | _t__TemplateResponseDocumentFormField::NAME | [optional] **Signer** | **string** | _t__TemplateResponseDocumentFormField::SIGNER | [optional] **X** | **int** | _t__TemplateResponseDocumentFormField::X | [optional] **Y** | **int** | _t__TemplateResponseDocumentFormField::Y | [optional] **Width** | **int** | _t__TemplateResponseDocumentFormField::WIDTH | [optional] **Height** | **int** | _t__TemplateResponseDocumentFormField::HEIGHT | [optional] **Required** | **bool** | _t__TemplateResponseDocumentFormField::REQUIRED | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md index 4a94b377c..db33bc632 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -1,19 +1,19 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFormFieldCheckbox -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "checkbox"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | _t__TemplateResponseDocumentFormField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentFormField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentFormField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentFormField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentFormField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentFormField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentFormField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentFormField::REQUIRED | [optional] +**Type** | **string** | _t__TemplateResponseDocumentFormField::TYPE | [default to "checkbox"]**Group** | **string** | _t__TemplateResponseDocumentFormField::GROUP | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md index 7356475f5..b9d73346e 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -1,19 +1,19 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFormFieldDateSigned -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "date_signed"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | _t__TemplateResponseDocumentFormField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentFormField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentFormField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentFormField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentFormField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentFormField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentFormField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentFormField::REQUIRED | [optional] +**Type** | **string** | _t__TemplateResponseDocumentFormField::TYPE | [default to "date_signed"]**Group** | **string** | _t__TemplateResponseDocumentFormField::GROUP | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md index 62b9123c6..86230980d 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -1,19 +1,19 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFormFieldDropdown -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "dropdown"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | _t__TemplateResponseDocumentFormField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentFormField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentFormField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentFormField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentFormField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentFormField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentFormField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentFormField::REQUIRED | [optional] +**Type** | **string** | _t__TemplateResponseDocumentFormField::TYPE | [default to "dropdown"]**Group** | **string** | _t__TemplateResponseDocumentFormField::GROUP | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md index 51222f57a..6ddd8471b 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -1,19 +1,19 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFormFieldHyperlink -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | _t__TemplateResponseDocumentFormField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentFormField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentFormField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentFormField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentFormField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentFormField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentFormField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentFormField::REQUIRED | [optional] +**Type** | **string** | _t__TemplateResponseDocumentFormField::TYPE | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | _t__TemplateResponseDocumentFormField::IS_MULTILINE | [optional] **OriginalFontSize** | **int** | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | [optional] **FontFamily** | **string** | _t__TemplateResponseDocumentFormField::FONT_FAMILY | [optional] **Group** | **string** | _t__TemplateResponseDocumentFormField::GROUP | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md index d519b4978..b14944f63 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md @@ -1,19 +1,19 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFormFieldInitials -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "initials"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | _t__TemplateResponseDocumentFormField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentFormField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentFormField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentFormField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentFormField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentFormField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentFormField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentFormField::REQUIRED | [optional] +**Type** | **string** | _t__TemplateResponseDocumentFormField::TYPE | [default to "initials"]**Group** | **string** | _t__TemplateResponseDocumentFormField::GROUP | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md index 52f877294..6ab1efe58 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md @@ -1,19 +1,19 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFormFieldRadio -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "radio"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | +**ApiId** | **string** | _t__TemplateResponseDocumentFormField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentFormField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentFormField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentFormField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentFormField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentFormField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentFormField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentFormField::REQUIRED | [optional] +**Type** | **string** | _t__TemplateResponseDocumentFormField::TYPE | [default to "radio"]**Group** | **string** | _t__TemplateResponseDocumentFormField::GROUP | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md index f173e61f1..6701ba2b7 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md @@ -1,19 +1,19 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFormFieldSignature -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "signature"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | _t__TemplateResponseDocumentFormField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentFormField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentFormField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentFormField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentFormField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentFormField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentFormField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentFormField::REQUIRED | [optional] +**Type** | **string** | _t__TemplateResponseDocumentFormField::TYPE | [default to "signature"]**Group** | **string** | _t__TemplateResponseDocumentFormField::GROUP | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md index 3005e1033..a758b1376 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md @@ -1,19 +1,19 @@ # Dropbox.Sign.Model.TemplateResponseDocumentFormFieldText -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] **ValidationCustomRegex** | **string** | When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. | [optional] **ValidationCustomRegexFormatLabel** | **string** | When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | _t__TemplateResponseDocumentFormField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentFormField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentFormField::SIGNER | [optional] +**X** | **int** | _t__TemplateResponseDocumentFormField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentFormField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentFormField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentFormField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentFormField::REQUIRED | [optional] +**Type** | **string** | _t__TemplateResponseDocumentFormField::TYPE | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | _t__TemplateResponseDocumentFormField::IS_MULTILINE | [optional] **OriginalFontSize** | **int** | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | [optional] **FontFamily** | **string** | _t__TemplateResponseDocumentFormField::FONT_FAMILY | [optional] **ValidationType** | **string** | _t__TemplateResponseDocumentFormField::VALIDATION_TYPE | [optional] **ValidationCustomRegex** | **string** | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX | [optional] **ValidationCustomRegexFormatLabel** | **string** | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL | [optional] **Group** | **string** | _t__TemplateResponseDocumentFormField::GROUP | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md index b147460c8..02d633b07 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldBase -An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. +_t__TemplateResponseDocumentStaticField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | | **ApiId** | **string** | A unique id for the static field. | [optional] **Name** | **string** | The name of the static field. | [optional] **Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"]**X** | **int** | The horizontal offset in pixels for this static field. | [optional] **Y** | **int** | The vertical offset in pixels for this static field. | [optional] **Width** | **int** | The width in pixels of this static field. | [optional] **Height** | **int** | The height in pixels of this static field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] +**Type** | **string** | | **ApiId** | **string** | _t__TemplateResponseDocumentStaticField::API_ID | [optional] **Name** | **string** | _t__TemplateResponseDocumentStaticField::NAME | [optional] **Signer** | **string** | _t__TemplateResponseDocumentStaticField::SIGNER | [optional] [default to "me_now"]**X** | **int** | _t__TemplateResponseDocumentStaticField::X | [optional] **Y** | **int** | _t__TemplateResponseDocumentStaticField::Y | [optional] **Width** | **int** | _t__TemplateResponseDocumentStaticField::WIDTH | [optional] **Height** | **int** | _t__TemplateResponseDocumentStaticField::HEIGHT | [optional] **Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] **Group** | **string** | _t__TemplateResponseDocumentStaticField::GROUP | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md index cfa9ccb8c..7783e2058 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldCheckbox -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "checkbox"] +**ApiId** | **string** | _t__TemplateResponseDocumentStaticField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentStaticField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentStaticField::SIGNER | [optional] [default to "me_now"] +**X** | **int** | _t__TemplateResponseDocumentStaticField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentStaticField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentStaticField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentStaticField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentStaticField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentStaticField::TYPE | [default to "checkbox"] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md index bae7b8ab4..a85ac6826 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldDateSigned -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "date_signed"] +**ApiId** | **string** | _t__TemplateResponseDocumentStaticField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentStaticField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentStaticField::SIGNER | [optional] [default to "me_now"] +**X** | **int** | _t__TemplateResponseDocumentStaticField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentStaticField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentStaticField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentStaticField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentStaticField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentStaticField::TYPE | [default to "date_signed"] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md index 7815923f9..983a6087d 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldDropdown -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "dropdown"] +**ApiId** | **string** | _t__TemplateResponseDocumentStaticField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentStaticField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentStaticField::SIGNER | [optional] [default to "me_now"] +**X** | **int** | _t__TemplateResponseDocumentStaticField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentStaticField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentStaticField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentStaticField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentStaticField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentStaticField::TYPE | [default to "dropdown"] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md index 81b419793..4b04f995a 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldHyperlink -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "hyperlink"] +**ApiId** | **string** | _t__TemplateResponseDocumentStaticField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentStaticField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentStaticField::SIGNER | [optional] [default to "me_now"] +**X** | **int** | _t__TemplateResponseDocumentStaticField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentStaticField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentStaticField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentStaticField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentStaticField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentStaticField::TYPE | [default to "hyperlink"] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md index a9dae476b..85a64e818 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldInitials -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "initials"] +**ApiId** | **string** | _t__TemplateResponseDocumentStaticField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentStaticField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentStaticField::SIGNER | [optional] [default to "me_now"] +**X** | **int** | _t__TemplateResponseDocumentStaticField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentStaticField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentStaticField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentStaticField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentStaticField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentStaticField::TYPE | [default to "initials"] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md index a13dc60d2..56f3ac4e1 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldRadio -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "radio"] +**ApiId** | **string** | _t__TemplateResponseDocumentStaticField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentStaticField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentStaticField::SIGNER | [optional] [default to "me_now"] +**X** | **int** | _t__TemplateResponseDocumentStaticField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentStaticField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentStaticField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentStaticField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentStaticField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentStaticField::TYPE | [default to "radio"] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md index 7d2481d97..ef7d610bb 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldSignature -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "signature"] +**ApiId** | **string** | _t__TemplateResponseDocumentStaticField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentStaticField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentStaticField::SIGNER | [optional] [default to "me_now"] +**X** | **int** | _t__TemplateResponseDocumentStaticField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentStaticField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentStaticField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentStaticField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentStaticField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentStaticField::TYPE | [default to "signature"] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md index b44f3f3e4..e84bad7bc 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md @@ -1,20 +1,20 @@ # Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldText -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "text"] +**ApiId** | **string** | _t__TemplateResponseDocumentStaticField::API_ID | [optional] +**Name** | **string** | _t__TemplateResponseDocumentStaticField::NAME | [optional] +**Signer** | **string** | _t__TemplateResponseDocumentStaticField::SIGNER | [optional] [default to "me_now"] +**X** | **int** | _t__TemplateResponseDocumentStaticField::X | [optional] +**Y** | **int** | _t__TemplateResponseDocumentStaticField::Y | [optional] +**Width** | **int** | _t__TemplateResponseDocumentStaticField::WIDTH | [optional] +**Height** | **int** | _t__TemplateResponseDocumentStaticField::HEIGHT | [optional] +**Required** | **bool** | _t__TemplateResponseDocumentStaticField::REQUIRED | [optional] +**Group** | **string** | _t__TemplateResponseDocumentStaticField::GROUP | [optional] +**Type** | **string** | _t__TemplateResponseDocumentStaticField::TYPE | [default to "text"] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md b/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md index a2773f068..1933f1764 100644 --- a/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateResponseFieldAvgTextLength -Average text length in this field. +_t__TemplateResponseFieldAvgTextLength::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**NumLines** | **int** | Number of lines. | [optional] **NumCharsPerLine** | **int** | Number of characters per line. | [optional] +**NumLines** | **int** | _t__TemplateResponseFieldAvgTextLength::NUM_LINES | [optional] **NumCharsPerLine** | **int** | _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseSignerRole.md b/sdks/dotnet/docs/TemplateResponseSignerRole.md index ddead2a48..7088b7480 100644 --- a/sdks/dotnet/docs/TemplateResponseSignerRole.md +++ b/sdks/dotnet/docs/TemplateResponseSignerRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Role. | [optional] **Order** | **int** | If signer order is assigned this is the 0-based index for this role. | [optional] +**Name** | **string** | _t__TemplateResponseSignerRole::NAME | [optional] **Order** | **int** | _t__TemplateResponseSignerRole::ORDER | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md index 390961e68..8442da60b 100644 --- a/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.TemplateUpdateFilesResponseTemplate -Contains template id +_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**TemplateId** | **string** | _t__TemplateResponse::TEMPLATE_ID | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md index d3bc89c77..d727ca1ff 100644 --- a/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | **RequesterEmailAddress** | **string** | The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [optional] [default to true]**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **ForceSignerPage** | **bool** | Provide users the ability to review/edit the signers. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the subject and message. | [optional] [default to false]**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [optional] [default to false]**HoldRequest** | **bool** | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [optional] [default to false]**IsForEmbeddedSigning** | **bool** | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **RequestingRedirectUrl** | **string** | The URL you want signers redirected to after they successfully request a signature. | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] **ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftSigner>**](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Type** | **string** | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [optional] [default to TypeEnum.RequestSignature]**UsePreexistingFields** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**UseTextTags** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional] +**ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | **RequesterEmailAddress** | **string** | The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [optional] [default to true]**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **ForceSignerPage** | **bool** | Provide users the ability to review/edit the signers. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the subject and message. | [optional] [default to false]**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [optional] [default to false]**HoldRequest** | **bool** | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [optional] [default to false]**IsForEmbeddedSigning** | **bool** | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **RequestingRedirectUrl** | **string** | The URL you want signers redirected to after they successfully request a signature. | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] **ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftSigner>**](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Type** | **string** | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [optional] [default to TypeEnum.RequestSignature]**UsePreexistingFields** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**UseTextTags** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index d5b69549f..5d451b685 100644 --- a/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | **RequesterEmailAddress** | **string** | The email address of the user that should be designated as the requester of this draft. | **TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.

**files** or **file_urls[]** is required, but not both. | [optional] **FileUrls** | **List<string>** | Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.

**files** or **file_urls[]** is required, but not both. | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**HoldRequest** | **bool** | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [optional] [default to false]**IsForEmbeddedSigning** | **bool** | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | [optional] [default to false]**RequestingRedirectUrl** | **string** | The URL you want signers redirected to after they successfully request a signature. | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftTemplateSigner>**](SubUnclaimedDraftTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [optional] [default to false] +**ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | **RequesterEmailAddress** | **string** | The email address of the user that should be designated as the requester of this draft. | **TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.

**files** or **file_urls[]** is required, but not both. | [optional] **FileUrls** | **List<string>** | Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.

**files** or **file_urls[]** is required, but not both. | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**HoldRequest** | **bool** | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [optional] [default to false]**IsForEmbeddedSigning** | **bool** | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | [optional] [default to false]**RequestingRedirectUrl** | **string** | The URL you want signers redirected to after they successfully request a signature. | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftTemplateSigner>**](SubUnclaimedDraftTemplateSigner.md) | _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [optional] [default to false] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/UnclaimedDraftCreateRequest.md b/sdks/dotnet/docs/UnclaimedDraftCreateRequest.md index 462e91456..8c11544a0 100644 --- a/sdks/dotnet/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/dotnet/docs/UnclaimedDraftCreateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftSigner>**](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**UsePreexistingFields** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**UseTextTags** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional] +**Type** | **string** | The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | _t__Sub::Metadata::DESCRIPTION | [optional] **ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftSigner>**](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**UsePreexistingFields** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**UseTextTags** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/UnclaimedDraftCreateResponse.md b/sdks/dotnet/docs/UnclaimedDraftCreateResponse.md index 97a8f57d0..f257977b5 100644 --- a/sdks/dotnet/docs/UnclaimedDraftCreateResponse.md +++ b/sdks/dotnet/docs/UnclaimedDraftCreateResponse.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**UnclaimedDraft** | [**UnclaimedDraftResponse**](UnclaimedDraftResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**UnclaimedDraft** | [**UnclaimedDraftResponse**](UnclaimedDraftResponse.md) | | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/UnclaimedDraftResponse.md b/sdks/dotnet/docs/UnclaimedDraftResponse.md index f301ff7b9..5afad36a0 100644 --- a/sdks/dotnet/docs/UnclaimedDraftResponse.md +++ b/sdks/dotnet/docs/UnclaimedDraftResponse.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.UnclaimedDraftResponse -A group of documents that a user can take ownership of via the claim URL. +_t__UnclaimedDraftResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**SignatureRequestId** | **string** | The ID of the signature request that is represented by this UnclaimedDraft. | [optional] **ClaimUrl** | **string** | The URL to be used to claim this UnclaimedDraft. | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **RequestingRedirectUrl** | **string** | The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). | [optional] **ExpiresAt** | **int?** | When the link expires. | [optional] **TestMode** | **bool** | Whether this is a test draft. Signature requests made from test drafts have no legal value. | [optional] +**SignatureRequestId** | **string** | _t__UnclaimedDraft::SIGNATURE_REQUEST_ID | [optional] **ClaimUrl** | **string** | _t__UnclaimedDraft::CLAIM_URL | [optional] **SigningRedirectUrl** | **string** | _t__UnclaimedDraft::SIGNING_REDIRECT_URL | [optional] **RequestingRedirectUrl** | **string** | _t__UnclaimedDraft::REQUESTING_REDIRECT_URL | [optional] **ExpiresAt** | **int?** | _t__UnclaimedDraft::EXPIRES_AT | [optional] **TestMode** | **bool** | _t__UnclaimedDraft::TEST_MODE | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/WarningResponse.md b/sdks/dotnet/docs/WarningResponse.md index f44da160e..3525c4c49 100644 --- a/sdks/dotnet/docs/WarningResponse.md +++ b/sdks/dotnet/docs/WarningResponse.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.WarningResponse -A list of warnings. +_t__WarningResponse::LIST_DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**WarningMsg** | **string** | Warning message | **WarningName** | **string** | Warning name | +**WarningMsg** | **string** | _t__WarningResponse::WARNING_MSG | **WarningName** | **string** | _t__WarningResponse::WARNING_NAME | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountCreateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountCreateResponse.cs index dcd4d1897..a415978d1 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountCreateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountCreateResponse.cs @@ -43,7 +43,7 @@ protected AccountCreateResponse() { } /// /// account (required). /// oauthData. - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public AccountCreateResponse(AccountResponse account = default(AccountResponse), OAuthTokenResponse oauthData = default(OAuthTokenResponse), List warnings = default(List)) { @@ -86,9 +86,9 @@ public static AccountCreateResponse Init(string jsonData) public OAuthTokenResponse OauthData { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountGetResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountGetResponse.cs index 0cf03db9b..ca7dcc7b9 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountGetResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountGetResponse.cs @@ -42,7 +42,7 @@ protected AccountGetResponse() { } /// Initializes a new instance of the class. /// /// account (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public AccountGetResponse(AccountResponse account = default(AccountResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static AccountGetResponse Init(string jsonData) public AccountResponse Account { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs index 6d65726d7..642993fe3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponse.cs @@ -41,16 +41,16 @@ protected AccountResponse() { } /// /// Initializes a new instance of the class. /// - /// The ID of the Account. - /// The email address associated with the Account.. - /// Returns `true` if the user has been locked out of their account by a team admin.. - /// Returns `true` if the user has a paid Dropbox Sign account.. - /// Returns `true` if the user has a paid HelloFax account.. + /// _t__Account::ACCOUNT_ID. + /// _t__Account::EMAIL_ADDRESS. + /// _t__Account::IS_LOCKED. + /// _t__Account::IS_PAID_HS. + /// _t__Account::IS_PAID_HF. /// quotas. - /// The URL that Dropbox Sign events will `POST` to.. - /// The membership role for the team.. - /// The id of the team account belongs to.. - /// 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.. + /// _t__Account::CALLBACK_URL. + /// _t__Account::ROLE_CODE. + /// _t__Account::TEAM_ID. + /// _t__Account::LOCALE. /// usage. public AccountResponse(string accountId = default(string), string emailAddress = default(string), bool isLocked = default(bool), bool isPaidHs = default(bool), bool isPaidHf = default(bool), AccountResponseQuotas quotas = default(AccountResponseQuotas), string callbackUrl = default(string), string roleCode = default(string), string teamId = default(string), string locale = default(string), AccountResponseUsage usage = default(AccountResponseUsage)) { @@ -85,37 +85,37 @@ public static AccountResponse Init(string jsonData) } /// - /// The ID of the Account + /// _t__Account::ACCOUNT_ID /// - /// The ID of the Account + /// _t__Account::ACCOUNT_ID [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } /// - /// The email address associated with the Account. + /// _t__Account::EMAIL_ADDRESS /// - /// The email address associated with the Account. + /// _t__Account::EMAIL_ADDRESS [DataMember(Name = "email_address", EmitDefaultValue = true)] public string EmailAddress { get; set; } /// - /// Returns `true` if the user has been locked out of their account by a team admin. + /// _t__Account::IS_LOCKED /// - /// Returns `true` if the user has been locked out of their account by a team admin. + /// _t__Account::IS_LOCKED [DataMember(Name = "is_locked", EmitDefaultValue = true)] public bool IsLocked { get; set; } /// - /// Returns `true` if the user has a paid Dropbox Sign account. + /// _t__Account::IS_PAID_HS /// - /// Returns `true` if the user has a paid Dropbox Sign account. + /// _t__Account::IS_PAID_HS [DataMember(Name = "is_paid_hs", EmitDefaultValue = true)] public bool IsPaidHs { get; set; } /// - /// Returns `true` if the user has a paid HelloFax account. + /// _t__Account::IS_PAID_HF /// - /// Returns `true` if the user has a paid HelloFax account. + /// _t__Account::IS_PAID_HF [DataMember(Name = "is_paid_hf", EmitDefaultValue = true)] public bool IsPaidHf { get; set; } @@ -126,30 +126,30 @@ public static AccountResponse Init(string jsonData) public AccountResponseQuotas Quotas { get; set; } /// - /// The URL that Dropbox Sign events will `POST` to. + /// _t__Account::CALLBACK_URL /// - /// The URL that Dropbox Sign events will `POST` to. + /// _t__Account::CALLBACK_URL [DataMember(Name = "callback_url", EmitDefaultValue = true)] public string CallbackUrl { get; set; } /// - /// The membership role for the team. + /// _t__Account::ROLE_CODE /// - /// The membership role for the team. + /// _t__Account::ROLE_CODE [DataMember(Name = "role_code", EmitDefaultValue = true)] public string RoleCode { get; set; } /// - /// The id of the team account belongs to. + /// _t__Account::TEAM_ID /// - /// The id of the team account belongs to. + /// _t__Account::TEAM_ID [DataMember(Name = "team_id", EmitDefaultValue = true)] public string TeamId { get; set; } /// - /// 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. + /// _t__Account::LOCALE /// - /// 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. + /// _t__Account::LOCALE [DataMember(Name = "locale", EmitDefaultValue = true)] public string Locale { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs index b97d73c8e..41dbef6c7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseQuotas.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Details concerning remaining monthly quotas. + /// _t__Account::QUOTA /// [DataContract(Name = "AccountResponseQuotas")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,12 +41,12 @@ protected AccountResponseQuotas() { } /// /// Initializes a new instance of the class. /// - /// API signature requests remaining.. - /// Signature requests remaining.. - /// Total API templates allowed.. - /// API templates remaining.. - /// SMS verifications remaining.. - /// Number of fax pages left. + /// _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT. + /// _t__AccountQuota::DOCUMENTS_LEFT. + /// _t__AccountQuota::TEMPLATES_TOTAL. + /// _t__AccountQuota::TEMPLATES_LEFT. + /// _t__AccountQuota::SMS_VERIFICATIONS_LEFT. + /// _t__AccountQuota::NUM_FAX_PAGES_LEFT. public AccountResponseQuotas(int? apiSignatureRequestsLeft = default(int?), int? documentsLeft = default(int?), int? templatesTotal = default(int?), int? templatesLeft = default(int?), int? smsVerificationsLeft = default(int?), int? numFaxPagesLeft = default(int?)) { @@ -75,44 +75,44 @@ public static AccountResponseQuotas Init(string jsonData) } /// - /// API signature requests remaining. + /// _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT /// - /// API signature requests remaining. + /// _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT [DataMember(Name = "api_signature_requests_left", EmitDefaultValue = true)] public int? ApiSignatureRequestsLeft { get; set; } /// - /// Signature requests remaining. + /// _t__AccountQuota::DOCUMENTS_LEFT /// - /// Signature requests remaining. + /// _t__AccountQuota::DOCUMENTS_LEFT [DataMember(Name = "documents_left", EmitDefaultValue = true)] public int? DocumentsLeft { get; set; } /// - /// Total API templates allowed. + /// _t__AccountQuota::TEMPLATES_TOTAL /// - /// Total API templates allowed. + /// _t__AccountQuota::TEMPLATES_TOTAL [DataMember(Name = "templates_total", EmitDefaultValue = true)] public int? TemplatesTotal { get; set; } /// - /// API templates remaining. + /// _t__AccountQuota::TEMPLATES_LEFT /// - /// API templates remaining. + /// _t__AccountQuota::TEMPLATES_LEFT [DataMember(Name = "templates_left", EmitDefaultValue = true)] public int? TemplatesLeft { get; set; } /// - /// SMS verifications remaining. + /// _t__AccountQuota::SMS_VERIFICATIONS_LEFT /// - /// SMS verifications remaining. + /// _t__AccountQuota::SMS_VERIFICATIONS_LEFT [DataMember(Name = "sms_verifications_left", EmitDefaultValue = true)] public int? SmsVerificationsLeft { get; set; } /// - /// Number of fax pages left + /// _t__AccountQuota::NUM_FAX_PAGES_LEFT /// - /// Number of fax pages left + /// _t__AccountQuota::NUM_FAX_PAGES_LEFT [DataMember(Name = "num_fax_pages_left", EmitDefaultValue = true)] public int? NumFaxPagesLeft { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs index bd9e2e5ac..e85c3dbb8 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountResponseUsage.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Details concerning monthly usage + /// _t__Account::USAGE /// [DataContract(Name = "AccountResponseUsage")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,7 +41,7 @@ protected AccountResponseUsage() { } /// /// Initializes a new instance of the class. /// - /// Number of fax pages sent. + /// _t__AccountUsage::FAX_PAGES_SENT. public AccountResponseUsage(int? faxPagesSent = default(int?)) { @@ -65,9 +65,9 @@ public static AccountResponseUsage Init(string jsonData) } /// - /// Number of fax pages sent + /// _t__AccountUsage::FAX_PAGES_SENT /// - /// Number of fax pages sent + /// _t__AccountUsage::FAX_PAGES_SENT [DataMember(Name = "fax_pages_sent", EmitDefaultValue = true)] public int? FaxPagesSent { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountVerifyResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountVerifyResponse.cs index af369d05a..3c868b212 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountVerifyResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountVerifyResponse.cs @@ -42,7 +42,7 @@ protected AccountVerifyResponse() { } /// Initializes a new instance of the class. /// /// account. - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public AccountVerifyResponse(AccountVerifyResponseAccount account = default(AccountVerifyResponseAccount), List warnings = default(List)) { @@ -73,9 +73,9 @@ public static AccountVerifyResponse Init(string jsonData) public AccountVerifyResponseAccount Account { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/AccountVerifyResponseAccount.cs b/sdks/dotnet/src/Dropbox.Sign/Model/AccountVerifyResponseAccount.cs index 836635cbd..f524a5b7f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/AccountVerifyResponseAccount.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/AccountVerifyResponseAccount.cs @@ -41,7 +41,7 @@ protected AccountVerifyResponseAccount() { } /// /// Initializes a new instance of the class. /// - /// The email address associated with the Account.. + /// _t__Account::EMAIL_ADDRESS. public AccountVerifyResponseAccount(string emailAddress = default(string)) { @@ -65,9 +65,9 @@ public static AccountVerifyResponseAccount Init(string jsonData) } /// - /// The email address associated with the Account. + /// _t__Account::EMAIL_ADDRESS /// - /// The email address associated with the Account. + /// _t__Account::EMAIL_ADDRESS [DataMember(Name = "email_address", EmitDefaultValue = true)] public string EmailAddress { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppGetResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppGetResponse.cs index febfeecd5..9966fd5ff 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppGetResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppGetResponse.cs @@ -42,7 +42,7 @@ protected ApiAppGetResponse() { } /// Initializes a new instance of the class. /// /// apiApp (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public ApiAppGetResponse(ApiAppResponse apiApp = default(ApiAppResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static ApiAppGetResponse Init(string jsonData) public ApiAppResponse ApiApp { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppListResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppListResponse.cs index 96ae10767..245e4e78d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppListResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppListResponse.cs @@ -41,9 +41,9 @@ protected ApiAppListResponse() { } /// /// Initializes a new instance of the class. /// - /// Contains information about API Apps. (required). + /// _t__ApiAppListResponse::DESCRIPTION (required). /// listInfo (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public ApiAppListResponse(List apiApps = default(List), ListInfoResponse listInfo = default(ListInfoResponse), List warnings = default(List)) { @@ -79,9 +79,9 @@ public static ApiAppListResponse Init(string jsonData) } /// - /// Contains information about API Apps. + /// _t__ApiAppListResponse::DESCRIPTION /// - /// Contains information about API Apps. + /// _t__ApiAppListResponse::DESCRIPTION [DataMember(Name = "api_apps", IsRequired = true, EmitDefaultValue = true)] public List ApiApps { get; set; } @@ -92,9 +92,9 @@ public static ApiAppListResponse Init(string jsonData) public ListInfoResponse ListInfo { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs index f4e1da05a..e5429f696 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponse.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Contains information about an API App. + /// _t__ApiAppResponse::DESCRIPTION /// [DataContract(Name = "ApiAppResponse")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,12 +41,12 @@ protected ApiAppResponse() { } /// /// Initializes a new instance of the class. /// - /// The app's callback URL (for events). - /// The app's client id. - /// The time that the app was created. - /// The domain name(s) associated with the app. - /// The name of the app. - /// Boolean to indicate if the app has been approved. + /// _t__ApiAppResponse::CALLBACK_URL. + /// _t__ApiAppResponse::CLIENT_ID. + /// _t__ApiAppResponse::CREATED_AT. + /// _t__ApiAppResponse::DOMAINS. + /// _t__ApiAppResponse::NAME. + /// _t__ApiAppResponse::IS_APPROVED. /// oauth. /// options. /// ownerAccount. @@ -83,44 +83,44 @@ public static ApiAppResponse Init(string jsonData) } /// - /// The app's callback URL (for events) + /// _t__ApiAppResponse::CALLBACK_URL /// - /// The app's callback URL (for events) + /// _t__ApiAppResponse::CALLBACK_URL [DataMember(Name = "callback_url", EmitDefaultValue = true)] public string CallbackUrl { get; set; } /// - /// The app's client id + /// _t__ApiAppResponse::CLIENT_ID /// - /// The app's client id + /// _t__ApiAppResponse::CLIENT_ID [DataMember(Name = "client_id", EmitDefaultValue = true)] public string ClientId { get; set; } /// - /// The time that the app was created + /// _t__ApiAppResponse::CREATED_AT /// - /// The time that the app was created + /// _t__ApiAppResponse::CREATED_AT [DataMember(Name = "created_at", EmitDefaultValue = true)] public int CreatedAt { get; set; } /// - /// The domain name(s) associated with the app + /// _t__ApiAppResponse::DOMAINS /// - /// The domain name(s) associated with the app + /// _t__ApiAppResponse::DOMAINS [DataMember(Name = "domains", EmitDefaultValue = true)] public List Domains { get; set; } /// - /// The name of the app + /// _t__ApiAppResponse::NAME /// - /// The name of the app + /// _t__ApiAppResponse::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// Boolean to indicate if the app has been approved + /// _t__ApiAppResponse::IS_APPROVED /// - /// Boolean to indicate if the app has been approved + /// _t__ApiAppResponse::IS_APPROVED [DataMember(Name = "is_approved", EmitDefaultValue = true)] public bool IsApproved { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs index d5ceebef6..3ac06c233 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOAuth.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// An object describing the app's OAuth properties, or null if OAuth is not configured for the app. + /// _t__ApiAppResponseOAuth::DESCRIPTION /// [DataContract(Name = "ApiAppResponseOAuth")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,10 +41,10 @@ protected ApiAppResponseOAuth() { } /// /// Initializes a new instance of the class. /// - /// The app's OAuth callback URL.. - /// The app's OAuth secret, or null if the app does not belong to user.. - /// Array of OAuth scopes used by the app.. - /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.. + /// _t__ApiAppResponseOAuth::CALLBACK_URL. + /// _t__ApiAppResponseOAuth::SECRET. + /// _t__ApiAppResponseOAuth::SCOPES. + /// _t__ApiAppResponseOAuth::CHARGES_USERS. public ApiAppResponseOAuth(string callbackUrl = default(string), string secret = default(string), List scopes = default(List), bool chargesUsers = default(bool)) { @@ -71,30 +71,30 @@ public static ApiAppResponseOAuth Init(string jsonData) } /// - /// The app's OAuth callback URL. + /// _t__ApiAppResponseOAuth::CALLBACK_URL /// - /// The app's OAuth callback URL. + /// _t__ApiAppResponseOAuth::CALLBACK_URL [DataMember(Name = "callback_url", EmitDefaultValue = true)] public string CallbackUrl { get; set; } /// - /// The app's OAuth secret, or null if the app does not belong to user. + /// _t__ApiAppResponseOAuth::SECRET /// - /// The app's OAuth secret, or null if the app does not belong to user. + /// _t__ApiAppResponseOAuth::SECRET [DataMember(Name = "secret", EmitDefaultValue = true)] public string Secret { get; set; } /// - /// Array of OAuth scopes used by the app. + /// _t__ApiAppResponseOAuth::SCOPES /// - /// Array of OAuth scopes used by the app. + /// _t__ApiAppResponseOAuth::SCOPES [DataMember(Name = "scopes", EmitDefaultValue = true)] public List Scopes { get; set; } /// - /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. + /// _t__ApiAppResponseOAuth::CHARGES_USERS /// - /// Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. + /// _t__ApiAppResponseOAuth::CHARGES_USERS [DataMember(Name = "charges_users", EmitDefaultValue = true)] public bool ChargesUsers { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs index 10d6df91a..12d595efb 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOptions.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// An object with options that override account settings. + /// _t__ApiAppResponseOptions::DESCRIPTION /// [DataContract(Name = "ApiAppResponseOptions")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,7 +41,7 @@ protected ApiAppResponseOptions() { } /// /// Initializes a new instance of the class. /// - /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document. + /// _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE. public ApiAppResponseOptions(bool canInsertEverywhere = default(bool)) { @@ -65,9 +65,9 @@ public static ApiAppResponseOptions Init(string jsonData) } /// - /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document + /// _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE /// - /// Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document + /// _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE [DataMember(Name = "can_insert_everywhere", EmitDefaultValue = true)] public bool CanInsertEverywhere { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs index efb47222d..ede886449 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseOwnerAccount.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// An object describing the app's owner + /// _t__ApiAppResponseOwnerAccount::DESCRIPTION /// [DataContract(Name = "ApiAppResponseOwnerAccount")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,8 +41,8 @@ protected ApiAppResponseOwnerAccount() { } /// /// Initializes a new instance of the class. /// - /// The owner account's ID. - /// The owner account's email address. + /// _t__ApiAppResponseOwnerAccount::ACCOUNT_ID. + /// _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS. public ApiAppResponseOwnerAccount(string accountId = default(string), string emailAddress = default(string)) { @@ -67,16 +67,16 @@ public static ApiAppResponseOwnerAccount Init(string jsonData) } /// - /// The owner account's ID + /// _t__ApiAppResponseOwnerAccount::ACCOUNT_ID /// - /// The owner account's ID + /// _t__ApiAppResponseOwnerAccount::ACCOUNT_ID [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } /// - /// The owner account's email address + /// _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS /// - /// The owner account's email address + /// _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS [DataMember(Name = "email_address", EmitDefaultValue = true)] public string EmailAddress { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs index 095ef8e70..19572b277 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ApiAppResponseWhiteLabelingOptions.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// An object with options to customize the app's signer page + /// _t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION /// [DataContract(Name = "ApiAppResponseWhiteLabelingOptions")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponse.cs index c4c9602f7..3970b4d80 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponse.cs @@ -43,8 +43,8 @@ protected BulkSendJobGetResponse() { } /// /// bulkSendJob (required). /// listInfo (required). - /// Contains information about the Signature Requests sent in bulk. (required). - /// A list of warnings.. + /// _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS (required). + /// _t__WarningResponse::LIST_DESCRIPTION. public BulkSendJobGetResponse(BulkSendJobResponse bulkSendJob = default(BulkSendJobResponse), ListInfoResponse listInfo = default(ListInfoResponse), List signatureRequests = default(List), List warnings = default(List)) { @@ -98,16 +98,16 @@ public static BulkSendJobGetResponse Init(string jsonData) public ListInfoResponse ListInfo { get; set; } /// - /// Contains information about the Signature Requests sent in bulk. + /// _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS /// - /// Contains information about the Signature Requests sent in bulk. + /// _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS [DataMember(Name = "signature_requests", IsRequired = true, EmitDefaultValue = true)] public List SignatureRequests { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponseSignatureRequests.cs b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponseSignatureRequests.cs index 5d8db6306..78549a51b 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponseSignatureRequests.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponseSignatureRequests.cs @@ -41,31 +41,31 @@ protected BulkSendJobGetResponseSignatureRequests() { } /// /// Initializes a new instance of the class. /// - /// Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. (default to false). - /// The id of the SignatureRequest.. - /// The email address of the initiator of the SignatureRequest.. - /// The title the specified Account uses for the SignatureRequest.. - /// Default Label for account.. - /// The subject in the email that was initially sent to the signers.. - /// The custom message in the email that was initially sent to the signers.. - /// The metadata attached to the signature request.. - /// Time the signature request was created.. - /// The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - /// Whether or not the SignatureRequest has been fully executed by all signers.. - /// Whether or not the SignatureRequest has been declined by a signer.. - /// Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).. - /// The URL where a copy of the request's documents can be downloaded.. - /// The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.. - /// The URL where the requester and the signers can view the current status of the SignatureRequest.. - /// A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.. - /// The URL you want the signer redirected to after they successfully sign.. - /// The path where the completed document can be downloaded. - /// Templates IDs used in this SignatureRequest (if any).. - /// An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`. - /// Signer attachments.. - /// An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.. - /// An array of signature objects, 1 for each signer.. - /// The id of the BulkSendJob.. + /// _t__SignatureRequestResponse::TEST_MODE (default to false). + /// _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID. + /// _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS. + /// _t__SignatureRequestResponse::TITLE. + /// _t__SignatureRequestResponse::ORIGINAL_TITLE. + /// _t__SignatureRequestResponse::SUBJECT. + /// _t__SignatureRequestResponse::MESSAGE. + /// _t__SignatureRequestResponse::METADATA. + /// _t__SignatureRequestResponse::CREATED_AT. + /// _t__SignatureRequestResponse::EXPIRES_AT. + /// _t__SignatureRequestResponse::IS_COMPLETE. + /// _t__SignatureRequestResponse::IS_DECLINED. + /// _t__SignatureRequestResponse::HAS_ERROR. + /// _t__SignatureRequestResponse::FILES_URL. + /// _t__SignatureRequestResponse::SIGNING_URL. + /// _t__SignatureRequestResponse::DETAILS_URL. + /// _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES. + /// _t__SignatureRequestResponse::SIGNING_REDIRECT_URL. + /// _t__SignatureRequestResponse::FINAL_COPY_URI. + /// _t__SignatureRequestResponse::TEMPLATE_IDS. + /// _t__SignatureRequestResponseCustomField::DESCRIPTION. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION. + /// _t__SignatureRequestResponseData::DESCRIPTION. + /// _t__SignatureRequestResponseSignatures::DESCRIPTION. + /// _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID. public BulkSendJobGetResponseSignatureRequests(bool testMode = false, string signatureRequestId = default(string), string requesterEmailAddress = default(string), string title = default(string), string originalTitle = default(string), string subject = default(string), string message = default(string), Dictionary metadata = default(Dictionary), int createdAt = default(int), int? expiresAt = default(int?), bool isComplete = default(bool), bool isDeclined = default(bool), bool hasError = default(bool), string filesUrl = default(string), string signingUrl = default(string), string detailsUrl = default(string), List ccEmailAddresses = default(List), string signingRedirectUrl = default(string), string finalCopyUri = default(string), List templateIds = default(List), List customFields = default(List), List attachments = default(List), List responseData = default(List), List signatures = default(List), string bulkSendJobId = default(string)) { @@ -113,177 +113,177 @@ public static BulkSendJobGetResponseSignatureRequests Init(string jsonData) } /// - /// Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + /// _t__SignatureRequestResponse::TEST_MODE /// - /// Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + /// _t__SignatureRequestResponse::TEST_MODE [DataMember(Name = "test_mode", EmitDefaultValue = true)] public bool TestMode { get; set; } /// - /// The id of the SignatureRequest. + /// _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID /// - /// The id of the SignatureRequest. + /// _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID [DataMember(Name = "signature_request_id", EmitDefaultValue = true)] public string SignatureRequestId { get; set; } /// - /// The email address of the initiator of the SignatureRequest. + /// _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS /// - /// The email address of the initiator of the SignatureRequest. + /// _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS [DataMember(Name = "requester_email_address", EmitDefaultValue = true)] public string RequesterEmailAddress { get; set; } /// - /// The title the specified Account uses for the SignatureRequest. + /// _t__SignatureRequestResponse::TITLE /// - /// The title the specified Account uses for the SignatureRequest. + /// _t__SignatureRequestResponse::TITLE [DataMember(Name = "title", EmitDefaultValue = true)] public string Title { get; set; } /// - /// Default Label for account. + /// _t__SignatureRequestResponse::ORIGINAL_TITLE /// - /// Default Label for account. + /// _t__SignatureRequestResponse::ORIGINAL_TITLE [DataMember(Name = "original_title", EmitDefaultValue = true)] public string OriginalTitle { get; set; } /// - /// The subject in the email that was initially sent to the signers. + /// _t__SignatureRequestResponse::SUBJECT /// - /// The subject in the email that was initially sent to the signers. + /// _t__SignatureRequestResponse::SUBJECT [DataMember(Name = "subject", EmitDefaultValue = true)] public string Subject { get; set; } /// - /// The custom message in the email that was initially sent to the signers. + /// _t__SignatureRequestResponse::MESSAGE /// - /// The custom message in the email that was initially sent to the signers. + /// _t__SignatureRequestResponse::MESSAGE [DataMember(Name = "message", EmitDefaultValue = true)] public string Message { get; set; } /// - /// The metadata attached to the signature request. + /// _t__SignatureRequestResponse::METADATA /// - /// The metadata attached to the signature request. + /// _t__SignatureRequestResponse::METADATA [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } /// - /// Time the signature request was created. + /// _t__SignatureRequestResponse::CREATED_AT /// - /// Time the signature request was created. + /// _t__SignatureRequestResponse::CREATED_AT [DataMember(Name = "created_at", EmitDefaultValue = true)] public int CreatedAt { get; set; } /// - /// The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + /// _t__SignatureRequestResponse::EXPIRES_AT /// - /// The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + /// _t__SignatureRequestResponse::EXPIRES_AT [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int? ExpiresAt { get; set; } /// - /// Whether or not the SignatureRequest has been fully executed by all signers. + /// _t__SignatureRequestResponse::IS_COMPLETE /// - /// Whether or not the SignatureRequest has been fully executed by all signers. + /// _t__SignatureRequestResponse::IS_COMPLETE [DataMember(Name = "is_complete", EmitDefaultValue = true)] public bool IsComplete { get; set; } /// - /// Whether or not the SignatureRequest has been declined by a signer. + /// _t__SignatureRequestResponse::IS_DECLINED /// - /// Whether or not the SignatureRequest has been declined by a signer. + /// _t__SignatureRequestResponse::IS_DECLINED [DataMember(Name = "is_declined", EmitDefaultValue = true)] public bool IsDeclined { get; set; } /// - /// Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + /// _t__SignatureRequestResponse::HAS_ERROR /// - /// Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + /// _t__SignatureRequestResponse::HAS_ERROR [DataMember(Name = "has_error", EmitDefaultValue = true)] public bool HasError { get; set; } /// - /// The URL where a copy of the request's documents can be downloaded. + /// _t__SignatureRequestResponse::FILES_URL /// - /// The URL where a copy of the request's documents can be downloaded. + /// _t__SignatureRequestResponse::FILES_URL [DataMember(Name = "files_url", EmitDefaultValue = true)] public string FilesUrl { get; set; } /// - /// The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + /// _t__SignatureRequestResponse::SIGNING_URL /// - /// The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + /// _t__SignatureRequestResponse::SIGNING_URL [DataMember(Name = "signing_url", EmitDefaultValue = true)] public string SigningUrl { get; set; } /// - /// The URL where the requester and the signers can view the current status of the SignatureRequest. + /// _t__SignatureRequestResponse::DETAILS_URL /// - /// The URL where the requester and the signers can view the current status of the SignatureRequest. + /// _t__SignatureRequestResponse::DETAILS_URL [DataMember(Name = "details_url", EmitDefaultValue = true)] public string DetailsUrl { get; set; } /// - /// A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + /// _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES /// - /// A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + /// _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES [DataMember(Name = "cc_email_addresses", EmitDefaultValue = true)] public List CcEmailAddresses { get; set; } /// - /// The URL you want the signer redirected to after they successfully sign. + /// _t__SignatureRequestResponse::SIGNING_REDIRECT_URL /// - /// The URL you want the signer redirected to after they successfully sign. + /// _t__SignatureRequestResponse::SIGNING_REDIRECT_URL [DataMember(Name = "signing_redirect_url", EmitDefaultValue = true)] public string SigningRedirectUrl { get; set; } /// - /// The path where the completed document can be downloaded + /// _t__SignatureRequestResponse::FINAL_COPY_URI /// - /// The path where the completed document can be downloaded + /// _t__SignatureRequestResponse::FINAL_COPY_URI [DataMember(Name = "final_copy_uri", EmitDefaultValue = true)] public string FinalCopyUri { get; set; } /// - /// Templates IDs used in this SignatureRequest (if any). + /// _t__SignatureRequestResponse::TEMPLATE_IDS /// - /// Templates IDs used in this SignatureRequest (if any). + /// _t__SignatureRequestResponse::TEMPLATE_IDS [DataMember(Name = "template_ids", EmitDefaultValue = true)] public List TemplateIds { get; set; } /// - /// An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + /// _t__SignatureRequestResponseCustomField::DESCRIPTION /// - /// An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + /// _t__SignatureRequestResponseCustomField::DESCRIPTION [DataMember(Name = "custom_fields", EmitDefaultValue = true)] public List CustomFields { get; set; } /// - /// Signer attachments. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION /// - /// Signer attachments. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } /// - /// An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + /// _t__SignatureRequestResponseData::DESCRIPTION /// - /// An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + /// _t__SignatureRequestResponseData::DESCRIPTION [DataMember(Name = "response_data", EmitDefaultValue = true)] public List ResponseData { get; set; } /// - /// An array of signature objects, 1 for each signer. + /// _t__SignatureRequestResponseSignatures::DESCRIPTION /// - /// An array of signature objects, 1 for each signer. + /// _t__SignatureRequestResponseSignatures::DESCRIPTION [DataMember(Name = "signatures", EmitDefaultValue = true)] public List Signatures { get; set; } /// - /// The id of the BulkSendJob. + /// _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID /// - /// The id of the BulkSendJob. + /// _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID [DataMember(Name = "bulk_send_job_id", EmitDefaultValue = true)] public string BulkSendJobId { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobListResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobListResponse.cs index 043fd9f23..22848e391 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobListResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobListResponse.cs @@ -41,9 +41,9 @@ protected BulkSendJobListResponse() { } /// /// Initializes a new instance of the class. /// - /// Contains a list of BulkSendJobs that the API caller has access to. (required). + /// _t__BulkSendJobListResponse::BULK_SEND_JOBS (required). /// listInfo (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public BulkSendJobListResponse(List bulkSendJobs = default(List), ListInfoResponse listInfo = default(ListInfoResponse), List warnings = default(List)) { @@ -79,9 +79,9 @@ public static BulkSendJobListResponse Init(string jsonData) } /// - /// Contains a list of BulkSendJobs that the API caller has access to. + /// _t__BulkSendJobListResponse::BULK_SEND_JOBS /// - /// Contains a list of BulkSendJobs that the API caller has access to. + /// _t__BulkSendJobListResponse::BULK_SEND_JOBS [DataMember(Name = "bulk_send_jobs", IsRequired = true, EmitDefaultValue = true)] public List BulkSendJobs { get; set; } @@ -92,9 +92,9 @@ public static BulkSendJobListResponse Init(string jsonData) public ListInfoResponse ListInfo { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs index ee798bc24..b7dcfeccd 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobResponse.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. + /// _t__BulkSendJobResponse::DESCRIPTION /// [DataContract(Name = "BulkSendJobResponse")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,10 +41,10 @@ protected BulkSendJobResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of the BulkSendJob.. - /// The total amount of Signature Requests queued for sending.. - /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.. - /// Time that the BulkSendJob was created.. + /// _t__BulkSendJobResponse::BULK_SEND_JOB_ID. + /// _t__BulkSendJobResponse::TOTAL. + /// _t__BulkSendJobResponse::IS_CREATOR. + /// _t__BulkSendJobResponse::CREATED_AT. public BulkSendJobResponse(string bulkSendJobId = default(string), int total = default(int), bool isCreator = default(bool), int createdAt = default(int)) { @@ -71,30 +71,30 @@ public static BulkSendJobResponse Init(string jsonData) } /// - /// The id of the BulkSendJob. + /// _t__BulkSendJobResponse::BULK_SEND_JOB_ID /// - /// The id of the BulkSendJob. + /// _t__BulkSendJobResponse::BULK_SEND_JOB_ID [DataMember(Name = "bulk_send_job_id", EmitDefaultValue = true)] public string BulkSendJobId { get; set; } /// - /// The total amount of Signature Requests queued for sending. + /// _t__BulkSendJobResponse::TOTAL /// - /// The total amount of Signature Requests queued for sending. + /// _t__BulkSendJobResponse::TOTAL [DataMember(Name = "total", EmitDefaultValue = true)] public int Total { get; set; } /// - /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. + /// _t__BulkSendJobResponse::IS_CREATOR /// - /// True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. + /// _t__BulkSendJobResponse::IS_CREATOR [DataMember(Name = "is_creator", EmitDefaultValue = true)] public bool IsCreator { get; set; } /// - /// Time that the BulkSendJob was created. + /// _t__BulkSendJobResponse::CREATED_AT /// - /// Time that the BulkSendJob was created. + /// _t__BulkSendJobResponse::CREATED_AT [DataMember(Name = "created_at", EmitDefaultValue = true)] public int CreatedAt { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobSendResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobSendResponse.cs index 14508058b..70f8b175e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobSendResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobSendResponse.cs @@ -42,7 +42,7 @@ protected BulkSendJobSendResponse() { } /// Initializes a new instance of the class. /// /// bulkSendJob (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public BulkSendJobSendResponse(BulkSendJobResponse bulkSendJob = default(BulkSendJobResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static BulkSendJobSendResponse Init(string jsonData) public BulkSendJobResponse BulkSendJob { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlRequest.cs index eef4ec729..db605e7ea 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlRequest.cs @@ -42,6 +42,7 @@ protected EmbeddedEditUrlRequest() { } /// Initializes a new instance of the class. /// /// This allows the requester to enable/disable to add or change CC roles when editing the template. (default to false). + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.. /// editorOptions. /// Provide users the ability to review/edit the template signer roles. (default to false). @@ -51,10 +52,11 @@ protected EmbeddedEditUrlRequest() { } /// This allows the requester to enable the editor/preview experience. (default to false). /// When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. (default to true). /// Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. (default to false). - public EmbeddedEditUrlRequest(bool allowEditCcs = false, List ccRoles = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List mergeFields = default(List), bool previewOnly = false, bool showPreview = false, bool showProgressStepper = true, bool testMode = false) + public EmbeddedEditUrlRequest(bool allowEditCcs = false, bool allowFormView = false, List ccRoles = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List mergeFields = default(List), bool previewOnly = false, bool showPreview = false, bool showProgressStepper = true, bool testMode = false) { this.AllowEditCcs = allowEditCcs; + this.AllowFormView = allowFormView; this.CcRoles = ccRoles; this.EditorOptions = editorOptions; this.ForceSignerRoles = forceSignerRoles; @@ -89,6 +91,13 @@ public static EmbeddedEditUrlRequest Init(string jsonData) [DataMember(Name = "allow_edit_ccs", EmitDefaultValue = true)] public bool AllowEditCcs { get; set; } + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] + public bool AllowFormView { get; set; } + /// /// The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. /// @@ -160,6 +169,7 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class EmbeddedEditUrlRequest {\n"); sb.Append(" AllowEditCcs: ").Append(AllowEditCcs).Append("\n"); + sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" EditorOptions: ").Append(EditorOptions).Append("\n"); sb.Append(" ForceSignerRoles: ").Append(ForceSignerRoles).Append("\n"); @@ -208,6 +218,10 @@ public bool Equals(EmbeddedEditUrlRequest input) this.AllowEditCcs == input.AllowEditCcs || this.AllowEditCcs.Equals(input.AllowEditCcs) ) && + ( + this.AllowFormView == input.AllowFormView || + this.AllowFormView.Equals(input.AllowFormView) + ) && ( this.CcRoles == input.CcRoles || this.CcRoles != null && @@ -261,6 +275,7 @@ public override int GetHashCode() { int hashCode = 41; hashCode = (hashCode * 59) + this.AllowEditCcs.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.CcRoles != null) { hashCode = (hashCode * 59) + this.CcRoles.GetHashCode(); @@ -303,6 +318,13 @@ public List GetOpenApiTypes() Value = AllowEditCcs, }); types.Add(new OpenApiType() + { + Name = "allow_form_view", + Property = "AllowFormView", + Type = "bool", + Value = AllowFormView, + }); + types.Add(new OpenApiType() { Name = "cc_roles", Property = "CcRoles", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlResponse.cs index fb0ad3edd..81088808d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlResponse.cs @@ -42,7 +42,7 @@ protected EmbeddedEditUrlResponse() { } /// Initializes a new instance of the class. /// /// embedded (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public EmbeddedEditUrlResponse(EmbeddedEditUrlResponseEmbedded embedded = default(EmbeddedEditUrlResponseEmbedded), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static EmbeddedEditUrlResponse Init(string jsonData) public EmbeddedEditUrlResponseEmbedded Embedded { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlResponseEmbedded.cs b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlResponseEmbedded.cs index 41ebc19a4..b98f43d20 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlResponseEmbedded.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlResponseEmbedded.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// An embedded template object. + /// _t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION /// [DataContract(Name = "EmbeddedEditUrlResponseEmbedded")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,8 +41,8 @@ protected EmbeddedEditUrlResponseEmbedded() { } /// /// Initializes a new instance of the class. /// - /// A template url that can be opened in an iFrame.. - /// The specific time that the the `edit_url` link expires, in epoch.. + /// _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL. + /// _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT. public EmbeddedEditUrlResponseEmbedded(string editUrl = default(string), int expiresAt = default(int)) { @@ -67,16 +67,16 @@ public static EmbeddedEditUrlResponseEmbedded Init(string jsonData) } /// - /// A template url that can be opened in an iFrame. + /// _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL /// - /// A template url that can be opened in an iFrame. + /// _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL [DataMember(Name = "edit_url", EmitDefaultValue = true)] public string EditUrl { get; set; } /// - /// The specific time that the the `edit_url` link expires, in epoch. + /// _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT /// - /// The specific time that the the `edit_url` link expires, in epoch. + /// _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int ExpiresAt { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedSignUrlResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedSignUrlResponse.cs index 12a75dc1a..1d7e153b9 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedSignUrlResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedSignUrlResponse.cs @@ -42,7 +42,7 @@ protected EmbeddedSignUrlResponse() { } /// Initializes a new instance of the class. /// /// embedded (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public EmbeddedSignUrlResponse(EmbeddedSignUrlResponseEmbedded embedded = default(EmbeddedSignUrlResponseEmbedded), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static EmbeddedSignUrlResponse Init(string jsonData) public EmbeddedSignUrlResponseEmbedded Embedded { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedSignUrlResponseEmbedded.cs b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedSignUrlResponseEmbedded.cs index e66a1ce9a..b01977b80 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedSignUrlResponseEmbedded.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedSignUrlResponseEmbedded.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// An object that contains necessary information to set up embedded signing. + /// _t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION /// [DataContract(Name = "EmbeddedSignUrlResponseEmbedded")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,8 +41,8 @@ protected EmbeddedSignUrlResponseEmbedded() { } /// /// Initializes a new instance of the class. /// - /// A signature url that can be opened in an iFrame.. - /// The specific time that the the `sign_url` link expires, in epoch.. + /// _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL. + /// _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT. public EmbeddedSignUrlResponseEmbedded(string signUrl = default(string), int expiresAt = default(int)) { @@ -67,16 +67,16 @@ public static EmbeddedSignUrlResponseEmbedded Init(string jsonData) } /// - /// A signature url that can be opened in an iFrame. + /// _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL /// - /// A signature url that can be opened in an iFrame. + /// _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL [DataMember(Name = "sign_url", EmitDefaultValue = true)] public string SignUrl { get; set; } /// - /// The specific time that the the `sign_url` link expires, in epoch. + /// _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT /// - /// The specific time that the the `sign_url` link expires, in epoch. + /// _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int ExpiresAt { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ErrorResponseError.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ErrorResponseError.cs index f1b9ca907..43e564414 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ErrorResponseError.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ErrorResponseError.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Contains information about an error that occurred. + /// _t__ErrorResponseError::DESCRIPTION /// [DataContract(Name = "ErrorResponseError")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,9 +41,9 @@ protected ErrorResponseError() { } /// /// Initializes a new instance of the class. /// - /// Message describing an error. (required). - /// Path at which an error occurred.. - /// Name of the error. (required). + /// _t__ErrorResponseError::ERROR_MSG (required). + /// _t__ErrorResponseError::ERROR_PATH. + /// _t__ErrorResponseError::ERROR_NAME (required). public ErrorResponseError(string errorMsg = default(string), string errorPath = default(string), string errorName = default(string)) { @@ -79,23 +79,23 @@ public static ErrorResponseError Init(string jsonData) } /// - /// Message describing an error. + /// _t__ErrorResponseError::ERROR_MSG /// - /// Message describing an error. + /// _t__ErrorResponseError::ERROR_MSG [DataMember(Name = "error_msg", IsRequired = true, EmitDefaultValue = true)] public string ErrorMsg { get; set; } /// - /// Name of the error. + /// _t__ErrorResponseError::ERROR_NAME /// - /// Name of the error. + /// _t__ErrorResponseError::ERROR_NAME [DataMember(Name = "error_name", IsRequired = true, EmitDefaultValue = true)] public string ErrorName { get; set; } /// - /// Path at which an error occurred. + /// _t__ErrorResponseError::ERROR_PATH /// - /// Path at which an error occurred. + /// _t__ErrorResponseError::ERROR_PATH [DataMember(Name = "error_path", EmitDefaultValue = true)] public string ErrorPath { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEvent.cs b/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEvent.cs index 5308add39..fbf721b80 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEvent.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEvent.cs @@ -27,16 +27,16 @@ namespace Dropbox.Sign.Model { /// - /// Basic information about the event that occurred. + /// _t__EventCallbackRequestEvent::DESCRIPTION /// [DataContract(Name = "EventCallbackRequestEvent")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] public partial class EventCallbackRequestEvent : IEquatable, IValidatableObject { /// - /// Type of callback event that was triggered. + /// _t__EventCallbackRequestEvent::EVENT_TYPE /// - /// Type of callback event that was triggered. + /// _t__EventCallbackRequestEvent::EVENT_TYPE [JsonConverter(typeof(StringEnumConverter))] public enum EventTypeEnum { @@ -181,9 +181,9 @@ public enum EventTypeEnum /// - /// Type of callback event that was triggered. + /// _t__EventCallbackRequestEvent::EVENT_TYPE /// - /// Type of callback event that was triggered. + /// _t__EventCallbackRequestEvent::EVENT_TYPE [DataMember(Name = "event_type", IsRequired = true, EmitDefaultValue = true)] public EventTypeEnum EventType { get; set; } /// @@ -194,9 +194,9 @@ protected EventCallbackRequestEvent() { } /// /// Initializes a new instance of the class. /// - /// Time the event was created (using Unix time). (required). - /// Type of callback event that was triggered. (required). - /// Generated hash used to verify source of event data. (required). + /// _t__EventCallbackRequestEvent::EVENT_TIME (required). + /// _t__EventCallbackRequestEvent::EVENT_TYPE (required). + /// _t__EventCallbackRequestEvent::EVENT_HASH (required). /// eventMetadata. public EventCallbackRequestEvent(string eventTime = default(string), EventTypeEnum eventType = default(EventTypeEnum), string eventHash = default(string), EventCallbackRequestEventMetadata eventMetadata = default(EventCallbackRequestEventMetadata)) { @@ -234,16 +234,16 @@ public static EventCallbackRequestEvent Init(string jsonData) } /// - /// Time the event was created (using Unix time). + /// _t__EventCallbackRequestEvent::EVENT_TIME /// - /// Time the event was created (using Unix time). + /// _t__EventCallbackRequestEvent::EVENT_TIME [DataMember(Name = "event_time", IsRequired = true, EmitDefaultValue = true)] public string EventTime { get; set; } /// - /// Generated hash used to verify source of event data. + /// _t__EventCallbackRequestEvent::EVENT_HASH /// - /// Generated hash used to verify source of event data. + /// _t__EventCallbackRequestEvent::EVENT_HASH [DataMember(Name = "event_hash", IsRequired = true, EmitDefaultValue = true)] public string EventHash { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEventMetadata.cs b/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEventMetadata.cs index a19fca70f..053b12ca7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEventMetadata.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/EventCallbackRequestEventMetadata.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Specific metadata about the event. + /// _t__EventCallbackRequestEventMetadata::DESCRIPTION /// [DataContract(Name = "EventCallbackRequestEventMetadata")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,10 +41,10 @@ protected EventCallbackRequestEventMetadata() { } /// /// Initializes a new instance of the class. /// - /// Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.. - /// Account ID the event was reported for.. - /// App ID the event was reported for.. - /// Message about a declined or failed (due to error) signature flow.. + /// _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID. + /// _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID. + /// _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID. + /// _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE. public EventCallbackRequestEventMetadata(string relatedSignatureId = default(string), string reportedForAccountId = default(string), string reportedForAppId = default(string), string eventMessage = default(string)) { @@ -71,30 +71,30 @@ public static EventCallbackRequestEventMetadata Init(string jsonData) } /// - /// Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. + /// _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID /// - /// Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. + /// _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID [DataMember(Name = "related_signature_id", EmitDefaultValue = true)] public string RelatedSignatureId { get; set; } /// - /// Account ID the event was reported for. + /// _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID /// - /// Account ID the event was reported for. + /// _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID [DataMember(Name = "reported_for_account_id", EmitDefaultValue = true)] public string ReportedForAccountId { get; set; } /// - /// App ID the event was reported for. + /// _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID /// - /// App ID the event was reported for. + /// _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID [DataMember(Name = "reported_for_app_id", EmitDefaultValue = true)] public string ReportedForAppId { get; set; } /// - /// Message about a declined or failed (due to error) signature flow. + /// _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE /// - /// Message about a declined or failed (due to error) signature flow. + /// _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE [DataMember(Name = "event_message", EmitDefaultValue = true)] public string EventMessage { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxGetResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxGetResponse.cs index 59214ef6e..9572fb4b8 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxGetResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxGetResponse.cs @@ -42,7 +42,7 @@ protected FaxGetResponse() { } /// Initializes a new instance of the class. /// /// fax (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public FaxGetResponse(FaxResponse fax = default(FaxResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static FaxGetResponse Init(string jsonData) public FaxResponse Fax { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FileResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FileResponse.cs index c098c3e67..181ab0c0e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FileResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FileResponse.cs @@ -41,8 +41,8 @@ protected FileResponse() { } /// /// Initializes a new instance of the class. /// - /// URL to the file. (required). - /// When the link expires. (required). + /// _t__FileResponse::FILE_URL (required). + /// _t__FileResponse::EXPIRES_AT (required). public FileResponse(string fileUrl = default(string), int expiresAt = default(int)) { @@ -72,16 +72,16 @@ public static FileResponse Init(string jsonData) } /// - /// URL to the file. + /// _t__FileResponse::FILE_URL /// - /// URL to the file. + /// _t__FileResponse::FILE_URL [DataMember(Name = "file_url", IsRequired = true, EmitDefaultValue = true)] public string FileUrl { get; set; } /// - /// When the link expires. + /// _t__FileResponse::EXPIRES_AT /// - /// When the link expires. + /// _t__FileResponse::EXPIRES_AT [DataMember(Name = "expires_at", IsRequired = true, EmitDefaultValue = true)] public int ExpiresAt { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FileResponseDataUri.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FileResponseDataUri.cs index c416ab20d..2b9b2fc94 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FileResponseDataUri.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FileResponseDataUri.cs @@ -41,7 +41,7 @@ protected FileResponseDataUri() { } /// /// Initializes a new instance of the class. /// - /// File as base64 encoded string. (required). + /// _t__FileResponse::DATA_URI (required). public FileResponseDataUri(string dataUri = default(string)) { @@ -70,9 +70,9 @@ public static FileResponseDataUri Init(string jsonData) } /// - /// File as base64 encoded string. + /// _t__FileResponse::DATA_URI /// - /// File as base64 encoded string. + /// _t__FileResponse::DATA_URI [DataMember(Name = "data_uri", IsRequired = true, EmitDefaultValue = true)] public string DataUri { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ListInfoResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ListInfoResponse.cs index aa6807921..6ed1bfce5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ListInfoResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ListInfoResponse.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Contains pagination information about the data returned. + /// _t__ListInfoResponse::DESCRIPTION /// [DataContract(Name = "ListInfoResponse")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,10 +41,10 @@ protected ListInfoResponse() { } /// /// Initializes a new instance of the class. /// - /// Total number of pages available.. - /// Total number of objects available.. - /// Number of the page being returned.. - /// Objects returned per page.. + /// _t__ListInfoResponse::NUM_PAGES. + /// _t__ListInfoResponse::NUM_RESULTS. + /// _t__ListInfoResponse::PAGE. + /// _t__ListInfoResponse::PAGE_SIZE. public ListInfoResponse(int numPages = default(int), int? numResults = default(int?), int page = default(int), int pageSize = default(int)) { @@ -71,30 +71,30 @@ public static ListInfoResponse Init(string jsonData) } /// - /// Total number of pages available. + /// _t__ListInfoResponse::NUM_PAGES /// - /// Total number of pages available. + /// _t__ListInfoResponse::NUM_PAGES [DataMember(Name = "num_pages", EmitDefaultValue = true)] public int NumPages { get; set; } /// - /// Total number of objects available. + /// _t__ListInfoResponse::NUM_RESULTS /// - /// Total number of objects available. + /// _t__ListInfoResponse::NUM_RESULTS [DataMember(Name = "num_results", EmitDefaultValue = true)] public int? NumResults { get; set; } /// - /// Number of the page being returned. + /// _t__ListInfoResponse::PAGE /// - /// Number of the page being returned. + /// _t__ListInfoResponse::PAGE [DataMember(Name = "page", EmitDefaultValue = true)] public int Page { get; set; } /// - /// Objects returned per page. + /// _t__ListInfoResponse::PAGE_SIZE /// - /// Objects returned per page. + /// _t__ListInfoResponse::PAGE_SIZE [DataMember(Name = "page_size", EmitDefaultValue = true)] public int PageSize { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenResponse.cs index bbe00f18f..ee16c4af5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenResponse.cs @@ -44,7 +44,7 @@ protected OAuthTokenResponse() { } /// accessToken. /// tokenType. /// refreshToken. - /// Number of seconds until the `access_token` expires. Uses epoch time.. + /// _t__OAuthTokenResponse::EXPIRES_IN. /// state. public OAuthTokenResponse(string accessToken = default(string), string tokenType = default(string), string refreshToken = default(string), int expiresIn = default(int), string state = default(string)) { @@ -91,9 +91,9 @@ public static OAuthTokenResponse Init(string jsonData) public string RefreshToken { get; set; } /// - /// Number of seconds until the `access_token` expires. Uses epoch time. + /// _t__OAuthTokenResponse::EXPIRES_IN /// - /// Number of seconds until the `access_token` expires. Uses epoch time. + /// _t__OAuthTokenResponse::EXPIRES_IN [DataMember(Name = "expires_in", EmitDefaultValue = true)] public int ExpiresIn { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ReportCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ReportCreateRequest.cs index 0340546e1..8ae648930 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ReportCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ReportCreateRequest.cs @@ -49,7 +49,13 @@ public enum ReportTypeEnum /// Enum DocumentStatus for value: document_status /// [EnumMember(Value = "document_status")] - DocumentStatus = 2 + DocumentStatus = 2, + + /// + /// Enum SmsActivity for value: sms_activity + /// + [EnumMember(Value = "sms_activity")] + SmsActivity = 3 } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ReportCreateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ReportCreateResponse.cs index 30e67cadf..f045998b2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ReportCreateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ReportCreateResponse.cs @@ -42,7 +42,7 @@ protected ReportCreateResponse() { } /// Initializes a new instance of the class. /// /// report (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public ReportCreateResponse(ReportResponse report = default(ReportResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static ReportCreateResponse Init(string jsonData) public ReportResponse Report { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/ReportResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/ReportResponse.cs index 57c921854..c68600b0b 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/ReportResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/ReportResponse.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Contains information about the report request. + /// _t__ReportResponse::DESCRIPTION /// [DataContract(Name = "ReportResponse")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -49,7 +49,13 @@ public enum ReportTypeEnum /// Enum DocumentStatus for value: document_status /// [EnumMember(Value = "document_status")] - DocumentStatus = 2 + DocumentStatus = 2, + + /// + /// Enum SmsActivity for value: sms_activity + /// + [EnumMember(Value = "sms_activity")] + SmsActivity = 3 } /// @@ -60,10 +66,10 @@ protected ReportResponse() { } /// /// Initializes a new instance of the class. /// - /// A message indicating the requested operation's success. - /// The (inclusive) start date for the report data in MM/DD/YYYY format.. - /// The (inclusive) end date for the report data in MM/DD/YYYY format.. - /// 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).. + /// _t__ReportResponse::SUCCESS. + /// _t__ReportResponse::START_DATE. + /// _t__ReportResponse::END_DATE. + /// _t__ReportResponse::REPORT_TYPE. public ReportResponse(string success = default(string), string startDate = default(string), string endDate = default(string), List reportType = default(List)) { @@ -90,30 +96,30 @@ public static ReportResponse Init(string jsonData) } /// - /// A message indicating the requested operation's success + /// _t__ReportResponse::SUCCESS /// - /// A message indicating the requested operation's success + /// _t__ReportResponse::SUCCESS [DataMember(Name = "success", EmitDefaultValue = true)] public string Success { get; set; } /// - /// The (inclusive) start date for the report data in MM/DD/YYYY format. + /// _t__ReportResponse::START_DATE /// - /// The (inclusive) start date for the report data in MM/DD/YYYY format. + /// _t__ReportResponse::START_DATE [DataMember(Name = "start_date", EmitDefaultValue = true)] public string StartDate { get; set; } /// - /// The (inclusive) end date for the report data in MM/DD/YYYY format. + /// _t__ReportResponse::END_DATE /// - /// The (inclusive) end date for the report data in MM/DD/YYYY format. + /// _t__ReportResponse::END_DATE [DataMember(Name = "end_date", EmitDefaultValue = true)] public string EndDate { get; set; } /// - /// 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). + /// _t__ReportResponse::REPORT_TYPE /// - /// 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). + /// _t__ReportResponse::REPORT_TYPE [DataMember(Name = "report_type", EmitDefaultValue = true)] public List ReportType { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.cs index 86d99ce18..a7cad9d94 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.cs @@ -49,7 +49,7 @@ protected SignatureRequestBulkCreateEmbeddedWithTemplateRequest() { } /// Client id of the app you're using to create this embedded signature request. Used for security purposes. (required). /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// The URL you want signers redirected to after they successfully sign.. /// The subject in the email that will be sent to the signers.. /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). @@ -155,9 +155,9 @@ public static SignatureRequestBulkCreateEmbeddedWithTemplateRequest Init(string public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestBulkSendWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestBulkSendWithTemplateRequest.cs index f18f1280c..e184ea64a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestBulkSendWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestBulkSendWithTemplateRequest.cs @@ -49,7 +49,7 @@ protected SignatureRequestBulkSendWithTemplateRequest() { } /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.. /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// The URL you want signers redirected to after they successfully sign.. /// The subject in the email that will be sent to the signers.. /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). @@ -150,9 +150,9 @@ public static SignatureRequestBulkSendWithTemplateRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs index 310802209..522239ec2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs @@ -43,11 +43,12 @@ protected SignatureRequestCreateEmbeddedRequest() { } /// /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. (default to false). - /// A list describing the attachments. + /// _t__SubAttachment::LIST_DESCRIPTION. /// The email addresses that should be CCed.. /// Client id of the app you're using to create this embedded signature request. Used for security purposes. (required). /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. @@ -57,7 +58,7 @@ protected SignatureRequestCreateEmbeddedRequest() { } /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`. /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. (default to false). /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// signingOptions. /// The subject in the email that will be sent to the signers.. /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). @@ -65,7 +66,7 @@ protected SignatureRequestCreateEmbeddedRequest() { } /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + public SignatureRequestCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowFormView = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) { // to ensure "clientId" is required (not null) @@ -79,6 +80,7 @@ protected SignatureRequestCreateEmbeddedRequest() { } this.Signers = signers; this.GroupedSigners = groupedSigners; this.AllowDecline = allowDecline; + this.AllowFormView = allowFormView; this.AllowReassign = allowReassign; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; @@ -137,16 +139,16 @@ public static SignatureRequestCreateEmbeddedRequest Init(string jsonData) public List FileUrls { get; set; } /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION [DataMember(Name = "signers", EmitDefaultValue = true)] public List Signers { get; set; } /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION [DataMember(Name = "grouped_signers", EmitDefaultValue = true)] public List GroupedSigners { get; set; } @@ -157,6 +159,13 @@ public static SignatureRequestCreateEmbeddedRequest Init(string jsonData) [DataMember(Name = "allow_decline", EmitDefaultValue = true)] public bool AllowDecline { get; set; } + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] + public bool AllowFormView { get; set; } + /// /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. /// @@ -165,9 +174,9 @@ public static SignatureRequestCreateEmbeddedRequest Init(string jsonData) public bool AllowReassign { get; set; } /// - /// A list describing the attachments + /// _t__SubAttachment::LIST_DESCRIPTION /// - /// A list describing the attachments + /// _t__SubAttachment::LIST_DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } @@ -227,9 +236,9 @@ public static SignatureRequestCreateEmbeddedRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } @@ -295,6 +304,7 @@ public override string ToString() sb.Append(" Signers: ").Append(Signers).Append("\n"); sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); + sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); @@ -381,6 +391,10 @@ public bool Equals(SignatureRequestCreateEmbeddedRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && + ( + this.AllowFormView == input.AllowFormView || + this.AllowFormView.Equals(input.AllowFormView) + ) && ( this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) @@ -505,6 +519,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); if (this.Attachments != null) { @@ -639,6 +654,13 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() + { + Name = "allow_form_view", + Property = "AllowFormView", + Type = "bool", + Value = AllowFormView, + }); + types.Add(new OpenApiType() { Name = "allow_reassign", Property = "AllowReassign", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.cs index b0296ffdb..f85d63320 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.cs @@ -49,8 +49,8 @@ protected SignatureRequestCreateEmbeddedWithTemplateRequest() { } /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. - /// Add Signers to your Templated-based Signature Request. (required). + /// _t__Sub::Metadata::DESCRIPTION. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION (required). /// signingOptions. /// The subject in the email that will be sent to the signers.. /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). @@ -122,9 +122,9 @@ public static SignatureRequestCreateEmbeddedWithTemplateRequest Init(string json public string ClientId { get; set; } /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION [DataMember(Name = "signers", IsRequired = true, EmitDefaultValue = true)] public List Signers { get; set; } @@ -171,9 +171,9 @@ public static SignatureRequestCreateEmbeddedWithTemplateRequest Init(string json public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs index 68a03290b..374060410 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs @@ -43,11 +43,12 @@ protected SignatureRequestEditEmbeddedRequest() { } /// /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. (default to false). - /// A list describing the attachments. + /// _t__SubAttachment::LIST_DESCRIPTION. /// The email addresses that should be CCed.. /// Client id of the app you're using to create this embedded signature request. Used for security purposes. (required). /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. @@ -57,7 +58,7 @@ protected SignatureRequestEditEmbeddedRequest() { } /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`. /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. (default to false). /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// signingOptions. /// The subject in the email that will be sent to the signers.. /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). @@ -65,7 +66,7 @@ protected SignatureRequestEditEmbeddedRequest() { } /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestEditEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + public SignatureRequestEditEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowFormView = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) { // to ensure "clientId" is required (not null) @@ -79,6 +80,7 @@ protected SignatureRequestEditEmbeddedRequest() { } this.Signers = signers; this.GroupedSigners = groupedSigners; this.AllowDecline = allowDecline; + this.AllowFormView = allowFormView; this.AllowReassign = allowReassign; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; @@ -137,16 +139,16 @@ public static SignatureRequestEditEmbeddedRequest Init(string jsonData) public List FileUrls { get; set; } /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION [DataMember(Name = "signers", EmitDefaultValue = true)] public List Signers { get; set; } /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION [DataMember(Name = "grouped_signers", EmitDefaultValue = true)] public List GroupedSigners { get; set; } @@ -157,6 +159,13 @@ public static SignatureRequestEditEmbeddedRequest Init(string jsonData) [DataMember(Name = "allow_decline", EmitDefaultValue = true)] public bool AllowDecline { get; set; } + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] + public bool AllowFormView { get; set; } + /// /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. /// @@ -165,9 +174,9 @@ public static SignatureRequestEditEmbeddedRequest Init(string jsonData) public bool AllowReassign { get; set; } /// - /// A list describing the attachments + /// _t__SubAttachment::LIST_DESCRIPTION /// - /// A list describing the attachments + /// _t__SubAttachment::LIST_DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } @@ -227,9 +236,9 @@ public static SignatureRequestEditEmbeddedRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } @@ -295,6 +304,7 @@ public override string ToString() sb.Append(" Signers: ").Append(Signers).Append("\n"); sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); + sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); @@ -381,6 +391,10 @@ public bool Equals(SignatureRequestEditEmbeddedRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && + ( + this.AllowFormView == input.AllowFormView || + this.AllowFormView.Equals(input.AllowFormView) + ) && ( this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) @@ -505,6 +519,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); if (this.Attachments != null) { @@ -639,6 +654,13 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() + { + Name = "allow_form_view", + Property = "AllowFormView", + Type = "bool", + Value = AllowFormView, + }); + types.Add(new OpenApiType() { Name = "allow_reassign", Property = "AllowReassign", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs index fcf32fa66..ccc2b45a9 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs @@ -49,8 +49,8 @@ protected SignatureRequestEditEmbeddedWithTemplateRequest() { } /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. - /// Add Signers to your Templated-based Signature Request. (required). + /// _t__Sub::Metadata::DESCRIPTION. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION (required). /// signingOptions. /// The subject in the email that will be sent to the signers.. /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). @@ -122,9 +122,9 @@ public static SignatureRequestEditEmbeddedWithTemplateRequest Init(string jsonDa public string ClientId { get; set; } /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION [DataMember(Name = "signers", IsRequired = true, EmitDefaultValue = true)] public List Signers { get; set; } @@ -171,9 +171,9 @@ public static SignatureRequestEditEmbeddedWithTemplateRequest Init(string jsonDa public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs index f239fcf60..5efa76520 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs @@ -43,11 +43,12 @@ protected SignatureRequestEditRequest() { } /// /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). - /// A list describing the attachments. + /// _t__SubAttachment::LIST_DESCRIPTION. /// The email addresses that should be CCed.. /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.. /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. @@ -58,7 +59,7 @@ protected SignatureRequestEditRequest() { } /// Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. (default to false). /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// signingOptions. /// The URL you want signers redirected to after they successfully sign.. /// The subject in the email that will be sent to the signers.. @@ -66,7 +67,7 @@ protected SignatureRequestEditRequest() { } /// The title you want to assign to the SignatureRequest.. /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestEditRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) + public SignatureRequestEditRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowFormView = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) { this.Files = files; @@ -74,6 +75,7 @@ protected SignatureRequestEditRequest() { } this.Signers = signers; this.GroupedSigners = groupedSigners; this.AllowDecline = allowDecline; + this.AllowFormView = allowFormView; this.AllowReassign = allowReassign; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; @@ -127,16 +129,16 @@ public static SignatureRequestEditRequest Init(string jsonData) public List FileUrls { get; set; } /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION [DataMember(Name = "signers", EmitDefaultValue = true)] public List Signers { get; set; } /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION [DataMember(Name = "grouped_signers", EmitDefaultValue = true)] public List GroupedSigners { get; set; } @@ -147,6 +149,13 @@ public static SignatureRequestEditRequest Init(string jsonData) [DataMember(Name = "allow_decline", EmitDefaultValue = true)] public bool AllowDecline { get; set; } + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] + public bool AllowFormView { get; set; } + /// /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. /// @@ -155,9 +164,9 @@ public static SignatureRequestEditRequest Init(string jsonData) public bool AllowReassign { get; set; } /// - /// A list describing the attachments + /// _t__SubAttachment::LIST_DESCRIPTION /// - /// A list describing the attachments + /// _t__SubAttachment::LIST_DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } @@ -231,9 +240,9 @@ public static SignatureRequestEditRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } @@ -298,6 +307,7 @@ public override string ToString() sb.Append(" Signers: ").Append(Signers).Append("\n"); sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); + sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); @@ -381,6 +391,10 @@ public bool Equals(SignatureRequestEditRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && + ( + this.AllowFormView == input.AllowFormView || + this.AllowFormView.Equals(input.AllowFormView) + ) && ( this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) @@ -511,6 +525,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); if (this.Attachments != null) { @@ -646,6 +661,13 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() + { + Name = "allow_form_view", + Property = "AllowFormView", + Type = "bool", + Value = AllowFormView, + }); + types.Add(new OpenApiType() { Name = "allow_reassign", Property = "AllowReassign", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs index 84990b8ff..c1ded983d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs @@ -50,8 +50,8 @@ protected SignatureRequestEditWithTemplateRequest() { } /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. - /// Add Signers to your Templated-based Signature Request. (required). + /// _t__Sub::Metadata::DESCRIPTION. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION (required). /// signingOptions. /// The URL you want signers redirected to after they successfully sign.. /// The subject in the email that will be sent to the signers.. @@ -112,9 +112,9 @@ public static SignatureRequestEditWithTemplateRequest Init(string jsonData) public List TemplateIds { get; set; } /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION [DataMember(Name = "signers", IsRequired = true, EmitDefaultValue = true)] public List Signers { get; set; } @@ -175,9 +175,9 @@ public static SignatureRequestEditWithTemplateRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestGetResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestGetResponse.cs index 2bf0e190f..53eef4669 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestGetResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestGetResponse.cs @@ -42,7 +42,7 @@ protected SignatureRequestGetResponse() { } /// Initializes a new instance of the class. /// /// signatureRequest (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public SignatureRequestGetResponse(SignatureRequestResponse signatureRequest = default(SignatureRequestResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static SignatureRequestGetResponse Init(string jsonData) public SignatureRequestResponse SignatureRequest { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestListResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestListResponse.cs index 176cc8ef8..af24a9f59 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestListResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestListResponse.cs @@ -41,9 +41,9 @@ protected SignatureRequestListResponse() { } /// /// Initializes a new instance of the class. /// - /// Contains information about signature requests. (required). + /// _t__SignatureRequestListResponse::DESCRIPTION (required). /// listInfo (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public SignatureRequestListResponse(List signatureRequests = default(List), ListInfoResponse listInfo = default(ListInfoResponse), List warnings = default(List)) { @@ -79,9 +79,9 @@ public static SignatureRequestListResponse Init(string jsonData) } /// - /// Contains information about signature requests. + /// _t__SignatureRequestListResponse::DESCRIPTION /// - /// Contains information about signature requests. + /// _t__SignatureRequestListResponse::DESCRIPTION [DataMember(Name = "signature_requests", IsRequired = true, EmitDefaultValue = true)] public List SignatureRequests { get; set; } @@ -92,9 +92,9 @@ public static SignatureRequestListResponse Init(string jsonData) public ListInfoResponse ListInfo { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponse.cs index 514181b2f..b47e42f9f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponse.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Contains information about a signature request. + /// _t__SignatureRequestResponse::DESCRIPTION /// [DataContract(Name = "SignatureRequestResponse")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,31 +41,31 @@ protected SignatureRequestResponse() { } /// /// Initializes a new instance of the class. /// - /// Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. (default to false). - /// The id of the SignatureRequest.. - /// The email address of the initiator of the SignatureRequest.. - /// The title the specified Account uses for the SignatureRequest.. - /// Default Label for account.. - /// The subject in the email that was initially sent to the signers.. - /// The custom message in the email that was initially sent to the signers.. - /// The metadata attached to the signature request.. - /// Time the signature request was created.. - /// The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - /// Whether or not the SignatureRequest has been fully executed by all signers.. - /// Whether or not the SignatureRequest has been declined by a signer.. - /// Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).. - /// The URL where a copy of the request's documents can be downloaded.. - /// The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.. - /// The URL where the requester and the signers can view the current status of the SignatureRequest.. - /// A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.. - /// The URL you want the signer redirected to after they successfully sign.. - /// The path where the completed document can be downloaded. - /// Templates IDs used in this SignatureRequest (if any).. - /// An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`. - /// Signer attachments.. - /// An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.. - /// An array of signature objects, 1 for each signer.. - /// The ID of the Bulk Send job which sent the signature request, if applicable.. + /// _t__SignatureRequestResponse::TEST_MODE (default to false). + /// _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID. + /// _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS. + /// _t__SignatureRequestResponse::TITLE. + /// _t__SignatureRequestResponse::ORIGINAL_TITLE. + /// _t__SignatureRequestResponse::SUBJECT. + /// _t__SignatureRequestResponse::MESSAGE. + /// _t__SignatureRequestResponse::METADATA. + /// _t__SignatureRequestResponse::CREATED_AT. + /// _t__SignatureRequestResponse::EXPIRES_AT. + /// _t__SignatureRequestResponse::IS_COMPLETE. + /// _t__SignatureRequestResponse::IS_DECLINED. + /// _t__SignatureRequestResponse::HAS_ERROR. + /// _t__SignatureRequestResponse::FILES_URL. + /// _t__SignatureRequestResponse::SIGNING_URL. + /// _t__SignatureRequestResponse::DETAILS_URL. + /// _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES. + /// _t__SignatureRequestResponse::SIGNING_REDIRECT_URL. + /// _t__SignatureRequestResponse::FINAL_COPY_URI. + /// _t__SignatureRequestResponse::TEMPLATE_IDS. + /// _t__SignatureRequestResponseCustomField::DESCRIPTION. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION. + /// _t__SignatureRequestResponseData::DESCRIPTION. + /// _t__SignatureRequestResponseSignatures::DESCRIPTION. + /// _t__SignatureRequestResponse::BULK_SEND_JOB_ID. public SignatureRequestResponse(bool testMode = false, string signatureRequestId = default(string), string requesterEmailAddress = default(string), string title = default(string), string originalTitle = default(string), string subject = default(string), string message = default(string), Dictionary metadata = default(Dictionary), int createdAt = default(int), int? expiresAt = default(int?), bool isComplete = default(bool), bool isDeclined = default(bool), bool hasError = default(bool), string filesUrl = default(string), string signingUrl = default(string), string detailsUrl = default(string), List ccEmailAddresses = default(List), string signingRedirectUrl = default(string), string finalCopyUri = default(string), List templateIds = default(List), List customFields = default(List), List attachments = default(List), List responseData = default(List), List signatures = default(List), string bulkSendJobId = default(string)) { @@ -113,177 +113,177 @@ public static SignatureRequestResponse Init(string jsonData) } /// - /// Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + /// _t__SignatureRequestResponse::TEST_MODE /// - /// Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + /// _t__SignatureRequestResponse::TEST_MODE [DataMember(Name = "test_mode", EmitDefaultValue = true)] public bool TestMode { get; set; } /// - /// The id of the SignatureRequest. + /// _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID /// - /// The id of the SignatureRequest. + /// _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID [DataMember(Name = "signature_request_id", EmitDefaultValue = true)] public string SignatureRequestId { get; set; } /// - /// The email address of the initiator of the SignatureRequest. + /// _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS /// - /// The email address of the initiator of the SignatureRequest. + /// _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS [DataMember(Name = "requester_email_address", EmitDefaultValue = true)] public string RequesterEmailAddress { get; set; } /// - /// The title the specified Account uses for the SignatureRequest. + /// _t__SignatureRequestResponse::TITLE /// - /// The title the specified Account uses for the SignatureRequest. + /// _t__SignatureRequestResponse::TITLE [DataMember(Name = "title", EmitDefaultValue = true)] public string Title { get; set; } /// - /// Default Label for account. + /// _t__SignatureRequestResponse::ORIGINAL_TITLE /// - /// Default Label for account. + /// _t__SignatureRequestResponse::ORIGINAL_TITLE [DataMember(Name = "original_title", EmitDefaultValue = true)] public string OriginalTitle { get; set; } /// - /// The subject in the email that was initially sent to the signers. + /// _t__SignatureRequestResponse::SUBJECT /// - /// The subject in the email that was initially sent to the signers. + /// _t__SignatureRequestResponse::SUBJECT [DataMember(Name = "subject", EmitDefaultValue = true)] public string Subject { get; set; } /// - /// The custom message in the email that was initially sent to the signers. + /// _t__SignatureRequestResponse::MESSAGE /// - /// The custom message in the email that was initially sent to the signers. + /// _t__SignatureRequestResponse::MESSAGE [DataMember(Name = "message", EmitDefaultValue = true)] public string Message { get; set; } /// - /// The metadata attached to the signature request. + /// _t__SignatureRequestResponse::METADATA /// - /// The metadata attached to the signature request. + /// _t__SignatureRequestResponse::METADATA [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } /// - /// Time the signature request was created. + /// _t__SignatureRequestResponse::CREATED_AT /// - /// Time the signature request was created. + /// _t__SignatureRequestResponse::CREATED_AT [DataMember(Name = "created_at", EmitDefaultValue = true)] public int CreatedAt { get; set; } /// - /// The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + /// _t__SignatureRequestResponse::EXPIRES_AT /// - /// The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + /// _t__SignatureRequestResponse::EXPIRES_AT [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int? ExpiresAt { get; set; } /// - /// Whether or not the SignatureRequest has been fully executed by all signers. + /// _t__SignatureRequestResponse::IS_COMPLETE /// - /// Whether or not the SignatureRequest has been fully executed by all signers. + /// _t__SignatureRequestResponse::IS_COMPLETE [DataMember(Name = "is_complete", EmitDefaultValue = true)] public bool IsComplete { get; set; } /// - /// Whether or not the SignatureRequest has been declined by a signer. + /// _t__SignatureRequestResponse::IS_DECLINED /// - /// Whether or not the SignatureRequest has been declined by a signer. + /// _t__SignatureRequestResponse::IS_DECLINED [DataMember(Name = "is_declined", EmitDefaultValue = true)] public bool IsDeclined { get; set; } /// - /// Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + /// _t__SignatureRequestResponse::HAS_ERROR /// - /// Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + /// _t__SignatureRequestResponse::HAS_ERROR [DataMember(Name = "has_error", EmitDefaultValue = true)] public bool HasError { get; set; } /// - /// The URL where a copy of the request's documents can be downloaded. + /// _t__SignatureRequestResponse::FILES_URL /// - /// The URL where a copy of the request's documents can be downloaded. + /// _t__SignatureRequestResponse::FILES_URL [DataMember(Name = "files_url", EmitDefaultValue = true)] public string FilesUrl { get; set; } /// - /// The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + /// _t__SignatureRequestResponse::SIGNING_URL /// - /// The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + /// _t__SignatureRequestResponse::SIGNING_URL [DataMember(Name = "signing_url", EmitDefaultValue = true)] public string SigningUrl { get; set; } /// - /// The URL where the requester and the signers can view the current status of the SignatureRequest. + /// _t__SignatureRequestResponse::DETAILS_URL /// - /// The URL where the requester and the signers can view the current status of the SignatureRequest. + /// _t__SignatureRequestResponse::DETAILS_URL [DataMember(Name = "details_url", EmitDefaultValue = true)] public string DetailsUrl { get; set; } /// - /// A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + /// _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES /// - /// A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + /// _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES [DataMember(Name = "cc_email_addresses", EmitDefaultValue = true)] public List CcEmailAddresses { get; set; } /// - /// The URL you want the signer redirected to after they successfully sign. + /// _t__SignatureRequestResponse::SIGNING_REDIRECT_URL /// - /// The URL you want the signer redirected to after they successfully sign. + /// _t__SignatureRequestResponse::SIGNING_REDIRECT_URL [DataMember(Name = "signing_redirect_url", EmitDefaultValue = true)] public string SigningRedirectUrl { get; set; } /// - /// The path where the completed document can be downloaded + /// _t__SignatureRequestResponse::FINAL_COPY_URI /// - /// The path where the completed document can be downloaded + /// _t__SignatureRequestResponse::FINAL_COPY_URI [DataMember(Name = "final_copy_uri", EmitDefaultValue = true)] public string FinalCopyUri { get; set; } /// - /// Templates IDs used in this SignatureRequest (if any). + /// _t__SignatureRequestResponse::TEMPLATE_IDS /// - /// Templates IDs used in this SignatureRequest (if any). + /// _t__SignatureRequestResponse::TEMPLATE_IDS [DataMember(Name = "template_ids", EmitDefaultValue = true)] public List TemplateIds { get; set; } /// - /// An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + /// _t__SignatureRequestResponseCustomField::DESCRIPTION /// - /// An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + /// _t__SignatureRequestResponseCustomField::DESCRIPTION [DataMember(Name = "custom_fields", EmitDefaultValue = true)] public List CustomFields { get; set; } /// - /// Signer attachments. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION /// - /// Signer attachments. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } /// - /// An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + /// _t__SignatureRequestResponseData::DESCRIPTION /// - /// An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + /// _t__SignatureRequestResponseData::DESCRIPTION [DataMember(Name = "response_data", EmitDefaultValue = true)] public List ResponseData { get; set; } /// - /// An array of signature objects, 1 for each signer. + /// _t__SignatureRequestResponseSignatures::DESCRIPTION /// - /// An array of signature objects, 1 for each signer. + /// _t__SignatureRequestResponseSignatures::DESCRIPTION [DataMember(Name = "signatures", EmitDefaultValue = true)] public List Signatures { get; set; } /// - /// The ID of the Bulk Send job which sent the signature request, if applicable. + /// _t__SignatureRequestResponse::BULK_SEND_JOB_ID /// - /// The ID of the Bulk Send job which sent the signature request, if applicable. + /// _t__SignatureRequestResponse::BULK_SEND_JOB_ID [DataMember(Name = "bulk_send_job_id", EmitDefaultValue = true)] public string BulkSendJobId { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseAttachment.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseAttachment.cs index 529f5d7d6..e0764e927 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseAttachment.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseAttachment.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Signer attachments. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION /// [DataContract(Name = "SignatureRequestResponseAttachment")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,12 +41,12 @@ protected SignatureRequestResponseAttachment() { } /// /// Initializes a new instance of the class. /// - /// The unique ID for this attachment. (required). - /// The Signer this attachment is assigned to. (required). - /// The name of this attachment. (required). - /// A boolean value denoting if this attachment is required. (required). - /// Instructions for Signer.. - /// Timestamp when attachment was uploaded by Signer.. + /// _t__SignatureRequestResponseAttachment::ID (required). + /// _t__SignatureRequestResponseAttachment::SIGNER (required). + /// _t__SignatureRequestResponseAttachment::NAME (required). + /// _t__SignatureRequestResponseAttachment::REQUIRED (required). + /// _t__SignatureRequestResponseAttachment::INSTRUCTIONS. + /// _t__SignatureRequestResponseAttachment::UPLOADED_AT. public SignatureRequestResponseAttachment(string id = default(string), Object signer = null, string name = default(string), bool required = default(bool), string instructions = default(string), int? uploadedAt = default(int?)) { @@ -90,16 +90,16 @@ public static SignatureRequestResponseAttachment Init(string jsonData) } /// - /// The unique ID for this attachment. + /// _t__SignatureRequestResponseAttachment::ID /// - /// The unique ID for this attachment. + /// _t__SignatureRequestResponseAttachment::ID [DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)] public string Id { get; set; } /// - /// The Signer this attachment is assigned to. + /// _t__SignatureRequestResponseAttachment::SIGNER /// - /// The Signer this attachment is assigned to. + /// _t__SignatureRequestResponseAttachment::SIGNER [DataMember(Name = "signer", IsRequired = true, EmitDefaultValue = true)] public object Signer { @@ -109,30 +109,30 @@ public object Signer private string _signer; /// - /// The name of this attachment. + /// _t__SignatureRequestResponseAttachment::NAME /// - /// The name of this attachment. + /// _t__SignatureRequestResponseAttachment::NAME [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// - /// A boolean value denoting if this attachment is required. + /// _t__SignatureRequestResponseAttachment::REQUIRED /// - /// A boolean value denoting if this attachment is required. + /// _t__SignatureRequestResponseAttachment::REQUIRED [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] public bool Required { get; set; } /// - /// Instructions for Signer. + /// _t__SignatureRequestResponseAttachment::INSTRUCTIONS /// - /// Instructions for Signer. + /// _t__SignatureRequestResponseAttachment::INSTRUCTIONS [DataMember(Name = "instructions", EmitDefaultValue = true)] public string Instructions { get; set; } /// - /// Timestamp when attachment was uploaded by Signer. + /// _t__SignatureRequestResponseAttachment::UPLOADED_AT /// - /// Timestamp when attachment was uploaded by Signer. + /// _t__SignatureRequestResponseAttachment::UPLOADED_AT [DataMember(Name = "uploaded_at", EmitDefaultValue = true)] public int? UploadedAt { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldBase.cs index 39f910447..d6cc61510 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldBase.cs @@ -28,7 +28,7 @@ namespace Dropbox.Sign.Model { /// - /// An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + /// _t__SignatureRequestResponseCustomField::DESCRIPTION /// [DataContract(Name = "SignatureRequestResponseCustomFieldBase")] [JsonConverter(typeof(JsonSubtypes), "Type")] @@ -45,11 +45,11 @@ protected SignatureRequestResponseCustomFieldBase() { } /// /// Initializes a new instance of the class. /// - /// The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. (required). - /// The name of the Custom Field. (required). - /// A boolean value denoting if this field is required.. - /// The unique ID for this field.. - /// The name of the Role that is able to edit this field.. + /// _t__SignatureRequestResponseCustomField::TYPE (required). + /// _t__SignatureRequestResponseCustomField::NAME (required). + /// _t__SignatureRequestResponseCustomField::REQUIRED. + /// _t__SignatureRequestResponseCustomField::API_ID. + /// _t__SignatureRequestResponseCustomField::EDITOR. public SignatureRequestResponseCustomFieldBase(string type = default(string), string name = default(string), bool required = default(bool), string apiId = default(string), string editor = default(string)) { @@ -87,37 +87,37 @@ public static SignatureRequestResponseCustomFieldBase Init(string jsonData) } /// - /// The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + /// _t__SignatureRequestResponseCustomField::TYPE /// - /// The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + /// _t__SignatureRequestResponseCustomField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// - /// The name of the Custom Field. + /// _t__SignatureRequestResponseCustomField::NAME /// - /// The name of the Custom Field. + /// _t__SignatureRequestResponseCustomField::NAME [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// - /// A boolean value denoting if this field is required. + /// _t__SignatureRequestResponseCustomField::REQUIRED /// - /// A boolean value denoting if this field is required. + /// _t__SignatureRequestResponseCustomField::REQUIRED [DataMember(Name = "required", EmitDefaultValue = true)] public bool Required { get; set; } /// - /// The unique ID for this field. + /// _t__SignatureRequestResponseCustomField::API_ID /// - /// The unique ID for this field. + /// _t__SignatureRequestResponseCustomField::API_ID [DataMember(Name = "api_id", EmitDefaultValue = true)] public string ApiId { get; set; } /// - /// The name of the Role that is able to edit this field. + /// _t__SignatureRequestResponseCustomField::EDITOR /// - /// The name of the Role that is able to edit this field. + /// _t__SignatureRequestResponseCustomField::EDITOR [DataMember(Name = "editor", EmitDefaultValue = true)] public string Editor { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldCheckbox.cs index ad012202e..fb8833b47 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldCheckbox.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `SignatureRequestResponseCustomFieldBase`. + /// _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS /// [DataContract(Name = "SignatureRequestResponseCustomFieldCheckbox")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,12 +41,12 @@ protected SignatureRequestResponseCustomFieldCheckbox() { } /// /// Initializes a new instance of the class. /// - /// The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. (required) (default to "checkbox"). - /// A true/false for checkbox fields. - /// The name of the Custom Field. (required). - /// A boolean value denoting if this field is required.. - /// The unique ID for this field.. - /// The name of the Role that is able to edit this field.. + /// _t__SignatureRequestResponseCustomField::TYPE (required) (default to "checkbox"). + /// _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX. + /// _t__SignatureRequestResponseCustomField::NAME (required). + /// _t__SignatureRequestResponseCustomField::REQUIRED. + /// _t__SignatureRequestResponseCustomField::API_ID. + /// _t__SignatureRequestResponseCustomField::EDITOR. public SignatureRequestResponseCustomFieldCheckbox(string type = @"checkbox", bool value = default(bool), string name = default(string), bool required = default(bool), string apiId = default(string), string editor = default(string)) { this.Name = name; @@ -80,16 +80,16 @@ public static SignatureRequestResponseCustomFieldCheckbox Init(string jsonData) } /// - /// The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + /// _t__SignatureRequestResponseCustomField::TYPE /// - /// The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + /// _t__SignatureRequestResponseCustomField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// - /// A true/false for checkbox fields + /// _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX /// - /// A true/false for checkbox fields + /// _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX [DataMember(Name = "value", EmitDefaultValue = true)] public bool Value { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldText.cs index 2c9e39498..d946593e4 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseCustomFieldText.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `SignatureRequestResponseCustomFieldBase`. + /// _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS /// [DataContract(Name = "SignatureRequestResponseCustomFieldText")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,12 +41,12 @@ protected SignatureRequestResponseCustomFieldText() { } /// /// Initializes a new instance of the class. /// - /// The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. (required) (default to "text"). - /// A text string for text fields. - /// The name of the Custom Field. (required). - /// A boolean value denoting if this field is required.. - /// The unique ID for this field.. - /// The name of the Role that is able to edit this field.. + /// _t__SignatureRequestResponseCustomField::TYPE (required) (default to "text"). + /// _t__SignatureRequestResponseCustomField::VALUE_TEXT. + /// _t__SignatureRequestResponseCustomField::NAME (required). + /// _t__SignatureRequestResponseCustomField::REQUIRED. + /// _t__SignatureRequestResponseCustomField::API_ID. + /// _t__SignatureRequestResponseCustomField::EDITOR. public SignatureRequestResponseCustomFieldText(string type = @"text", string value = default(string), string name = default(string), bool required = default(bool), string apiId = default(string), string editor = default(string)) { this.Name = name; @@ -80,16 +80,16 @@ public static SignatureRequestResponseCustomFieldText Init(string jsonData) } /// - /// The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + /// _t__SignatureRequestResponseCustomField::TYPE /// - /// The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + /// _t__SignatureRequestResponseCustomField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// - /// A text string for text fields + /// _t__SignatureRequestResponseCustomField::VALUE_TEXT /// - /// A text string for text fields + /// _t__SignatureRequestResponseCustomField::VALUE_TEXT [DataMember(Name = "value", EmitDefaultValue = true)] public string Value { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataBase.cs index d77b18922..c9c609b88 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataBase.cs @@ -28,7 +28,7 @@ namespace Dropbox.Sign.Model { /// - /// An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + /// _t__SignatureRequestResponseData::DESCRIPTION /// [DataContract(Name = "SignatureRequestResponseDataBase")] [JsonConverter(typeof(JsonSubtypes), "Type")] @@ -52,10 +52,10 @@ protected SignatureRequestResponseDataBase() { } /// /// Initializes a new instance of the class. /// - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. /// type. public SignatureRequestResponseDataBase(string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool), string type = default(string)) { @@ -84,30 +84,30 @@ public static SignatureRequestResponseDataBase Init(string jsonData) } /// - /// The unique ID for this field. + /// _t__SignatureRequestResponseData::API_ID /// - /// The unique ID for this field. + /// _t__SignatureRequestResponseData::API_ID [DataMember(Name = "api_id", EmitDefaultValue = true)] public string ApiId { get; set; } /// - /// The ID of the signature to which this response is linked. + /// _t__SignatureRequestResponseData::SIGNATURE_ID /// - /// The ID of the signature to which this response is linked. + /// _t__SignatureRequestResponseData::SIGNATURE_ID [DataMember(Name = "signature_id", EmitDefaultValue = true)] public string SignatureId { get; set; } /// - /// The name of the form field. + /// _t__SignatureRequestResponseData::NAME /// - /// The name of the form field. + /// _t__SignatureRequestResponseData::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// A boolean value denoting if this field is required. + /// _t__SignatureRequestResponseData::REQUIRED /// - /// A boolean value denoting if this field is required. + /// _t__SignatureRequestResponseData::REQUIRED [DataMember(Name = "required", EmitDefaultValue = true)] public bool Required { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueCheckbox.cs index 51709af73..ecf267299 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueCheckbox.cs @@ -41,12 +41,12 @@ protected SignatureRequestResponseDataValueCheckbox() { } /// /// Initializes a new instance of the class. /// - /// A yes/no checkbox (default to "checkbox"). - /// The value of the form field.. - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE (default to "checkbox"). + /// _t__SignatureRequestResponseDataValue::VALUE. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. public SignatureRequestResponseDataValueCheckbox(string type = @"checkbox", bool value = default(bool), string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool)) { this.ApiId = apiId; @@ -76,16 +76,16 @@ public static SignatureRequestResponseDataValueCheckbox Init(string jsonData) } /// - /// A yes/no checkbox + /// _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE /// - /// A yes/no checkbox + /// _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE [DataMember(Name = "value", EmitDefaultValue = true)] public bool Value { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueCheckboxMerge.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueCheckboxMerge.cs index 4c12d9cd9..2f5e32b2c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueCheckboxMerge.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueCheckboxMerge.cs @@ -41,12 +41,12 @@ protected SignatureRequestResponseDataValueCheckboxMerge() { } /// /// Initializes a new instance of the class. /// - /// A checkbox field that has default value set by the api (default to "checkbox-merge"). - /// The value of the form field.. - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE (default to "checkbox-merge"). + /// _t__SignatureRequestResponseDataValue::VALUE. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. public SignatureRequestResponseDataValueCheckboxMerge(string type = @"checkbox-merge", string value = default(string), string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool)) { this.ApiId = apiId; @@ -76,16 +76,16 @@ public static SignatureRequestResponseDataValueCheckboxMerge Init(string jsonDat } /// - /// A checkbox field that has default value set by the api + /// _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE /// - /// A checkbox field that has default value set by the api + /// _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE [DataMember(Name = "value", EmitDefaultValue = true)] public string Value { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueDateSigned.cs index a8fb0d5bf..ec32e4e8e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueDateSigned.cs @@ -41,12 +41,12 @@ protected SignatureRequestResponseDataValueDateSigned() { } /// /// Initializes a new instance of the class. /// - /// A date (default to "date_signed"). - /// The value of the form field.. - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE (default to "date_signed"). + /// _t__SignatureRequestResponseDataValue::VALUE. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. public SignatureRequestResponseDataValueDateSigned(string type = @"date_signed", string value = default(string), string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool)) { this.ApiId = apiId; @@ -76,16 +76,16 @@ public static SignatureRequestResponseDataValueDateSigned Init(string jsonData) } /// - /// A date + /// _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE /// - /// A date + /// _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE [DataMember(Name = "value", EmitDefaultValue = true)] public string Value { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueDropdown.cs index d60b72ae2..68fb088fc 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueDropdown.cs @@ -41,12 +41,12 @@ protected SignatureRequestResponseDataValueDropdown() { } /// /// Initializes a new instance of the class. /// - /// An input field for dropdowns (default to "dropdown"). - /// The value of the form field.. - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE (default to "dropdown"). + /// _t__SignatureRequestResponseDataValue::VALUE. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. public SignatureRequestResponseDataValueDropdown(string type = @"dropdown", string value = default(string), string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool)) { this.ApiId = apiId; @@ -76,16 +76,16 @@ public static SignatureRequestResponseDataValueDropdown Init(string jsonData) } /// - /// An input field for dropdowns + /// _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE /// - /// An input field for dropdowns + /// _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE [DataMember(Name = "value", EmitDefaultValue = true)] public string Value { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueInitials.cs index 023ee3d63..dd738e6e6 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueInitials.cs @@ -41,13 +41,13 @@ protected SignatureRequestResponseDataValueInitials() { } /// /// Initializes a new instance of the class. /// - /// An input field for initials (default to "initials"). - /// The value of the form field.. - /// This field contains the boolean true if the field is signed.. - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseDataValue::INITIAL_TYPE (default to "initials"). + /// _t__SignatureRequestResponseDataValue::VALUE. + /// _t__SignatureRequestResponseDataValue::IS_SIGNED. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. public SignatureRequestResponseDataValueInitials(string type = @"initials", string value = default(string), bool? isSigned = default(bool?), string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool)) { this.ApiId = apiId; @@ -78,23 +78,23 @@ public static SignatureRequestResponseDataValueInitials Init(string jsonData) } /// - /// An input field for initials + /// _t__SignatureRequestResponseDataValue::INITIAL_TYPE /// - /// An input field for initials + /// _t__SignatureRequestResponseDataValue::INITIAL_TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE [DataMember(Name = "value", EmitDefaultValue = true)] public string Value { get; set; } /// - /// This field contains the boolean true if the field is signed. + /// _t__SignatureRequestResponseDataValue::IS_SIGNED /// - /// This field contains the boolean true if the field is signed. + /// _t__SignatureRequestResponseDataValue::IS_SIGNED [DataMember(Name = "is_signed", EmitDefaultValue = true)] public bool? IsSigned { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueRadio.cs index 258846b27..e0d0675d9 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueRadio.cs @@ -41,12 +41,12 @@ protected SignatureRequestResponseDataValueRadio() { } /// /// Initializes a new instance of the class. /// - /// An input field for radios (default to "radio"). - /// The value of the form field.. - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseDataValue::RADIO_TYPE (default to "radio"). + /// _t__SignatureRequestResponseDataValue::VALUE. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. public SignatureRequestResponseDataValueRadio(string type = @"radio", bool value = default(bool), string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool)) { this.ApiId = apiId; @@ -76,16 +76,16 @@ public static SignatureRequestResponseDataValueRadio Init(string jsonData) } /// - /// An input field for radios + /// _t__SignatureRequestResponseDataValue::RADIO_TYPE /// - /// An input field for radios + /// _t__SignatureRequestResponseDataValue::RADIO_TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE [DataMember(Name = "value", EmitDefaultValue = true)] public bool Value { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueSignature.cs index efe2bb26c..cdaacc9b2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueSignature.cs @@ -41,13 +41,13 @@ protected SignatureRequestResponseDataValueSignature() { } /// /// Initializes a new instance of the class. /// - /// A signature input field (default to "signature"). - /// The value of the form field.. - /// This field contains the boolean true if the field is signed.. - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE (default to "signature"). + /// _t__SignatureRequestResponseDataValue::VALUE. + /// _t__SignatureRequestResponseDataValue::IS_SIGNED. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. public SignatureRequestResponseDataValueSignature(string type = @"signature", string value = default(string), bool? isSigned = default(bool?), string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool)) { this.ApiId = apiId; @@ -78,23 +78,23 @@ public static SignatureRequestResponseDataValueSignature Init(string jsonData) } /// - /// A signature input field + /// _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE /// - /// A signature input field + /// _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE [DataMember(Name = "value", EmitDefaultValue = true)] public string Value { get; set; } /// - /// This field contains the boolean true if the field is signed. + /// _t__SignatureRequestResponseDataValue::IS_SIGNED /// - /// This field contains the boolean true if the field is signed. + /// _t__SignatureRequestResponseDataValue::IS_SIGNED [DataMember(Name = "is_signed", EmitDefaultValue = true)] public bool? IsSigned { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueText.cs index 4372a0e5e..33a939b8e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueText.cs @@ -41,12 +41,12 @@ protected SignatureRequestResponseDataValueText() { } /// /// Initializes a new instance of the class. /// - /// A text input field (default to "text"). - /// The value of the form field.. - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseDataValue::TEXT_TYPE (default to "text"). + /// _t__SignatureRequestResponseDataValue::VALUE. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. public SignatureRequestResponseDataValueText(string type = @"text", string value = default(string), string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool)) { this.ApiId = apiId; @@ -76,16 +76,16 @@ public static SignatureRequestResponseDataValueText Init(string jsonData) } /// - /// A text input field + /// _t__SignatureRequestResponseDataValue::TEXT_TYPE /// - /// A text input field + /// _t__SignatureRequestResponseDataValue::TEXT_TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE [DataMember(Name = "value", EmitDefaultValue = true)] public string Value { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueTextMerge.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueTextMerge.cs index 74e9a1a2a..d3cc70102 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueTextMerge.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseDataValueTextMerge.cs @@ -41,12 +41,12 @@ protected SignatureRequestResponseDataValueTextMerge() { } /// /// Initializes a new instance of the class. /// - /// A text field that has default text set by the api (default to "text-merge"). - /// The value of the form field.. - /// The unique ID for this field.. - /// The ID of the signature to which this response is linked.. - /// The name of the form field.. - /// A boolean value denoting if this field is required.. + /// _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE (default to "text-merge"). + /// _t__SignatureRequestResponseDataValue::VALUE. + /// _t__SignatureRequestResponseData::API_ID. + /// _t__SignatureRequestResponseData::SIGNATURE_ID. + /// _t__SignatureRequestResponseData::NAME. + /// _t__SignatureRequestResponseData::REQUIRED. public SignatureRequestResponseDataValueTextMerge(string type = @"text-merge", string value = default(string), string apiId = default(string), string signatureId = default(string), string name = default(string), bool required = default(bool)) { this.ApiId = apiId; @@ -76,16 +76,16 @@ public static SignatureRequestResponseDataValueTextMerge Init(string jsonData) } /// - /// A text field that has default text set by the api + /// _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE /// - /// A text field that has default text set by the api + /// _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public string Type { get; set; } /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE /// - /// The value of the form field. + /// _t__SignatureRequestResponseDataValue::VALUE [DataMember(Name = "value", EmitDefaultValue = true)] public string Value { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseSignatures.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseSignatures.cs index 38bc7682d..8bae6c9bb 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseSignatures.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponseSignatures.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// An array of signature objects, 1 for each signer. + /// _t__SignatureRequestResponseSignatures::DESCRIPTION /// [DataContract(Name = "SignatureRequestResponseSignatures")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,25 +41,25 @@ protected SignatureRequestResponseSignatures() { } /// /// Initializes a new instance of the class. /// - /// Signature identifier.. - /// Signer Group GUID. - /// The email address of the signer.. - /// The name of the signer.. - /// The role of the signer.. - /// If signer order is assigned this is the 0-based index for this signer.. - /// The current status of the signature. eg: awaiting_signature, signed, declined.. - /// The reason provided by the signer for declining the request.. - /// Time that the document was signed or null.. - /// The time that the document was last viewed by this signer or null.. - /// The time the last reminder email was sent to the signer or null.. - /// Boolean to indicate whether this signature requires a PIN to access.. - /// Boolean to indicate whether this signature has SMS authentication enabled.. - /// Boolean to indicate whether this signature has SMS delivery enabled.. - /// The SMS phone number used for authentication or signature request delivery.. - /// Email address of original signer who reassigned to this signer.. - /// Reason provided by original signer who reassigned to this signer.. - /// Previous signature identifier.. - /// Error message pertaining to this signer, or null.. + /// _t__SignatureRequestResponseSignatures::SIGNATURE_ID. + /// _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID. + /// _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS. + /// _t__SignatureRequestResponseSignatures::SIGNER_NAME. + /// _t__SignatureRequestResponseSignatures::SIGNER_ROLE. + /// _t__SignatureRequestResponseSignatures::ORDER. + /// _t__SignatureRequestResponseSignatures::STATUS_CODE. + /// _t__SignatureRequestResponseSignatures::DECLINE_REASON. + /// _t__SignatureRequestResponseSignatures::SIGNED_AT. + /// _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT. + /// _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT. + /// _t__SignatureRequestResponseSignatures::HAS_PIN. + /// _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH. + /// _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY. + /// _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER. + /// _t__SignatureRequestResponseSignatures::REASSIGNED_BY. + /// _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON. + /// _t__SignatureRequestResponseSignatures::REASSIGNED_FROM. + /// _t__SignatureRequestResponseSignatures::ERROR. public SignatureRequestResponseSignatures(string signatureId = default(string), string signerGroupGuid = default(string), string signerEmailAddress = default(string), string signerName = default(string), string signerRole = default(string), int? order = default(int?), string statusCode = default(string), string declineReason = default(string), int? signedAt = default(int?), int? lastViewedAt = default(int?), int? lastRemindedAt = default(int?), bool hasPin = default(bool), bool? hasSmsAuth = default(bool?), bool? hasSmsDelivery = default(bool?), string smsPhoneNumber = default(string), string reassignedBy = default(string), string reassignmentReason = default(string), string reassignedFrom = default(string), string error = default(string)) { @@ -101,135 +101,135 @@ public static SignatureRequestResponseSignatures Init(string jsonData) } /// - /// Signature identifier. + /// _t__SignatureRequestResponseSignatures::SIGNATURE_ID /// - /// Signature identifier. + /// _t__SignatureRequestResponseSignatures::SIGNATURE_ID [DataMember(Name = "signature_id", EmitDefaultValue = true)] public string SignatureId { get; set; } /// - /// Signer Group GUID + /// _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID /// - /// Signer Group GUID + /// _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID [DataMember(Name = "signer_group_guid", EmitDefaultValue = true)] public string SignerGroupGuid { get; set; } /// - /// The email address of the signer. + /// _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS /// - /// The email address of the signer. + /// _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS [DataMember(Name = "signer_email_address", EmitDefaultValue = true)] public string SignerEmailAddress { get; set; } /// - /// The name of the signer. + /// _t__SignatureRequestResponseSignatures::SIGNER_NAME /// - /// The name of the signer. + /// _t__SignatureRequestResponseSignatures::SIGNER_NAME [DataMember(Name = "signer_name", EmitDefaultValue = true)] public string SignerName { get; set; } /// - /// The role of the signer. + /// _t__SignatureRequestResponseSignatures::SIGNER_ROLE /// - /// The role of the signer. + /// _t__SignatureRequestResponseSignatures::SIGNER_ROLE [DataMember(Name = "signer_role", EmitDefaultValue = true)] public string SignerRole { get; set; } /// - /// If signer order is assigned this is the 0-based index for this signer. + /// _t__SignatureRequestResponseSignatures::ORDER /// - /// If signer order is assigned this is the 0-based index for this signer. + /// _t__SignatureRequestResponseSignatures::ORDER [DataMember(Name = "order", EmitDefaultValue = true)] public int? Order { get; set; } /// - /// The current status of the signature. eg: awaiting_signature, signed, declined. + /// _t__SignatureRequestResponseSignatures::STATUS_CODE /// - /// The current status of the signature. eg: awaiting_signature, signed, declined. + /// _t__SignatureRequestResponseSignatures::STATUS_CODE [DataMember(Name = "status_code", EmitDefaultValue = true)] public string StatusCode { get; set; } /// - /// The reason provided by the signer for declining the request. + /// _t__SignatureRequestResponseSignatures::DECLINE_REASON /// - /// The reason provided by the signer for declining the request. + /// _t__SignatureRequestResponseSignatures::DECLINE_REASON [DataMember(Name = "decline_reason", EmitDefaultValue = true)] public string DeclineReason { get; set; } /// - /// Time that the document was signed or null. + /// _t__SignatureRequestResponseSignatures::SIGNED_AT /// - /// Time that the document was signed or null. + /// _t__SignatureRequestResponseSignatures::SIGNED_AT [DataMember(Name = "signed_at", EmitDefaultValue = true)] public int? SignedAt { get; set; } /// - /// The time that the document was last viewed by this signer or null. + /// _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT /// - /// The time that the document was last viewed by this signer or null. + /// _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT [DataMember(Name = "last_viewed_at", EmitDefaultValue = true)] public int? LastViewedAt { get; set; } /// - /// The time the last reminder email was sent to the signer or null. + /// _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT /// - /// The time the last reminder email was sent to the signer or null. + /// _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT [DataMember(Name = "last_reminded_at", EmitDefaultValue = true)] public int? LastRemindedAt { get; set; } /// - /// Boolean to indicate whether this signature requires a PIN to access. + /// _t__SignatureRequestResponseSignatures::HAS_PIN /// - /// Boolean to indicate whether this signature requires a PIN to access. + /// _t__SignatureRequestResponseSignatures::HAS_PIN [DataMember(Name = "has_pin", EmitDefaultValue = true)] public bool HasPin { get; set; } /// - /// Boolean to indicate whether this signature has SMS authentication enabled. + /// _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH /// - /// Boolean to indicate whether this signature has SMS authentication enabled. + /// _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH [DataMember(Name = "has_sms_auth", EmitDefaultValue = true)] public bool? HasSmsAuth { get; set; } /// - /// Boolean to indicate whether this signature has SMS delivery enabled. + /// _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY /// - /// Boolean to indicate whether this signature has SMS delivery enabled. + /// _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY [DataMember(Name = "has_sms_delivery", EmitDefaultValue = true)] public bool? HasSmsDelivery { get; set; } /// - /// The SMS phone number used for authentication or signature request delivery. + /// _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER /// - /// The SMS phone number used for authentication or signature request delivery. + /// _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER [DataMember(Name = "sms_phone_number", EmitDefaultValue = true)] public string SmsPhoneNumber { get; set; } /// - /// Email address of original signer who reassigned to this signer. + /// _t__SignatureRequestResponseSignatures::REASSIGNED_BY /// - /// Email address of original signer who reassigned to this signer. + /// _t__SignatureRequestResponseSignatures::REASSIGNED_BY [DataMember(Name = "reassigned_by", EmitDefaultValue = true)] public string ReassignedBy { get; set; } /// - /// Reason provided by original signer who reassigned to this signer. + /// _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON /// - /// Reason provided by original signer who reassigned to this signer. + /// _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON [DataMember(Name = "reassignment_reason", EmitDefaultValue = true)] public string ReassignmentReason { get; set; } /// - /// Previous signature identifier. + /// _t__SignatureRequestResponseSignatures::REASSIGNED_FROM /// - /// Previous signature identifier. + /// _t__SignatureRequestResponseSignatures::REASSIGNED_FROM [DataMember(Name = "reassigned_from", EmitDefaultValue = true)] public string ReassignedFrom { get; set; } /// - /// Error message pertaining to this signer, or null. + /// _t__SignatureRequestResponseSignatures::ERROR /// - /// Error message pertaining to this signer, or null. + /// _t__SignatureRequestResponseSignatures::ERROR [DataMember(Name = "error", EmitDefaultValue = true)] public string Error { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs index 51c0d97a0..1e2fbdcd9 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs @@ -43,11 +43,12 @@ protected SignatureRequestSendRequest() { } /// /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). - /// A list describing the attachments. + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). + /// _t__SubAttachment::LIST_DESCRIPTION. /// The email addresses that should be CCed.. /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.. /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. @@ -59,7 +60,7 @@ protected SignatureRequestSendRequest() { } /// Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// signingOptions. /// The URL you want signers redirected to after they successfully sign.. /// The subject in the email that will be sent to the signers.. @@ -67,7 +68,7 @@ protected SignatureRequestSendRequest() { } /// The title you want to assign to the SignatureRequest.. /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestSendRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) + public SignatureRequestSendRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, bool allowFormView = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) { this.Files = files; @@ -76,6 +77,7 @@ protected SignatureRequestSendRequest() { } this.GroupedSigners = groupedSigners; this.AllowDecline = allowDecline; this.AllowReassign = allowReassign; + this.AllowFormView = allowFormView; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; this.ClientId = clientId; @@ -129,16 +131,16 @@ public static SignatureRequestSendRequest Init(string jsonData) public List FileUrls { get; set; } /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION /// - /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestSigner::DESCRIPTION [DataMember(Name = "signers", EmitDefaultValue = true)] public List Signers { get; set; } /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION /// - /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + /// _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION [DataMember(Name = "grouped_signers", EmitDefaultValue = true)] public List GroupedSigners { get; set; } @@ -157,9 +159,16 @@ public static SignatureRequestSendRequest Init(string jsonData) public bool AllowReassign { get; set; } /// - /// A list describing the attachments + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. /// - /// A list describing the attachments + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] + public bool AllowFormView { get; set; } + + /// + /// _t__SubAttachment::LIST_DESCRIPTION + /// + /// _t__SubAttachment::LIST_DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } @@ -241,9 +250,9 @@ public static SignatureRequestSendRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } @@ -309,6 +318,7 @@ public override string ToString() sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); + sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); @@ -396,6 +406,10 @@ public bool Equals(SignatureRequestSendRequest input) this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) ) && + ( + this.AllowFormView == input.AllowFormView || + this.AllowFormView.Equals(input.AllowFormView) + ) && ( this.Attachments == input.Attachments || this.Attachments != null && @@ -527,6 +541,7 @@ public override int GetHashCode() } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.Attachments != null) { hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); @@ -669,6 +684,13 @@ public List GetOpenApiTypes() Value = AllowReassign, }); types.Add(new OpenApiType() + { + Name = "allow_form_view", + Property = "AllowFormView", + Type = "bool", + Value = AllowFormView, + }); + types.Add(new OpenApiType() { Name = "attachments", Property = "Attachments", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs index 071627daa..9f8625e59 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs @@ -51,8 +51,8 @@ protected SignatureRequestSendWithTemplateRequest() { } /// Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). /// Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. (default to false). /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. - /// Add Signers to your Templated-based Signature Request. (required). + /// _t__Sub::Metadata::DESCRIPTION. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION (required). /// signingOptions. /// The URL you want signers redirected to after they successfully sign.. /// The subject in the email that will be sent to the signers.. @@ -114,9 +114,9 @@ public static SignatureRequestSendWithTemplateRequest Init(string jsonData) public List TemplateIds { get; set; } /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION [DataMember(Name = "signers", IsRequired = true, EmitDefaultValue = true)] public List Signers { get; set; } @@ -185,9 +185,9 @@ public static SignatureRequestSendWithTemplateRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentBase.cs index fd57c546f..649ee6565 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentBase.cs @@ -61,9 +61,9 @@ protected SubFormFieldsPerDocumentBase() { } /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). /// type (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentBase(int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, string type = default(string), int width = default(int), int x = default(int), int y = default(int)) { @@ -158,23 +158,23 @@ public object Signer public string Type { get; set; } /// - /// Size of the field in pixels. + /// _t__Sub::FormFieldsPerDocument::WIDTH /// - /// Size of the field in pixels. + /// _t__Sub::FormFieldsPerDocument::WIDTH [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] public int Width { get; set; } /// - /// Location coordinates of the field in pixels. + /// _t__Sub::FormFieldsPerDocument::X /// - /// Location coordinates of the field in pixels. + /// _t__Sub::FormFieldsPerDocument::X [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] public int X { get; set; } /// - /// Location coordinates of the field in pixels. + /// _t__Sub::FormFieldsPerDocument::Y /// - /// Location coordinates of the field in pixels. + /// _t__Sub::FormFieldsPerDocument::Y [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] public int Y { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentCheckbox.cs index 12eb68f36..2f8900524 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentCheckbox.cs @@ -51,9 +51,9 @@ protected SubFormFieldsPerDocumentCheckbox() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentCheckbox(string type = @"checkbox", string group = default(string), bool isChecked = default(bool), int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentCheckboxMerge.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentCheckboxMerge.cs index 7ac3eb83f..9ae95cbf0 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentCheckboxMerge.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentCheckboxMerge.cs @@ -49,9 +49,9 @@ protected SubFormFieldsPerDocumentCheckboxMerge() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentCheckboxMerge(string type = @"checkbox-merge", int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentDateSigned.cs index 485c02d9a..53cf8a550 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentDateSigned.cs @@ -162,9 +162,9 @@ protected SubFormFieldsPerDocumentDateSigned() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentDateSigned(string type = @"date_signed", FontFamilyEnum? fontFamily = default(FontFamilyEnum?), int fontSize = 12, int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentDropdown.cs index 467103717..a2e8a65e2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentDropdown.cs @@ -164,9 +164,9 @@ protected SubFormFieldsPerDocumentDropdown() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentDropdown(string type = @"dropdown", List options = default(List), string content = default(string), FontFamilyEnum? fontFamily = default(FontFamilyEnum?), int fontSize = 12, int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentHyperlink.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentHyperlink.cs index d766865ca..26f435aac 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentHyperlink.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentHyperlink.cs @@ -164,9 +164,9 @@ protected SubFormFieldsPerDocumentHyperlink() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentHyperlink(string type = @"hyperlink", string content = default(string), string contentUrl = default(string), FontFamilyEnum? fontFamily = default(FontFamilyEnum?), int fontSize = 12, int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentInitials.cs index 59fd2755b..219ad07e4 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentInitials.cs @@ -49,9 +49,9 @@ protected SubFormFieldsPerDocumentInitials() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentInitials(string type = @"initials", int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentRadio.cs index 752a2cb45..1b781a455 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentRadio.cs @@ -51,9 +51,9 @@ protected SubFormFieldsPerDocumentRadio() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentRadio(string type = @"radio", string group = default(string), bool isChecked = default(bool), int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentSignature.cs index c495d1554..f66118127 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentSignature.cs @@ -49,9 +49,9 @@ protected SubFormFieldsPerDocumentSignature() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentSignature(string type = @"signature", int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentText.cs index c514d0f50..8b4b9e604 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentText.cs @@ -34,9 +34,9 @@ namespace Dropbox.Sign.Model public partial class SubFormFieldsPerDocumentText : SubFormFieldsPerDocumentBase, IOpenApiTyped, IEquatable, IValidatableObject { /// - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + /// _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE /// - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + /// _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE [JsonConverter(typeof(StringEnumConverter))] public enum ValidationTypeEnum { @@ -103,9 +103,9 @@ public enum ValidationTypeEnum /// - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + /// _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE /// - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + /// _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE [DataMember(Name = "validation_type", EmitDefaultValue = true)] public ValidationTypeEnum? ValidationType { get; set; } /// @@ -232,7 +232,7 @@ protected SubFormFieldsPerDocumentText() { } /// Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.. /// Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.. /// Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.. - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.. + /// _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE. /// validationCustomRegex. /// validationCustomRegexFormatLabel. /// Content of a `me_now` text field. @@ -245,9 +245,9 @@ protected SubFormFieldsPerDocumentText() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentText(string type = @"text", string placeholder = default(string), string autoFillType = default(string), string linkId = default(string), bool masked = default(bool), ValidationTypeEnum? validationType = default(ValidationTypeEnum?), string validationCustomRegex = default(string), string validationCustomRegexFormatLabel = default(string), string content = default(string), FontFamilyEnum? fontFamily = default(FontFamilyEnum?), int fontSize = 12, int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentTextMerge.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentTextMerge.cs index d2d0c6412..4f2005354 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentTextMerge.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubFormFieldsPerDocumentTextMerge.cs @@ -152,7 +152,7 @@ protected SubFormFieldsPerDocumentTextMerge() { } /// /// Initializes a new instance of the class. /// - /// A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. (required) (default to "text-merge"). + /// _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE (required) (default to "text-merge"). /// Font family for the field.. /// 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). /// Represents the integer index of the `file` or `file_url` document the field should be attached to. (required). @@ -162,9 +162,9 @@ protected SubFormFieldsPerDocumentTextMerge() { } /// Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.. /// Whether this field is required. (required). /// Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. (required). - /// Size of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). - /// Location coordinates of the field in pixels. (required). + /// _t__Sub::FormFieldsPerDocument::WIDTH (required). + /// _t__Sub::FormFieldsPerDocument::X (required). + /// _t__Sub::FormFieldsPerDocument::Y (required). public SubFormFieldsPerDocumentTextMerge(string type = @"text-merge", FontFamilyEnum? fontFamily = default(FontFamilyEnum?), int fontSize = 12, int documentIndex = default(int), string apiId = default(string), int height = default(int), string name = default(string), int? page = default(int?), bool required = default(bool), Object signer = null, int width = default(int), int x = default(int), int y = default(int)) { this.DocumentIndex = documentIndex; @@ -205,9 +205,9 @@ public static SubFormFieldsPerDocumentTextMerge Init(string jsonData) } /// - /// A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. + /// _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE /// - /// A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. + /// _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubMergeField.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubMergeField.cs index ff9eeec37..2daa6f013 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubMergeField.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubMergeField.cs @@ -34,9 +34,9 @@ namespace Dropbox.Sign.Model public partial class SubMergeField : IEquatable, IValidatableObject { /// - /// The type of merge field. + /// _t__Sub::MergeField::TYPE /// - /// The type of merge field. + /// _t__Sub::MergeField::TYPE [JsonConverter(typeof(StringEnumConverter))] public enum TypeEnum { @@ -55,9 +55,9 @@ public enum TypeEnum /// - /// The type of merge field. + /// _t__Sub::MergeField::TYPE /// - /// The type of merge field. + /// _t__Sub::MergeField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public TypeEnum Type { get; set; } /// @@ -68,8 +68,8 @@ protected SubMergeField() { } /// /// Initializes a new instance of the class. /// - /// The name of the merge field. Must be unique. (required). - /// The type of merge field. (required). + /// _t__Sub::MergeField::NAME (required). + /// _t__Sub::MergeField::TYPE (required). public SubMergeField(string name = default(string), TypeEnum type = default(TypeEnum)) { @@ -99,9 +99,9 @@ public static SubMergeField Init(string jsonData) } /// - /// The name of the merge field. Must be unique. + /// _t__Sub::MergeField::NAME /// - /// The name of the merge field. Must be unique. + /// _t__Sub::MergeField::NAME [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubOAuth.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubOAuth.cs index be1cf834c..029065676 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubOAuth.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubOAuth.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// OAuth related parameters. + /// _t__Sub::OAuth::DESCRIPTION /// [DataContract(Name = "SubOAuth")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -96,8 +96,8 @@ protected SubOAuth() { } /// /// Initializes a new instance of the class. /// - /// The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided). - /// A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided).. + /// _t__Sub::OAuth::CALLBACK_URL. + /// _t__Sub::OAuth::SCOPES. public SubOAuth(string callbackUrl = default(string), List scopes = default(List)) { @@ -122,16 +122,16 @@ public static SubOAuth Init(string jsonData) } /// - /// The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) + /// _t__Sub::OAuth::CALLBACK_URL /// - /// The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) + /// _t__Sub::OAuth::CALLBACK_URL [DataMember(Name = "callback_url", EmitDefaultValue = true)] public string CallbackUrl { get; set; } /// - /// A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). + /// _t__Sub::OAuth::SCOPES /// - /// A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). + /// _t__Sub::OAuth::SCOPES [DataMember(Name = "scopes", EmitDefaultValue = true)] public List Scopes { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubOptions.cs index 726d534c8..b4ee9a4f9 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubOptions.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Additional options supported by API App. + /// _t__Sub::Options::DESCRIPTION /// [DataContract(Name = "SubOptions")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,7 +41,7 @@ protected SubOptions() { } /// /// Initializes a new instance of the class. /// - /// Determines if signers can use \"Insert Everywhere\" when signing a document. (default to false). + /// _t__Sub::Options::CAN_INSERT_EVERYWHERE (default to false). public SubOptions(bool canInsertEverywhere = false) { @@ -65,9 +65,9 @@ public static SubOptions Init(string jsonData) } /// - /// Determines if signers can use \"Insert Everywhere\" when signing a document. + /// _t__Sub::Options::CAN_INSERT_EVERYWHERE /// - /// Determines if signers can use \"Insert Everywhere\" when signing a document. + /// _t__Sub::Options::CAN_INSERT_EVERYWHERE [DataMember(Name = "can_insert_everywhere", EmitDefaultValue = true)] public bool CanInsertEverywhere { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestGroupedSigners.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestGroupedSigners.cs index d172c3e02..14080adfe 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestGroupedSigners.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestGroupedSigners.cs @@ -41,9 +41,9 @@ protected SubSignatureRequestGroupedSigners() { } /// /// Initializes a new instance of the class. /// - /// The name of the group. (required). - /// The order the group is required to sign in. Use this instead of Signer-level `order`.. - /// 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. (required). + /// _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME (required). + /// _t__Sub::SignatureRequestGroupedSigners::ORDER. + /// _t__Sub::SignatureRequestGroupedSigners::SIGNERS (required). public SubSignatureRequestGroupedSigners(string group = default(string), int? order = default(int?), List signers = default(List)) { @@ -79,23 +79,23 @@ public static SubSignatureRequestGroupedSigners Init(string jsonData) } /// - /// The name of the group. + /// _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME /// - /// The name of the group. + /// _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME [DataMember(Name = "group", IsRequired = true, EmitDefaultValue = true)] public string Group { get; set; } /// - /// 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. + /// _t__Sub::SignatureRequestGroupedSigners::SIGNERS /// - /// 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. + /// _t__Sub::SignatureRequestGroupedSigners::SIGNERS [DataMember(Name = "signers", IsRequired = true, EmitDefaultValue = true)] public List Signers { get; set; } /// - /// The order the group is required to sign in. Use this instead of Signer-level `order`. + /// _t__Sub::SignatureRequestGroupedSigners::ORDER /// - /// The order the group is required to sign in. Use this instead of Signer-level `order`. + /// _t__Sub::SignatureRequestGroupedSigners::ORDER [DataMember(Name = "order", EmitDefaultValue = true)] public int? Order { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestSigner.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestSigner.cs index a71fd1b10..7de4c5bd5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestSigner.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestSigner.cs @@ -34,9 +34,9 @@ namespace Dropbox.Sign.Model public partial class SubSignatureRequestSigner : IEquatable, IValidatableObject { /// - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + /// _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE /// - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + /// _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE [JsonConverter(typeof(StringEnumConverter))] public enum SmsPhoneNumberTypeEnum { @@ -55,9 +55,9 @@ public enum SmsPhoneNumberTypeEnum /// - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + /// _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE /// - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + /// _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE [DataMember(Name = "sms_phone_number_type", EmitDefaultValue = true)] public SmsPhoneNumberTypeEnum? SmsPhoneNumberType { get; set; } /// @@ -68,12 +68,12 @@ protected SubSignatureRequestSigner() { } /// /// Initializes a new instance of the class. /// - /// The name of the signer. (required). - /// The email address of the signer. (required). - /// The order the signer is required to sign in.. - /// The 4- to 12-character access code that will secure this signer's signature page.. - /// An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher.. - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).. + /// _t__Sub::SignatureRequestSigner::SIGNER_NAME (required). + /// _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS (required). + /// _t__Sub::SignatureRequestSigner::SIGNER_ORDER. + /// _t__Sub::SignatureRequestSigner::SIGNER_PIN. + /// _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER. + /// _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE. public SubSignatureRequestSigner(string name = default(string), string emailAddress = default(string), int? order = default(int?), string pin = default(string), string smsPhoneNumber = default(string), SmsPhoneNumberTypeEnum? smsPhoneNumberType = default(SmsPhoneNumberTypeEnum?)) { @@ -112,37 +112,37 @@ public static SubSignatureRequestSigner Init(string jsonData) } /// - /// The name of the signer. + /// _t__Sub::SignatureRequestSigner::SIGNER_NAME /// - /// The name of the signer. + /// _t__Sub::SignatureRequestSigner::SIGNER_NAME [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// - /// The email address of the signer. + /// _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS /// - /// The email address of the signer. + /// _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS [DataMember(Name = "email_address", IsRequired = true, EmitDefaultValue = true)] public string EmailAddress { get; set; } /// - /// The order the signer is required to sign in. + /// _t__Sub::SignatureRequestSigner::SIGNER_ORDER /// - /// The order the signer is required to sign in. + /// _t__Sub::SignatureRequestSigner::SIGNER_ORDER [DataMember(Name = "order", EmitDefaultValue = true)] public int? Order { get; set; } /// - /// The 4- to 12-character access code that will secure this signer's signature page. + /// _t__Sub::SignatureRequestSigner::SIGNER_PIN /// - /// The 4- to 12-character access code that will secure this signer's signature page. + /// _t__Sub::SignatureRequestSigner::SIGNER_PIN [DataMember(Name = "pin", EmitDefaultValue = true)] public string Pin { get; set; } /// - /// An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + /// _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER /// - /// An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + /// _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER [DataMember(Name = "sms_phone_number", EmitDefaultValue = true)] public string SmsPhoneNumber { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestTemplateSigner.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestTemplateSigner.cs index ef2f6ac1f..502da8e19 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestTemplateSigner.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubSignatureRequestTemplateSigner.cs @@ -34,9 +34,9 @@ namespace Dropbox.Sign.Model public partial class SubSignatureRequestTemplateSigner : IEquatable, IValidatableObject { /// - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + /// _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE /// - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + /// _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE [JsonConverter(typeof(StringEnumConverter))] public enum SmsPhoneNumberTypeEnum { @@ -55,9 +55,9 @@ public enum SmsPhoneNumberTypeEnum /// - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + /// _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE /// - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + /// _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE [DataMember(Name = "sms_phone_number_type", EmitDefaultValue = true)] public SmsPhoneNumberTypeEnum? SmsPhoneNumberType { get; set; } /// @@ -68,12 +68,12 @@ protected SubSignatureRequestTemplateSigner() { } /// /// Initializes a new instance of the class. /// - /// Must match an existing role in chosen Template(s). It's case-sensitive. (required). - /// The name of the signer. (required). - /// The email address of the signer. (required). - /// The 4- to 12-character access code that will secure this signer's signature page.. - /// An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher.. - /// Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).. + /// _t__Sub::SignatureRequestTemplateSigner::ROLE (required). + /// _t__Sub::SignatureRequestTemplateSigner::NAME (required). + /// _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS (required). + /// _t__Sub::SignatureRequestTemplateSigner::PIN. + /// _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER. + /// _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE. public SubSignatureRequestTemplateSigner(string role = default(string), string name = default(string), string emailAddress = default(string), string pin = default(string), string smsPhoneNumber = default(string), SmsPhoneNumberTypeEnum? smsPhoneNumberType = default(SmsPhoneNumberTypeEnum?)) { @@ -117,37 +117,37 @@ public static SubSignatureRequestTemplateSigner Init(string jsonData) } /// - /// Must match an existing role in chosen Template(s). It's case-sensitive. + /// _t__Sub::SignatureRequestTemplateSigner::ROLE /// - /// Must match an existing role in chosen Template(s). It's case-sensitive. + /// _t__Sub::SignatureRequestTemplateSigner::ROLE [DataMember(Name = "role", IsRequired = true, EmitDefaultValue = true)] public string Role { get; set; } /// - /// The name of the signer. + /// _t__Sub::SignatureRequestTemplateSigner::NAME /// - /// The name of the signer. + /// _t__Sub::SignatureRequestTemplateSigner::NAME [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// - /// The email address of the signer. + /// _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS /// - /// The email address of the signer. + /// _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS [DataMember(Name = "email_address", IsRequired = true, EmitDefaultValue = true)] public string EmailAddress { get; set; } /// - /// The 4- to 12-character access code that will secure this signer's signature page. + /// _t__Sub::SignatureRequestTemplateSigner::PIN /// - /// The 4- to 12-character access code that will secure this signer's signature page. + /// _t__Sub::SignatureRequestTemplateSigner::PIN [DataMember(Name = "pin", EmitDefaultValue = true)] public string Pin { get; set; } /// - /// An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + /// _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER /// - /// An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + /// _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER [DataMember(Name = "sms_phone_number", EmitDefaultValue = true)] public string SmsPhoneNumber { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubSigningOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubSigningOptions.cs index 03e60af0b..309ebb3fa 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubSigningOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubSigningOptions.cs @@ -27,16 +27,16 @@ namespace Dropbox.Sign.Model { /// - /// This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + /// _t__Sub::SigningOptions::DESCRIPTION /// [DataContract(Name = "SubSigningOptions")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] public partial class SubSigningOptions : IEquatable, IValidatableObject { /// - /// The default type shown (limited to the listed types) + /// _t__Sub::SigningOptions::DEFAULT /// - /// The default type shown (limited to the listed types) + /// _t__Sub::SigningOptions::DEFAULT [JsonConverter(typeof(StringEnumConverter))] public enum DefaultTypeEnum { @@ -67,9 +67,9 @@ public enum DefaultTypeEnum /// - /// The default type shown (limited to the listed types) + /// _t__Sub::SigningOptions::DEFAULT /// - /// The default type shown (limited to the listed types) + /// _t__Sub::SigningOptions::DEFAULT [DataMember(Name = "default_type", IsRequired = true, EmitDefaultValue = true)] public DefaultTypeEnum DefaultType { get; set; } /// @@ -80,11 +80,11 @@ protected SubSigningOptions() { } /// /// Initializes a new instance of the class. /// - /// The default type shown (limited to the listed types) (required). - /// Allows drawing the signature (default to false). - /// Allows using a smartphone to email the signature (default to false). - /// Allows typing the signature (default to false). - /// Allows uploading the signature (default to false). + /// _t__Sub::SigningOptions::DEFAULT (required). + /// _t__Sub::SigningOptions::DRAW (default to false). + /// _t__Sub::SigningOptions::PHONE (default to false). + /// _t__Sub::SigningOptions::TYPE (default to false). + /// _t__Sub::SigningOptions::UPLOAD (default to false). public SubSigningOptions(DefaultTypeEnum defaultType = default(DefaultTypeEnum), bool draw = false, bool phone = false, bool type = false, bool upload = false) { @@ -112,30 +112,30 @@ public static SubSigningOptions Init(string jsonData) } /// - /// Allows drawing the signature + /// _t__Sub::SigningOptions::DRAW /// - /// Allows drawing the signature + /// _t__Sub::SigningOptions::DRAW [DataMember(Name = "draw", EmitDefaultValue = true)] public bool Draw { get; set; } /// - /// Allows using a smartphone to email the signature + /// _t__Sub::SigningOptions::PHONE /// - /// Allows using a smartphone to email the signature + /// _t__Sub::SigningOptions::PHONE [DataMember(Name = "phone", EmitDefaultValue = true)] public bool Phone { get; set; } /// - /// Allows typing the signature + /// _t__Sub::SigningOptions::TYPE /// - /// Allows typing the signature + /// _t__Sub::SigningOptions::TYPE [DataMember(Name = "type", EmitDefaultValue = true)] public bool Type { get; set; } /// - /// Allows uploading the signature + /// _t__Sub::SigningOptions::UPLOAD /// - /// Allows uploading the signature + /// _t__Sub::SigningOptions::UPLOAD [DataMember(Name = "upload", EmitDefaultValue = true)] public bool Upload { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubTeamResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubTeamResponse.cs index 75bfec98d..1ada59ce3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubTeamResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubTeamResponse.cs @@ -41,8 +41,8 @@ protected SubTeamResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of a team. - /// The name of a team. + /// _t__TeamGeneral::TEAM_ID. + /// _t__TeamGeneral::NAME. public SubTeamResponse(string teamId = default(string), string name = default(string)) { @@ -67,16 +67,16 @@ public static SubTeamResponse Init(string jsonData) } /// - /// The id of a team + /// _t__TeamGeneral::TEAM_ID /// - /// The id of a team + /// _t__TeamGeneral::TEAM_ID [DataMember(Name = "team_id", EmitDefaultValue = true)] public string TeamId { get; set; } /// - /// The name of a team + /// _t__TeamGeneral::NAME /// - /// The name of a team + /// _t__TeamGeneral::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubTemplateRole.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubTemplateRole.cs index c5afcce6c..7d8f5e3a3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubTemplateRole.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubTemplateRole.cs @@ -41,8 +41,8 @@ protected SubTemplateRole() { } /// /// Initializes a new instance of the class. /// - /// The role name of the signer that will be displayed when the template is used to create a signature request.. - /// The order in which this signer role is required to sign.. + /// _t__Sub::SignerRole::NAME. + /// _t__Sub::SignerRole::ORDER. public SubTemplateRole(string name = default(string), int? order = default(int?)) { @@ -67,16 +67,16 @@ public static SubTemplateRole Init(string jsonData) } /// - /// The role name of the signer that will be displayed when the template is used to create a signature request. + /// _t__Sub::SignerRole::NAME /// - /// The role name of the signer that will be displayed when the template is used to create a signature request. + /// _t__Sub::SignerRole::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// The order in which this signer role is required to sign. + /// _t__Sub::SignerRole::ORDER /// - /// The order in which this signer role is required to sign. + /// _t__Sub::SignerRole::ORDER [DataMember(Name = "order", EmitDefaultValue = true)] public int? Order { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubUnclaimedDraftSigner.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubUnclaimedDraftSigner.cs index 9d4bbea3d..87d3ea2ef 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubUnclaimedDraftSigner.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubUnclaimedDraftSigner.cs @@ -41,9 +41,9 @@ protected SubUnclaimedDraftSigner() { } /// /// Initializes a new instance of the class. /// - /// The email address of the signer. (required). - /// The name of the signer. (required). - /// The order the signer is required to sign in.. + /// _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS (required). + /// _t__Sub::UnclaimedDraftSigner::NAME (required). + /// _t__Sub::UnclaimedDraftSigner::ORDER. public SubUnclaimedDraftSigner(string emailAddress = default(string), string name = default(string), int? order = default(int?)) { @@ -79,23 +79,23 @@ public static SubUnclaimedDraftSigner Init(string jsonData) } /// - /// The email address of the signer. + /// _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS /// - /// The email address of the signer. + /// _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS [DataMember(Name = "email_address", IsRequired = true, EmitDefaultValue = true)] public string EmailAddress { get; set; } /// - /// The name of the signer. + /// _t__Sub::UnclaimedDraftSigner::NAME /// - /// The name of the signer. + /// _t__Sub::UnclaimedDraftSigner::NAME [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// - /// The order the signer is required to sign in. + /// _t__Sub::UnclaimedDraftSigner::ORDER /// - /// The order the signer is required to sign in. + /// _t__Sub::UnclaimedDraftSigner::ORDER [DataMember(Name = "order", EmitDefaultValue = true)] public int? Order { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubUnclaimedDraftTemplateSigner.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubUnclaimedDraftTemplateSigner.cs index ebabf382d..93e3a3d94 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubUnclaimedDraftTemplateSigner.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubUnclaimedDraftTemplateSigner.cs @@ -41,9 +41,9 @@ protected SubUnclaimedDraftTemplateSigner() { } /// /// Initializes a new instance of the class. /// - /// Must match an existing role in chosen Template(s). (required). - /// The name of the signer filling the role of `role`. (required). - /// The email address of the signer filling the role of `role`. (required). + /// _t__Sub::UnclaimedDraftTemplateSigner::ROLE (required). + /// _t__Sub::UnclaimedDraftTemplateSigner::NAME (required). + /// _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS (required). public SubUnclaimedDraftTemplateSigner(string role = default(string), string name = default(string), string emailAddress = default(string)) { @@ -84,23 +84,23 @@ public static SubUnclaimedDraftTemplateSigner Init(string jsonData) } /// - /// Must match an existing role in chosen Template(s). + /// _t__Sub::UnclaimedDraftTemplateSigner::ROLE /// - /// Must match an existing role in chosen Template(s). + /// _t__Sub::UnclaimedDraftTemplateSigner::ROLE [DataMember(Name = "role", IsRequired = true, EmitDefaultValue = true)] public string Role { get; set; } /// - /// The name of the signer filling the role of `role`. + /// _t__Sub::UnclaimedDraftTemplateSigner::NAME /// - /// The name of the signer filling the role of `role`. + /// _t__Sub::UnclaimedDraftTemplateSigner::NAME [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// - /// The email address of the signer filling the role of `role`. + /// _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS /// - /// The email address of the signer filling the role of `role`. + /// _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS [DataMember(Name = "email_address", IsRequired = true, EmitDefaultValue = true)] public string EmailAddress { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubWhiteLabelingOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubWhiteLabelingOptions.cs index 72d4ebb30..cfa9e3d90 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubWhiteLabelingOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubWhiteLabelingOptions.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. + /// _t__Sub::WhiteLabelingOptions::DESCRIPTION /// [DataContract(Name = "SubWhiteLabelingOptions")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -80,7 +80,7 @@ protected SubWhiteLabelingOptions() { } /// secondaryButtonTextColorHover (default to "#0061FE"). /// textColor1 (default to "#808080"). /// textColor2 (default to "#ffffff"). - /// Resets white labeling options to defaults. Only useful when updating an API App.. + /// _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT. public SubWhiteLabelingOptions(string headerBackgroundColor = @"#1a1a1a", LegalVersionEnum? legalVersion = LegalVersionEnum.Terms1, string linkColor = @"#0061FE", string pageBackgroundColor = @"#f7f8f9", string primaryButtonColor = @"#0061FE", string primaryButtonColorHover = @"#0061FE", string primaryButtonTextColor = @"#ffffff", string primaryButtonTextColorHover = @"#ffffff", string secondaryButtonColor = @"#ffffff", string secondaryButtonColorHover = @"#ffffff", string secondaryButtonTextColor = @"#0061FE", string secondaryButtonTextColorHover = @"#0061FE", string textColor1 = @"#808080", string textColor2 = @"#ffffff", bool resetToDefault = default(bool)) { @@ -209,9 +209,9 @@ public static SubWhiteLabelingOptions Init(string jsonData) public string TextColor2 { get; set; } /// - /// Resets white labeling options to defaults. Only useful when updating an API App. + /// _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT /// - /// Resets white labeling options to defaults. Only useful when updating an API App. + /// _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT [DataMember(Name = "reset_to_default", EmitDefaultValue = true)] public bool ResetToDefault { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TeamGetInfoResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TeamGetInfoResponse.cs index 40401827b..f894d9839 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TeamGetInfoResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TeamGetInfoResponse.cs @@ -42,7 +42,7 @@ protected TeamGetInfoResponse() { } /// Initializes a new instance of the class. /// /// team (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public TeamGetInfoResponse(TeamInfoResponse team = default(TeamInfoResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static TeamGetInfoResponse Init(string jsonData) public TeamInfoResponse Team { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TeamGetResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TeamGetResponse.cs index 3e1a65207..f651725c6 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TeamGetResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TeamGetResponse.cs @@ -42,7 +42,7 @@ protected TeamGetResponse() { } /// Initializes a new instance of the class. /// /// team (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public TeamGetResponse(TeamResponse team = default(TeamResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static TeamGetResponse Init(string jsonData) public TeamResponse Team { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TeamInfoResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TeamInfoResponse.cs index 0f47db137..00da3dbe9 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TeamInfoResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TeamInfoResponse.cs @@ -41,11 +41,11 @@ protected TeamInfoResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of a team. + /// _t__TeamGeneral::TEAM_ID. /// teamParent. - /// The name of a team. - /// Number of members within a team. - /// Number of sub teams within a team. + /// _t__TeamGeneral::NAME. + /// _t__TeamGeneral::NUM_MEMBERS. + /// _t__TeamGeneral::NUM_SUB_TEAMS. public TeamInfoResponse(string teamId = default(string), TeamParentResponse teamParent = default(TeamParentResponse), string name = default(string), int numMembers = default(int), int numSubTeams = default(int)) { @@ -73,9 +73,9 @@ public static TeamInfoResponse Init(string jsonData) } /// - /// The id of a team + /// _t__TeamGeneral::TEAM_ID /// - /// The id of a team + /// _t__TeamGeneral::TEAM_ID [DataMember(Name = "team_id", EmitDefaultValue = true)] public string TeamId { get; set; } @@ -86,23 +86,23 @@ public static TeamInfoResponse Init(string jsonData) public TeamParentResponse TeamParent { get; set; } /// - /// The name of a team + /// _t__TeamGeneral::NAME /// - /// The name of a team + /// _t__TeamGeneral::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// Number of members within a team + /// _t__TeamGeneral::NUM_MEMBERS /// - /// Number of members within a team + /// _t__TeamGeneral::NUM_MEMBERS [DataMember(Name = "num_members", EmitDefaultValue = true)] public int NumMembers { get; set; } /// - /// Number of sub teams within a team + /// _t__TeamGeneral::NUM_SUB_TEAMS /// - /// Number of sub teams within a team + /// _t__TeamGeneral::NUM_SUB_TEAMS [DataMember(Name = "num_sub_teams", EmitDefaultValue = true)] public int NumSubTeams { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TeamParentResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TeamParentResponse.cs index 37c513645..994bc5efc 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TeamParentResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TeamParentResponse.cs @@ -41,8 +41,8 @@ protected TeamParentResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of a team. - /// The name of a team. + /// _t__TeamGeneral::TEAM_ID. + /// _t__TeamGeneral::NAME. public TeamParentResponse(string teamId = default(string), string name = default(string)) { @@ -67,16 +67,16 @@ public static TeamParentResponse Init(string jsonData) } /// - /// The id of a team + /// _t__TeamGeneral::TEAM_ID /// - /// The id of a team + /// _t__TeamGeneral::TEAM_ID [DataMember(Name = "team_id", EmitDefaultValue = true)] public string TeamId { get; set; } /// - /// The name of a team + /// _t__TeamGeneral::NAME /// - /// The name of a team + /// _t__TeamGeneral::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs index 56d78eb53..d7930f83a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TeamResponse.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Contains information about your team and its members + /// _t__TeamResponse::DESCRIPTION /// [DataContract(Name = "TeamResponse")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,10 +41,10 @@ protected TeamResponse() { } /// /// Initializes a new instance of the class. /// - /// The name of your Team. + /// _t__Team::NAME. /// accounts. - /// 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`.. - /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.. + /// _t__Team::INVITED_ACCOUNTS. + /// _t__Team::INVITED_EMAILS. public TeamResponse(string name = default(string), List accounts = default(List), List invitedAccounts = default(List), List invitedEmails = default(List)) { @@ -71,9 +71,9 @@ public static TeamResponse Init(string jsonData) } /// - /// The name of your Team + /// _t__Team::NAME /// - /// The name of your Team + /// _t__Team::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } @@ -84,16 +84,16 @@ public static TeamResponse Init(string jsonData) public List Accounts { get; set; } /// - /// 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`. + /// _t__Team::INVITED_ACCOUNTS /// - /// 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`. + /// _t__Team::INVITED_ACCOUNTS [DataMember(Name = "invited_accounts", EmitDefaultValue = true)] public List InvitedAccounts { get; set; } /// - /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. + /// _t__Team::INVITED_EMAILS /// - /// A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. + /// _t__Team::INVITED_EMAILS [DataMember(Name = "invited_emails", EmitDefaultValue = true)] public List InvitedEmails { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs index 4220dc5df..37db31b24 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs @@ -45,7 +45,8 @@ protected TemplateCreateEmbeddedDraftRequest() { } /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. (default to true). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). - /// A list describing the attachments. + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). + /// _t__SubAttachment::LIST_DESCRIPTION. /// The CC roles that must be assigned when using the template to send a signature request. /// Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. (required). /// editorOptions. @@ -57,7 +58,7 @@ protected TemplateCreateEmbeddedDraftRequest() { } /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`. /// Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.. /// The default template email message.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. (default to false). /// When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. (default to true). /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.. @@ -66,7 +67,7 @@ protected TemplateCreateEmbeddedDraftRequest() { } /// Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). (default to false). - public TemplateCreateEmbeddedDraftRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowReassign = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), bool showPreview = false, bool showProgressStepper = true, List signerRoles = default(List), bool skipMeNow = false, string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false) + public TemplateCreateEmbeddedDraftRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowReassign = false, bool allowFormView = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), bool showPreview = false, bool showProgressStepper = true, List signerRoles = default(List), bool skipMeNow = false, string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false) { // to ensure "clientId" is required (not null) @@ -79,6 +80,7 @@ protected TemplateCreateEmbeddedDraftRequest() { } this.FileUrls = fileUrls; this.AllowCcs = allowCcs; this.AllowReassign = allowReassign; + this.AllowFormView = allowFormView; this.Attachments = attachments; this.CcRoles = ccRoles; this.EditorOptions = editorOptions; @@ -153,9 +155,16 @@ public static TemplateCreateEmbeddedDraftRequest Init(string jsonData) public bool AllowReassign { get; set; } /// - /// A list describing the attachments + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. /// - /// A list describing the attachments + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] + public bool AllowFormView { get; set; } + + /// + /// _t__SubAttachment::LIST_DESCRIPTION + /// + /// _t__SubAttachment::LIST_DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } @@ -228,9 +237,9 @@ public static TemplateCreateEmbeddedDraftRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } @@ -303,6 +312,7 @@ public override string ToString() sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); sb.Append(" AllowCcs: ").Append(AllowCcs).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); + sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" EditorOptions: ").Append(EditorOptions).Append("\n"); @@ -383,6 +393,10 @@ public bool Equals(TemplateCreateEmbeddedDraftRequest input) this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) ) && + ( + this.AllowFormView == input.AllowFormView || + this.AllowFormView.Equals(input.AllowFormView) + ) && ( this.Attachments == input.Attachments || this.Attachments != null && @@ -509,6 +523,7 @@ public override int GetHashCode() } hashCode = (hashCode * 59) + this.AllowCcs.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.Attachments != null) { hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); @@ -632,6 +647,13 @@ public List GetOpenApiTypes() Value = AllowReassign, }); types.Add(new OpenApiType() + { + Name = "allow_form_view", + Property = "AllowFormView", + Type = "bool", + Value = AllowFormView, + }); + types.Add(new OpenApiType() { Name = "attachments", Property = "Attachments", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponse.cs index 0318ae640..ceeaeb479 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponse.cs @@ -42,7 +42,7 @@ protected TemplateCreateEmbeddedDraftResponse() { } /// Initializes a new instance of the class. /// /// template (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public TemplateCreateEmbeddedDraftResponse(TemplateCreateEmbeddedDraftResponseTemplate template = default(TemplateCreateEmbeddedDraftResponseTemplate), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static TemplateCreateEmbeddedDraftResponse Init(string jsonData) public TemplateCreateEmbeddedDraftResponseTemplate Template { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs index fb8ca4762..b2b9105d8 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Template object with parameters: `template_id`, `edit_url`, `expires_at`. + /// _t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION /// [DataContract(Name = "TemplateCreateEmbeddedDraftResponseTemplate")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,10 +41,10 @@ protected TemplateCreateEmbeddedDraftResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. - /// Link to edit the template.. - /// When the link expires.. - /// A list of warnings.. + /// _t__TemplateResponse::TEMPLATE_ID. + /// _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL. + /// _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT. + /// _t__WarningResponse::LIST_DESCRIPTION. public TemplateCreateEmbeddedDraftResponseTemplate(string templateId = default(string), string editUrl = default(string), int expiresAt = default(int), List warnings = default(List)) { @@ -71,30 +71,30 @@ public static TemplateCreateEmbeddedDraftResponseTemplate Init(string jsonData) } /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID [DataMember(Name = "template_id", EmitDefaultValue = true)] public string TemplateId { get; set; } /// - /// Link to edit the template. + /// _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL /// - /// Link to edit the template. + /// _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL [DataMember(Name = "edit_url", EmitDefaultValue = true)] public string EditUrl { get; set; } /// - /// When the link expires. + /// _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT /// - /// When the link expires. + /// _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int ExpiresAt { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] [Obsolete] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs index 5db1a03e2..c6cfae477 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs @@ -44,7 +44,8 @@ protected TemplateCreateRequest() { } /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). - /// A list describing the attachments. + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). + /// _t__SubAttachment::LIST_DESCRIPTION. /// The CC roles that must be assigned when using the template to send a signature request. /// Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.. /// fieldOptions. @@ -53,13 +54,13 @@ protected TemplateCreateRequest() { } /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` (required). /// Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.. /// The default template email message.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. (required). /// The template title (alias).. /// Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). (default to false). - public TemplateCreateRequest(List files = default(List), List fileUrls = default(List), bool allowReassign = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signerRoles = default(List), string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false) + public TemplateCreateRequest(List files = default(List), List fileUrls = default(List), bool allowReassign = false, bool allowFormView = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signerRoles = default(List), string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false) { // to ensure "formFieldsPerDocument" is required (not null) @@ -77,6 +78,7 @@ protected TemplateCreateRequest() { } this.Files = files; this.FileUrls = fileUrls; this.AllowReassign = allowReassign; + this.AllowFormView = allowFormView; this.Attachments = attachments; this.CcRoles = ccRoles; this.ClientId = clientId; @@ -144,9 +146,16 @@ public static TemplateCreateRequest Init(string jsonData) public bool AllowReassign { get; set; } /// - /// A list describing the attachments + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. /// - /// A list describing the attachments + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] + public bool AllowFormView { get; set; } + + /// + /// _t__SubAttachment::LIST_DESCRIPTION + /// + /// _t__SubAttachment::LIST_DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } @@ -199,9 +208,9 @@ public static TemplateCreateRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } @@ -246,6 +255,7 @@ public override string ToString() sb.Append(" Files: ").Append(Files).Append("\n"); sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); + sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); @@ -322,6 +332,10 @@ public bool Equals(TemplateCreateRequest input) this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) ) && + ( + this.AllowFormView == input.AllowFormView || + this.AllowFormView.Equals(input.AllowFormView) + ) && ( this.Attachments == input.Attachments || this.Attachments != null && @@ -419,6 +433,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.Attachments != null) { hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); @@ -529,6 +544,13 @@ public List GetOpenApiTypes() Value = AllowReassign, }); types.Add(new OpenApiType() + { + Name = "allow_form_view", + Property = "AllowFormView", + Type = "bool", + Value = AllowFormView, + }); + types.Add(new OpenApiType() { Name = "attachments", Property = "Attachments", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponse.cs index 75494f1a0..622b04d02 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponse.cs @@ -42,7 +42,7 @@ protected TemplateCreateResponse() { } /// Initializes a new instance of the class. /// /// template (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public TemplateCreateResponse(TemplateCreateResponseTemplate template = default(TemplateCreateResponseTemplate), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static TemplateCreateResponse Init(string jsonData) public TemplateCreateResponseTemplate Template { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs index 1c362dd91..263eddf85 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Template object with parameters: `template_id`. + /// _t__TemplateCreateResponseTemplate::DESCRIPTION /// [DataContract(Name = "TemplateCreateResponseTemplate")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,7 +41,7 @@ protected TemplateCreateResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. + /// _t__TemplateResponse::TEMPLATE_ID. public TemplateCreateResponseTemplate(string templateId = default(string)) { @@ -65,9 +65,9 @@ public static TemplateCreateResponseTemplate Init(string jsonData) } /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID [DataMember(Name = "template_id", EmitDefaultValue = true)] public string TemplateId { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateEditResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateEditResponse.cs index f76b5eb4f..052a7bde3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateEditResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateEditResponse.cs @@ -41,7 +41,7 @@ protected TemplateEditResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template. (required). + /// _t__TemplateResponse::TEMPLATE_ID (required). public TemplateEditResponse(string templateId = default(string)) { @@ -70,9 +70,9 @@ public static TemplateEditResponse Init(string jsonData) } /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] public string TemplateId { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateGetResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateGetResponse.cs index 4e3bd7065..e6ee3f990 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateGetResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateGetResponse.cs @@ -42,7 +42,7 @@ protected TemplateGetResponse() { } /// Initializes a new instance of the class. /// /// template (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public TemplateGetResponse(TemplateResponse template = default(TemplateResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static TemplateGetResponse Init(string jsonData) public TemplateResponse Template { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateListResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateListResponse.cs index 75cdefa1f..5051e4c53 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateListResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateListResponse.cs @@ -41,9 +41,9 @@ protected TemplateListResponse() { } /// /// Initializes a new instance of the class. /// - /// List of templates that the API caller has access to. (required). + /// _t__TemplateListResponse::DESCRIPTION (required). /// listInfo (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public TemplateListResponse(List templates = default(List), ListInfoResponse listInfo = default(ListInfoResponse), List warnings = default(List)) { @@ -79,9 +79,9 @@ public static TemplateListResponse Init(string jsonData) } /// - /// List of templates that the API caller has access to. + /// _t__TemplateListResponse::DESCRIPTION /// - /// List of templates that the API caller has access to. + /// _t__TemplateListResponse::DESCRIPTION [DataMember(Name = "templates", IsRequired = true, EmitDefaultValue = true)] public List Templates { get; set; } @@ -92,9 +92,9 @@ public static TemplateListResponse Init(string jsonData) public ListInfoResponse ListInfo { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs index a298922d8..d1568bced 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Contains information about the templates you and your team have created. + /// _t__TemplateResponse::DESCRIPTION /// [DataContract(Name = "TemplateResponse")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,22 +41,22 @@ protected TemplateResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. - /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.. - /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.. - /// Time the template was last updated.. - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.. - /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member.. - /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).. - /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.. - /// The metadata attached to the template.. - /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.. - /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.. - /// An array describing each document associated with this Template. Includes form field data for each document.. - /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. - /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. - /// An array of the Accounts that can use this Template.. - /// Signer attachments.. + /// _t__TemplateResponse::TEMPLATE_ID. + /// _t__TemplateResponse::TITLE. + /// _t__TemplateResponse::MESSAGE. + /// _t__TemplateResponse::UPDATED_AT. + /// _t__TemplateResponse::IS_EMBEDDED. + /// _t__TemplateResponse::IS_CREATOR. + /// _t__TemplateResponse::CAN_EDIT. + /// _t__TemplateResponse::IS_LOCKED. + /// _t__TemplateResponse::METADATA. + /// _t__TemplateResponse::SIGNER_ROLES. + /// _t__TemplateResponse::CC_ROLES. + /// _t__TemplateResponse::DOCUMENTS. + /// _t__TemplateResponseCustomField::DESCRIPTION. + /// _t__TemplateResponseNamedFormField::DESCRIPTION. + /// _t__TemplateResponse::ACCOUNTS. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION. public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool isCreator = default(bool), bool canEdit = default(bool), bool isLocked = default(bool), Dictionary metadata = default(Dictionary), List signerRoles = default(List), List ccRoles = default(List), List documents = default(List), List customFields = default(List), List namedFormFields = default(List), List accounts = default(List), List attachments = default(List)) { @@ -95,116 +95,116 @@ public static TemplateResponse Init(string jsonData) } /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID [DataMember(Name = "template_id", EmitDefaultValue = true)] public string TemplateId { get; set; } /// - /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + /// _t__TemplateResponse::TITLE /// - /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + /// _t__TemplateResponse::TITLE [DataMember(Name = "title", EmitDefaultValue = true)] public string Title { get; set; } /// - /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + /// _t__TemplateResponse::MESSAGE /// - /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + /// _t__TemplateResponse::MESSAGE [DataMember(Name = "message", EmitDefaultValue = true)] public string Message { get; set; } /// - /// Time the template was last updated. + /// _t__TemplateResponse::UPDATED_AT /// - /// Time the template was last updated. + /// _t__TemplateResponse::UPDATED_AT [DataMember(Name = "updated_at", EmitDefaultValue = true)] public int UpdatedAt { get; set; } /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + /// _t__TemplateResponse::IS_EMBEDDED /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + /// _t__TemplateResponse::IS_EMBEDDED [DataMember(Name = "is_embedded", EmitDefaultValue = true)] public bool? IsEmbedded { get; set; } /// - /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. + /// _t__TemplateResponse::IS_CREATOR /// - /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. + /// _t__TemplateResponse::IS_CREATOR [DataMember(Name = "is_creator", EmitDefaultValue = true)] public bool IsCreator { get; set; } /// - /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). + /// _t__TemplateResponse::CAN_EDIT /// - /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). + /// _t__TemplateResponse::CAN_EDIT [DataMember(Name = "can_edit", EmitDefaultValue = true)] public bool CanEdit { get; set; } /// - /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + /// _t__TemplateResponse::IS_LOCKED /// - /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + /// _t__TemplateResponse::IS_LOCKED [DataMember(Name = "is_locked", EmitDefaultValue = true)] public bool IsLocked { get; set; } /// - /// The metadata attached to the template. + /// _t__TemplateResponse::METADATA /// - /// The metadata attached to the template. + /// _t__TemplateResponse::METADATA [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } /// - /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + /// _t__TemplateResponse::SIGNER_ROLES /// - /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + /// _t__TemplateResponse::SIGNER_ROLES [DataMember(Name = "signer_roles", EmitDefaultValue = true)] public List SignerRoles { get; set; } /// - /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + /// _t__TemplateResponse::CC_ROLES /// - /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + /// _t__TemplateResponse::CC_ROLES [DataMember(Name = "cc_roles", EmitDefaultValue = true)] public List CcRoles { get; set; } /// - /// An array describing each document associated with this Template. Includes form field data for each document. + /// _t__TemplateResponse::DOCUMENTS /// - /// An array describing each document associated with this Template. Includes form field data for each document. + /// _t__TemplateResponse::DOCUMENTS [DataMember(Name = "documents", EmitDefaultValue = true)] public List Documents { get; set; } /// - /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + /// _t__TemplateResponseCustomField::DESCRIPTION /// - /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + /// _t__TemplateResponseCustomField::DESCRIPTION [DataMember(Name = "custom_fields", EmitDefaultValue = true)] [Obsolete] public List CustomFields { get; set; } /// - /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + /// _t__TemplateResponseNamedFormField::DESCRIPTION /// - /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + /// _t__TemplateResponseNamedFormField::DESCRIPTION [DataMember(Name = "named_form_fields", EmitDefaultValue = true)] [Obsolete] public List NamedFormFields { get; set; } /// - /// An array of the Accounts that can use this Template. + /// _t__TemplateResponse::ACCOUNTS /// - /// An array of the Accounts that can use this Template. + /// _t__TemplateResponse::ACCOUNTS [DataMember(Name = "accounts", EmitDefaultValue = true)] public List Accounts { get; set; } /// - /// Signer attachments. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION /// - /// Signer attachments. + /// _t__SignatureRequestResponseAttachment::DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs index 0a40c5548..6dfb40246 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs @@ -41,11 +41,11 @@ protected TemplateResponseAccount() { } /// /// Initializes a new instance of the class. /// - /// The id of the Account.. - /// The email address associated with the Account.. - /// Returns `true` if the user has been locked out of their account by a team admin.. - /// Returns `true` if the user has a paid Dropbox Sign account.. - /// Returns `true` if the user has a paid HelloFax account.. + /// _t__TemplateResponseAccount::ACCOUNT_ID. + /// _t__TemplateResponseAccount::EMAIL_ADDRESS. + /// _t__TemplateResponseAccount::IS_LOCKED. + /// _t__TemplateResponseAccount::IS_PAID_HS. + /// _t__TemplateResponseAccount::IS_PAID_HF. /// quotas. public TemplateResponseAccount(string accountId = default(string), string emailAddress = default(string), bool isLocked = default(bool), bool isPaidHs = default(bool), bool isPaidHf = default(bool), TemplateResponseAccountQuota quotas = default(TemplateResponseAccountQuota)) { @@ -75,37 +75,37 @@ public static TemplateResponseAccount Init(string jsonData) } /// - /// The id of the Account. + /// _t__TemplateResponseAccount::ACCOUNT_ID /// - /// The id of the Account. + /// _t__TemplateResponseAccount::ACCOUNT_ID [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } /// - /// The email address associated with the Account. + /// _t__TemplateResponseAccount::EMAIL_ADDRESS /// - /// The email address associated with the Account. + /// _t__TemplateResponseAccount::EMAIL_ADDRESS [DataMember(Name = "email_address", EmitDefaultValue = true)] public string EmailAddress { get; set; } /// - /// Returns `true` if the user has been locked out of their account by a team admin. + /// _t__TemplateResponseAccount::IS_LOCKED /// - /// Returns `true` if the user has been locked out of their account by a team admin. + /// _t__TemplateResponseAccount::IS_LOCKED [DataMember(Name = "is_locked", EmitDefaultValue = true)] public bool IsLocked { get; set; } /// - /// Returns `true` if the user has a paid Dropbox Sign account. + /// _t__TemplateResponseAccount::IS_PAID_HS /// - /// Returns `true` if the user has a paid Dropbox Sign account. + /// _t__TemplateResponseAccount::IS_PAID_HS [DataMember(Name = "is_paid_hs", EmitDefaultValue = true)] public bool IsPaidHs { get; set; } /// - /// Returns `true` if the user has a paid HelloFax account. + /// _t__TemplateResponseAccount::IS_PAID_HF /// - /// Returns `true` if the user has a paid HelloFax account. + /// _t__TemplateResponseAccount::IS_PAID_HF [DataMember(Name = "is_paid_hf", EmitDefaultValue = true)] public bool IsPaidHf { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs index 5a67d889c..e7484fc0f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + /// _t__TemplateResponseAccountQuota::DESCRIPTION /// [DataContract(Name = "TemplateResponseAccountQuota")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,10 +41,10 @@ protected TemplateResponseAccountQuota() { } /// /// Initializes a new instance of the class. /// - /// API templates remaining.. - /// API signature requests remaining.. - /// Signature requests remaining.. - /// SMS verifications remaining.. + /// _t__TemplateResponseAccountQuota::TEMPLATES_LEFT. + /// _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT. + /// _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT. + /// _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT. public TemplateResponseAccountQuota(int templatesLeft = default(int), int apiSignatureRequestsLeft = default(int), int documentsLeft = default(int), int smsVerificationsLeft = default(int)) { @@ -71,30 +71,30 @@ public static TemplateResponseAccountQuota Init(string jsonData) } /// - /// API templates remaining. + /// _t__TemplateResponseAccountQuota::TEMPLATES_LEFT /// - /// API templates remaining. + /// _t__TemplateResponseAccountQuota::TEMPLATES_LEFT [DataMember(Name = "templates_left", EmitDefaultValue = true)] public int TemplatesLeft { get; set; } /// - /// API signature requests remaining. + /// _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT /// - /// API signature requests remaining. + /// _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT [DataMember(Name = "api_signature_requests_left", EmitDefaultValue = true)] public int ApiSignatureRequestsLeft { get; set; } /// - /// Signature requests remaining. + /// _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT /// - /// Signature requests remaining. + /// _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT [DataMember(Name = "documents_left", EmitDefaultValue = true)] public int DocumentsLeft { get; set; } /// - /// SMS verifications remaining. + /// _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT /// - /// SMS verifications remaining. + /// _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT [DataMember(Name = "sms_verifications_left", EmitDefaultValue = true)] public int SmsVerificationsLeft { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs index e153a6836..55d6cbd3e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs @@ -41,7 +41,7 @@ protected TemplateResponseCCRole() { } /// /// Initializes a new instance of the class. /// - /// The name of the Role.. + /// _t__TemplateResponseCCRole::NAME. public TemplateResponseCCRole(string name = default(string)) { @@ -65,9 +65,9 @@ public static TemplateResponseCCRole Init(string jsonData) } /// - /// The name of the Role. + /// _t__TemplateResponseCCRole::NAME /// - /// The name of the Role. + /// _t__TemplateResponseCCRole::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs index 461b2f2fa..d651809f1 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs @@ -41,12 +41,12 @@ protected TemplateResponseDocument() { } /// /// Initializes a new instance of the class. /// - /// Name of the associated file.. - /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing).. - /// An array of Form Field Group objects.. - /// An array of Form Field objects containing the name and type of each named field.. - /// An array of Form Field objects containing the name and type of each named field.. - /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.. + /// _t__TemplateResponseDocument::NAME. + /// _t__TemplateResponseDocument::INDEX. + /// _t__TemplateResponseDocument::FIELD_GROUPS. + /// _t__TemplateResponseDocumentFormField::DESCRIPTION. + /// _t__TemplateResponseDocumentCustomField::DESCRIPTION. + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION. public TemplateResponseDocument(string name = default(string), int index = default(int), List fieldGroups = default(List), List formFields = default(List), List customFields = default(List), List staticFields = default(List)) { @@ -75,44 +75,44 @@ public static TemplateResponseDocument Init(string jsonData) } /// - /// Name of the associated file. + /// _t__TemplateResponseDocument::NAME /// - /// Name of the associated file. + /// _t__TemplateResponseDocument::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + /// _t__TemplateResponseDocument::INDEX /// - /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + /// _t__TemplateResponseDocument::INDEX [DataMember(Name = "index", EmitDefaultValue = true)] public int Index { get; set; } /// - /// An array of Form Field Group objects. + /// _t__TemplateResponseDocument::FIELD_GROUPS /// - /// An array of Form Field Group objects. + /// _t__TemplateResponseDocument::FIELD_GROUPS [DataMember(Name = "field_groups", EmitDefaultValue = true)] public List FieldGroups { get; set; } /// - /// An array of Form Field objects containing the name and type of each named field. + /// _t__TemplateResponseDocumentFormField::DESCRIPTION /// - /// An array of Form Field objects containing the name and type of each named field. + /// _t__TemplateResponseDocumentFormField::DESCRIPTION [DataMember(Name = "form_fields", EmitDefaultValue = true)] public List FormFields { get; set; } /// - /// An array of Form Field objects containing the name and type of each named field. + /// _t__TemplateResponseDocumentCustomField::DESCRIPTION /// - /// An array of Form Field objects containing the name and type of each named field. + /// _t__TemplateResponseDocumentCustomField::DESCRIPTION [DataMember(Name = "custom_fields", EmitDefaultValue = true)] public List CustomFields { get; set; } /// - /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION /// - /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION [DataMember(Name = "static_fields", EmitDefaultValue = true)] public List StaticFields { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs index de66ae6db..8f7fffd15 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs @@ -28,7 +28,7 @@ namespace Dropbox.Sign.Model { /// - /// An array of Form Field objects containing the name and type of each named field. + /// _t__TemplateResponseDocumentCustomField::DESCRIPTION /// [DataContract(Name = "TemplateResponseDocumentCustomFieldBase")] [JsonConverter(typeof(JsonSubtypes), "Type")] @@ -45,16 +45,16 @@ protected TemplateResponseDocumentCustomFieldBase() { } /// /// Initializes a new instance of the class. /// - /// The unique ID for this field.. - /// The name of the Custom Field.. + /// _t__TemplateResponseDocumentCustomField::API_ID. + /// _t__TemplateResponseDocumentCustomField::NAME. /// type (required). - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentCustomField::SIGNER. + /// _t__TemplateResponseDocumentCustomField::X. + /// _t__TemplateResponseDocumentCustomField::Y. + /// _t__TemplateResponseDocumentCustomField::WIDTH. + /// _t__TemplateResponseDocumentCustomField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentCustomField::GROUP. public TemplateResponseDocumentCustomFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { @@ -98,23 +98,23 @@ public static TemplateResponseDocumentCustomFieldBase Init(string jsonData) public string Type { get; set; } /// - /// The unique ID for this field. + /// _t__TemplateResponseDocumentCustomField::API_ID /// - /// The unique ID for this field. + /// _t__TemplateResponseDocumentCustomField::API_ID [DataMember(Name = "api_id", EmitDefaultValue = true)] public string ApiId { get; set; } /// - /// The name of the Custom Field. + /// _t__TemplateResponseDocumentCustomField::NAME /// - /// The name of the Custom Field. + /// _t__TemplateResponseDocumentCustomField::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + /// _t__TemplateResponseDocumentCustomField::SIGNER /// - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + /// _t__TemplateResponseDocumentCustomField::SIGNER [DataMember(Name = "signer", EmitDefaultValue = true)] public object Signer { @@ -124,44 +124,44 @@ public object Signer private string _signer; /// - /// The horizontal offset in pixels for this form field. + /// _t__TemplateResponseDocumentCustomField::X /// - /// The horizontal offset in pixels for this form field. + /// _t__TemplateResponseDocumentCustomField::X [DataMember(Name = "x", EmitDefaultValue = true)] public int X { get; set; } /// - /// The vertical offset in pixels for this form field. + /// _t__TemplateResponseDocumentCustomField::Y /// - /// The vertical offset in pixels for this form field. + /// _t__TemplateResponseDocumentCustomField::Y [DataMember(Name = "y", EmitDefaultValue = true)] public int Y { get; set; } /// - /// The width in pixels of this form field. + /// _t__TemplateResponseDocumentCustomField::WIDTH /// - /// The width in pixels of this form field. + /// _t__TemplateResponseDocumentCustomField::WIDTH [DataMember(Name = "width", EmitDefaultValue = true)] public int Width { get; set; } /// - /// The height in pixels of this form field. + /// _t__TemplateResponseDocumentCustomField::HEIGHT /// - /// The height in pixels of this form field. + /// _t__TemplateResponseDocumentCustomField::HEIGHT [DataMember(Name = "height", EmitDefaultValue = true)] public int Height { get; set; } /// - /// Boolean showing whether or not this field is required. + /// _t__TemplateResponseDocumentStaticField::REQUIRED /// - /// Boolean showing whether or not this field is required. + /// _t__TemplateResponseDocumentStaticField::REQUIRED [DataMember(Name = "required", EmitDefaultValue = true)] public bool Required { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. + /// _t__TemplateResponseDocumentCustomField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. + /// _t__TemplateResponseDocumentCustomField::GROUP [DataMember(Name = "group", EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs index dde2bef21..5d373d8b7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentCustomFieldBase` + /// _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentCustomFieldCheckbox")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentCustomFieldCheckbox() { } /// /// Initializes a new instance of the class. /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` (required) (default to "checkbox"). - /// The unique ID for this field.. - /// The name of the Custom Field.. - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentCustomField::TYPE (required) (default to "checkbox"). + /// _t__TemplateResponseDocumentCustomField::API_ID. + /// _t__TemplateResponseDocumentCustomField::NAME. + /// _t__TemplateResponseDocumentCustomField::SIGNER. + /// _t__TemplateResponseDocumentCustomField::X. + /// _t__TemplateResponseDocumentCustomField::Y. + /// _t__TemplateResponseDocumentCustomField::WIDTH. + /// _t__TemplateResponseDocumentCustomField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentCustomField::GROUP. public TemplateResponseDocumentCustomFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -88,9 +88,9 @@ public static TemplateResponseDocumentCustomFieldCheckbox Init(string jsonData) } /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + /// _t__TemplateResponseDocumentCustomField::TYPE /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + /// _t__TemplateResponseDocumentCustomField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs index 1e850816f..6b2ee4843 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentCustomFieldBase` + /// _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentCustomFieldText")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,20 +41,20 @@ protected TemplateResponseDocumentCustomFieldText() { } /// /// Initializes a new instance of the class. /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` (required) (default to "text"). + /// _t__TemplateResponseDocumentCustomField::TYPE (required) (default to "text"). /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - /// The unique ID for this field.. - /// The name of the Custom Field.. - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentCustomField::IS_MULTILINE. + /// _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE. + /// _t__TemplateResponseDocumentCustomField::FONT_FAMILY. + /// _t__TemplateResponseDocumentCustomField::API_ID. + /// _t__TemplateResponseDocumentCustomField::NAME. + /// _t__TemplateResponseDocumentCustomField::SIGNER. + /// _t__TemplateResponseDocumentCustomField::X. + /// _t__TemplateResponseDocumentCustomField::Y. + /// _t__TemplateResponseDocumentCustomField::WIDTH. + /// _t__TemplateResponseDocumentCustomField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentCustomField::GROUP. public TemplateResponseDocumentCustomFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -96,9 +96,9 @@ public static TemplateResponseDocumentCustomFieldText Init(string jsonData) } /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + /// _t__TemplateResponseDocumentCustomField::TYPE /// - /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + /// _t__TemplateResponseDocumentCustomField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } @@ -109,23 +109,23 @@ public static TemplateResponseDocumentCustomFieldText Init(string jsonData) public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// - /// Whether this form field is multiline text. + /// _t__TemplateResponseDocumentCustomField::IS_MULTILINE /// - /// Whether this form field is multiline text. + /// _t__TemplateResponseDocumentCustomField::IS_MULTILINE [DataMember(Name = "isMultiline", EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// - /// Original font size used in this form field's text. + /// _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE /// - /// Original font size used in this form field's text. + /// _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// - /// Font family used in this form field's text. + /// _t__TemplateResponseDocumentCustomField::FONT_FAMILY /// - /// Font family used in this form field's text. + /// _t__TemplateResponseDocumentCustomField::FONT_FAMILY [DataMember(Name = "fontFamily", EmitDefaultValue = true)] public string FontFamily { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs index 019491e26..fde75f4ab 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs @@ -41,7 +41,7 @@ protected TemplateResponseDocumentFieldGroup() { } /// /// Initializes a new instance of the class. /// - /// The name of the form field group.. + /// _t__TemplateResponseDocumentFieldGroup::NAME. /// rule. public TemplateResponseDocumentFieldGroup(string name = default(string), TemplateResponseDocumentFieldGroupRule rule = default(TemplateResponseDocumentFieldGroupRule)) { @@ -67,9 +67,9 @@ public static TemplateResponseDocumentFieldGroup Init(string jsonData) } /// - /// The name of the form field group. + /// _t__TemplateResponseDocumentFieldGroup::NAME /// - /// The name of the form field group. + /// _t__TemplateResponseDocumentFieldGroup::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs index ad19e0e20..44a0cb30b 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). + /// _t__TemplateResponseDocumentFieldGroup::RULE /// [DataContract(Name = "TemplateResponseDocumentFieldGroupRule")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,8 +41,8 @@ protected TemplateResponseDocumentFieldGroupRule() { } /// /// Initializes a new instance of the class. /// - /// 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.. - /// Name of the group. + /// _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT. + /// _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL. public TemplateResponseDocumentFieldGroupRule(string requirement = default(string), string groupLabel = default(string)) { @@ -67,16 +67,16 @@ public static TemplateResponseDocumentFieldGroupRule Init(string jsonData) } /// - /// 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. + /// _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT /// - /// 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. + /// _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT [DataMember(Name = "requirement", EmitDefaultValue = true)] public string Requirement { get; set; } /// - /// Name of the group + /// _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL /// - /// Name of the group + /// _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL [DataMember(Name = "groupLabel", EmitDefaultValue = true)] public string GroupLabel { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs index 416901304..f43bcb95e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs @@ -28,7 +28,7 @@ namespace Dropbox.Sign.Model { /// - /// An array of Form Field objects containing the name and type of each named field. + /// _t__TemplateResponseDocumentFormField::DESCRIPTION /// [DataContract(Name = "TemplateResponseDocumentFormFieldBase")] [JsonConverter(typeof(JsonSubtypes), "Type")] @@ -51,15 +51,15 @@ protected TemplateResponseDocumentFormFieldBase() { } /// /// Initializes a new instance of the class. /// - /// A unique id for the form field.. - /// The name of the form field.. + /// _t__TemplateResponseDocumentFormField::API_ID. + /// _t__TemplateResponseDocumentFormField::NAME. /// type (required). - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// _t__TemplateResponseDocumentFormField::SIGNER. + /// _t__TemplateResponseDocumentFormField::X. + /// _t__TemplateResponseDocumentFormField::Y. + /// _t__TemplateResponseDocumentFormField::WIDTH. + /// _t__TemplateResponseDocumentFormField::HEIGHT. + /// _t__TemplateResponseDocumentFormField::REQUIRED. public TemplateResponseDocumentFormFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { @@ -102,23 +102,23 @@ public static TemplateResponseDocumentFormFieldBase Init(string jsonData) public string Type { get; set; } /// - /// A unique id for the form field. + /// _t__TemplateResponseDocumentFormField::API_ID /// - /// A unique id for the form field. + /// _t__TemplateResponseDocumentFormField::API_ID [DataMember(Name = "api_id", EmitDefaultValue = true)] public string ApiId { get; set; } /// - /// The name of the form field. + /// _t__TemplateResponseDocumentFormField::NAME /// - /// The name of the form field. + /// _t__TemplateResponseDocumentFormField::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// The signer of the Form Field. + /// _t__TemplateResponseDocumentFormField::SIGNER /// - /// The signer of the Form Field. + /// _t__TemplateResponseDocumentFormField::SIGNER [DataMember(Name = "signer", EmitDefaultValue = true)] public object Signer { @@ -128,37 +128,37 @@ public object Signer private string _signer; /// - /// The horizontal offset in pixels for this form field. + /// _t__TemplateResponseDocumentFormField::X /// - /// The horizontal offset in pixels for this form field. + /// _t__TemplateResponseDocumentFormField::X [DataMember(Name = "x", EmitDefaultValue = true)] public int X { get; set; } /// - /// The vertical offset in pixels for this form field. + /// _t__TemplateResponseDocumentFormField::Y /// - /// The vertical offset in pixels for this form field. + /// _t__TemplateResponseDocumentFormField::Y [DataMember(Name = "y", EmitDefaultValue = true)] public int Y { get; set; } /// - /// The width in pixels of this form field. + /// _t__TemplateResponseDocumentFormField::WIDTH /// - /// The width in pixels of this form field. + /// _t__TemplateResponseDocumentFormField::WIDTH [DataMember(Name = "width", EmitDefaultValue = true)] public int Width { get; set; } /// - /// The height in pixels of this form field. + /// _t__TemplateResponseDocumentFormField::HEIGHT /// - /// The height in pixels of this form field. + /// _t__TemplateResponseDocumentFormField::HEIGHT [DataMember(Name = "height", EmitDefaultValue = true)] public int Height { get; set; } /// - /// Boolean showing whether or not this field is required. + /// _t__TemplateResponseDocumentFormField::REQUIRED /// - /// Boolean showing whether or not this field is required. + /// _t__TemplateResponseDocumentFormField::REQUIRED [DataMember(Name = "required", EmitDefaultValue = true)] public bool Required { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs index 47f9cafc7..ae52ef409 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentFormFieldBase` + /// _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentFormFieldCheckbox")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentFormFieldCheckbox() { } /// /// Initializes a new instance of the class. /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "checkbox"). - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// _t__TemplateResponseDocumentFormField::TYPE (required) (default to "checkbox"). + /// _t__TemplateResponseDocumentFormField::GROUP. + /// _t__TemplateResponseDocumentFormField::API_ID. + /// _t__TemplateResponseDocumentFormField::NAME. + /// _t__TemplateResponseDocumentFormField::SIGNER. + /// _t__TemplateResponseDocumentFormField::X. + /// _t__TemplateResponseDocumentFormField::Y. + /// _t__TemplateResponseDocumentFormField::WIDTH. + /// _t__TemplateResponseDocumentFormField::HEIGHT. + /// _t__TemplateResponseDocumentFormField::REQUIRED. public TemplateResponseDocumentFormFieldCheckbox(string type = @"checkbox", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -88,16 +88,16 @@ public static TemplateResponseDocumentFormFieldCheckbox Init(string jsonData) } /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP [DataMember(Name = "group", EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs index d40024e3d..679af67aa 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentFormFieldBase` + /// _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentFormFieldDateSigned")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentFormFieldDateSigned() { } /// /// Initializes a new instance of the class. /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "date_signed"). - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// _t__TemplateResponseDocumentFormField::TYPE (required) (default to "date_signed"). + /// _t__TemplateResponseDocumentFormField::GROUP. + /// _t__TemplateResponseDocumentFormField::API_ID. + /// _t__TemplateResponseDocumentFormField::NAME. + /// _t__TemplateResponseDocumentFormField::SIGNER. + /// _t__TemplateResponseDocumentFormField::X. + /// _t__TemplateResponseDocumentFormField::Y. + /// _t__TemplateResponseDocumentFormField::WIDTH. + /// _t__TemplateResponseDocumentFormField::HEIGHT. + /// _t__TemplateResponseDocumentFormField::REQUIRED. public TemplateResponseDocumentFormFieldDateSigned(string type = @"date_signed", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -88,16 +88,16 @@ public static TemplateResponseDocumentFormFieldDateSigned Init(string jsonData) } /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP [DataMember(Name = "group", EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs index b1670234d..ea25edcc3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentFormFieldBase` + /// _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentFormFieldDropdown")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentFormFieldDropdown() { } /// /// Initializes a new instance of the class. /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "dropdown"). - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// _t__TemplateResponseDocumentFormField::TYPE (required) (default to "dropdown"). + /// _t__TemplateResponseDocumentFormField::GROUP. + /// _t__TemplateResponseDocumentFormField::API_ID. + /// _t__TemplateResponseDocumentFormField::NAME. + /// _t__TemplateResponseDocumentFormField::SIGNER. + /// _t__TemplateResponseDocumentFormField::X. + /// _t__TemplateResponseDocumentFormField::Y. + /// _t__TemplateResponseDocumentFormField::WIDTH. + /// _t__TemplateResponseDocumentFormField::HEIGHT. + /// _t__TemplateResponseDocumentFormField::REQUIRED. public TemplateResponseDocumentFormFieldDropdown(string type = @"dropdown", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -88,16 +88,16 @@ public static TemplateResponseDocumentFormFieldDropdown Init(string jsonData) } /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP [DataMember(Name = "group", EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs index 49bee3679..e83207a99 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentFormFieldBase` + /// _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentFormFieldHyperlink")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,20 +41,20 @@ protected TemplateResponseDocumentFormFieldHyperlink() { } /// /// Initializes a new instance of the class. /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "hyperlink"). + /// _t__TemplateResponseDocumentFormField::TYPE (required) (default to "hyperlink"). /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// _t__TemplateResponseDocumentFormField::IS_MULTILINE. + /// _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE. + /// _t__TemplateResponseDocumentFormField::FONT_FAMILY. + /// _t__TemplateResponseDocumentFormField::GROUP. + /// _t__TemplateResponseDocumentFormField::API_ID. + /// _t__TemplateResponseDocumentFormField::NAME. + /// _t__TemplateResponseDocumentFormField::SIGNER. + /// _t__TemplateResponseDocumentFormField::X. + /// _t__TemplateResponseDocumentFormField::Y. + /// _t__TemplateResponseDocumentFormField::WIDTH. + /// _t__TemplateResponseDocumentFormField::HEIGHT. + /// _t__TemplateResponseDocumentFormField::REQUIRED. public TemplateResponseDocumentFormFieldHyperlink(string type = @"hyperlink", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -96,9 +96,9 @@ public static TemplateResponseDocumentFormFieldHyperlink Init(string jsonData) } /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } @@ -109,30 +109,30 @@ public static TemplateResponseDocumentFormFieldHyperlink Init(string jsonData) public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// - /// Whether this form field is multiline text. + /// _t__TemplateResponseDocumentFormField::IS_MULTILINE /// - /// Whether this form field is multiline text. + /// _t__TemplateResponseDocumentFormField::IS_MULTILINE [DataMember(Name = "isMultiline", EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// - /// Original font size used in this form field's text. + /// _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE /// - /// Original font size used in this form field's text. + /// _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// - /// Font family used in this form field's text. + /// _t__TemplateResponseDocumentFormField::FONT_FAMILY /// - /// Font family used in this form field's text. + /// _t__TemplateResponseDocumentFormField::FONT_FAMILY [DataMember(Name = "fontFamily", EmitDefaultValue = true)] public string FontFamily { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP [DataMember(Name = "group", EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs index 8e8456328..868858d98 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentFormFieldBase` + /// _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentFormFieldInitials")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentFormFieldInitials() { } /// /// Initializes a new instance of the class. /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "initials"). - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// _t__TemplateResponseDocumentFormField::TYPE (required) (default to "initials"). + /// _t__TemplateResponseDocumentFormField::GROUP. + /// _t__TemplateResponseDocumentFormField::API_ID. + /// _t__TemplateResponseDocumentFormField::NAME. + /// _t__TemplateResponseDocumentFormField::SIGNER. + /// _t__TemplateResponseDocumentFormField::X. + /// _t__TemplateResponseDocumentFormField::Y. + /// _t__TemplateResponseDocumentFormField::WIDTH. + /// _t__TemplateResponseDocumentFormField::HEIGHT. + /// _t__TemplateResponseDocumentFormField::REQUIRED. public TemplateResponseDocumentFormFieldInitials(string type = @"initials", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -88,16 +88,16 @@ public static TemplateResponseDocumentFormFieldInitials Init(string jsonData) } /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP [DataMember(Name = "group", EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs index cbb5d59b3..8a2209148 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentFormFieldBase` + /// _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentFormFieldRadio")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentFormFieldRadio() { } /// /// Initializes a new instance of the class. /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "radio"). - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. (required). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// _t__TemplateResponseDocumentFormField::TYPE (required) (default to "radio"). + /// _t__TemplateResponseDocumentFormField::GROUP (required). + /// _t__TemplateResponseDocumentFormField::API_ID. + /// _t__TemplateResponseDocumentFormField::NAME. + /// _t__TemplateResponseDocumentFormField::SIGNER. + /// _t__TemplateResponseDocumentFormField::X. + /// _t__TemplateResponseDocumentFormField::Y. + /// _t__TemplateResponseDocumentFormField::WIDTH. + /// _t__TemplateResponseDocumentFormField::HEIGHT. + /// _t__TemplateResponseDocumentFormField::REQUIRED. public TemplateResponseDocumentFormFieldRadio(string type = @"radio", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -93,16 +93,16 @@ public static TemplateResponseDocumentFormFieldRadio Init(string jsonData) } /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP [DataMember(Name = "group", IsRequired = true, EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs index b42f09d33..36240ac55 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentFormFieldBase` + /// _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentFormFieldSignature")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentFormFieldSignature() { } /// /// Initializes a new instance of the class. /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "signature"). - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// _t__TemplateResponseDocumentFormField::TYPE (required) (default to "signature"). + /// _t__TemplateResponseDocumentFormField::GROUP. + /// _t__TemplateResponseDocumentFormField::API_ID. + /// _t__TemplateResponseDocumentFormField::NAME. + /// _t__TemplateResponseDocumentFormField::SIGNER. + /// _t__TemplateResponseDocumentFormField::X. + /// _t__TemplateResponseDocumentFormField::Y. + /// _t__TemplateResponseDocumentFormField::WIDTH. + /// _t__TemplateResponseDocumentFormField::HEIGHT. + /// _t__TemplateResponseDocumentFormField::REQUIRED. public TemplateResponseDocumentFormFieldSignature(string type = @"signature", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -88,16 +88,16 @@ public static TemplateResponseDocumentFormFieldSignature Init(string jsonData) } /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP [DataMember(Name = "group", EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs index 8c7509535..ff8cf6664 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs @@ -27,16 +27,16 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentFormFieldBase` + /// _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentFormFieldText")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] public partial class TemplateResponseDocumentFormFieldText : TemplateResponseDocumentFormFieldBase, IOpenApiTyped, IEquatable, IValidatableObject { /// - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + /// _t__TemplateResponseDocumentFormField::VALIDATION_TYPE /// - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + /// _t__TemplateResponseDocumentFormField::VALIDATION_TYPE [JsonConverter(typeof(StringEnumConverter))] public enum ValidationTypeEnum { @@ -103,9 +103,9 @@ public enum ValidationTypeEnum /// - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + /// _t__TemplateResponseDocumentFormField::VALIDATION_TYPE /// - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + /// _t__TemplateResponseDocumentFormField::VALIDATION_TYPE [DataMember(Name = "validation_type", EmitDefaultValue = true)] public ValidationTypeEnum? ValidationType { get; set; } /// @@ -116,23 +116,23 @@ protected TemplateResponseDocumentFormFieldText() { } /// /// Initializes a new instance of the class. /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "text"). + /// _t__TemplateResponseDocumentFormField::TYPE (required) (default to "text"). /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.. - /// When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.. - /// When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// _t__TemplateResponseDocumentFormField::IS_MULTILINE. + /// _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE. + /// _t__TemplateResponseDocumentFormField::FONT_FAMILY. + /// _t__TemplateResponseDocumentFormField::VALIDATION_TYPE. + /// _t__TemplateResponseDocumentFormField::CUSTOM_REGEX. + /// _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL. + /// _t__TemplateResponseDocumentFormField::GROUP. + /// _t__TemplateResponseDocumentFormField::API_ID. + /// _t__TemplateResponseDocumentFormField::NAME. + /// _t__TemplateResponseDocumentFormField::SIGNER. + /// _t__TemplateResponseDocumentFormField::X. + /// _t__TemplateResponseDocumentFormField::Y. + /// _t__TemplateResponseDocumentFormField::WIDTH. + /// _t__TemplateResponseDocumentFormField::HEIGHT. + /// _t__TemplateResponseDocumentFormField::REQUIRED. public TemplateResponseDocumentFormFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), ValidationTypeEnum? validationType = default(ValidationTypeEnum?), string validationCustomRegex = default(string), string validationCustomRegexFormatLabel = default(string), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; @@ -177,9 +177,9 @@ public static TemplateResponseDocumentFormFieldText Init(string jsonData) } /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE /// - /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + /// _t__TemplateResponseDocumentFormField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } @@ -190,44 +190,44 @@ public static TemplateResponseDocumentFormFieldText Init(string jsonData) public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// - /// Whether this form field is multiline text. + /// _t__TemplateResponseDocumentFormField::IS_MULTILINE /// - /// Whether this form field is multiline text. + /// _t__TemplateResponseDocumentFormField::IS_MULTILINE [DataMember(Name = "isMultiline", EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// - /// Original font size used in this form field's text. + /// _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE /// - /// Original font size used in this form field's text. + /// _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// - /// Font family used in this form field's text. + /// _t__TemplateResponseDocumentFormField::FONT_FAMILY /// - /// Font family used in this form field's text. + /// _t__TemplateResponseDocumentFormField::FONT_FAMILY [DataMember(Name = "fontFamily", EmitDefaultValue = true)] public string FontFamily { get; set; } /// - /// When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. + /// _t__TemplateResponseDocumentFormField::CUSTOM_REGEX /// - /// When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. + /// _t__TemplateResponseDocumentFormField::CUSTOM_REGEX [DataMember(Name = "validation_custom_regex", EmitDefaultValue = true)] public string ValidationCustomRegex { get; set; } /// - /// When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. + /// _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL /// - /// When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. + /// _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL [DataMember(Name = "validation_custom_regex_format_label", EmitDefaultValue = true)] public string ValidationCustomRegexFormatLabel { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// _t__TemplateResponseDocumentFormField::GROUP [DataMember(Name = "group", EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs index 69281b328..721105026 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs @@ -28,7 +28,7 @@ namespace Dropbox.Sign.Model { /// - /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION /// [DataContract(Name = "TemplateResponseDocumentStaticFieldBase")] [JsonConverter(typeof(JsonSubtypes), "Type")] @@ -51,16 +51,16 @@ protected TemplateResponseDocumentStaticFieldBase() { } /// /// Initializes a new instance of the class. /// - /// A unique id for the static field.. - /// The name of the static field.. + /// _t__TemplateResponseDocumentStaticField::API_ID. + /// _t__TemplateResponseDocumentStaticField::NAME. /// type (required). - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentStaticField::SIGNER (default to "me_now"). + /// _t__TemplateResponseDocumentStaticField::X. + /// _t__TemplateResponseDocumentStaticField::Y. + /// _t__TemplateResponseDocumentStaticField::WIDTH. + /// _t__TemplateResponseDocumentStaticField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentStaticField::GROUP. public TemplateResponseDocumentStaticFieldBase(string apiId = default(string), string name = default(string), string type = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { @@ -105,65 +105,65 @@ public static TemplateResponseDocumentStaticFieldBase Init(string jsonData) public string Type { get; set; } /// - /// A unique id for the static field. + /// _t__TemplateResponseDocumentStaticField::API_ID /// - /// A unique id for the static field. + /// _t__TemplateResponseDocumentStaticField::API_ID [DataMember(Name = "api_id", EmitDefaultValue = true)] public string ApiId { get; set; } /// - /// The name of the static field. + /// _t__TemplateResponseDocumentStaticField::NAME /// - /// The name of the static field. + /// _t__TemplateResponseDocumentStaticField::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// The signer of the Static Field. + /// _t__TemplateResponseDocumentStaticField::SIGNER /// - /// The signer of the Static Field. + /// _t__TemplateResponseDocumentStaticField::SIGNER [DataMember(Name = "signer", EmitDefaultValue = true)] public string Signer { get; set; } /// - /// The horizontal offset in pixels for this static field. + /// _t__TemplateResponseDocumentStaticField::X /// - /// The horizontal offset in pixels for this static field. + /// _t__TemplateResponseDocumentStaticField::X [DataMember(Name = "x", EmitDefaultValue = true)] public int X { get; set; } /// - /// The vertical offset in pixels for this static field. + /// _t__TemplateResponseDocumentStaticField::Y /// - /// The vertical offset in pixels for this static field. + /// _t__TemplateResponseDocumentStaticField::Y [DataMember(Name = "y", EmitDefaultValue = true)] public int Y { get; set; } /// - /// The width in pixels of this static field. + /// _t__TemplateResponseDocumentStaticField::WIDTH /// - /// The width in pixels of this static field. + /// _t__TemplateResponseDocumentStaticField::WIDTH [DataMember(Name = "width", EmitDefaultValue = true)] public int Width { get; set; } /// - /// The height in pixels of this static field. + /// _t__TemplateResponseDocumentStaticField::HEIGHT /// - /// The height in pixels of this static field. + /// _t__TemplateResponseDocumentStaticField::HEIGHT [DataMember(Name = "height", EmitDefaultValue = true)] public int Height { get; set; } /// - /// Boolean showing whether or not this field is required. + /// _t__TemplateResponseDocumentStaticField::REQUIRED /// - /// Boolean showing whether or not this field is required. + /// _t__TemplateResponseDocumentStaticField::REQUIRED [DataMember(Name = "required", EmitDefaultValue = true)] public bool Required { get; set; } /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. + /// _t__TemplateResponseDocumentStaticField::GROUP /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null`. + /// _t__TemplateResponseDocumentStaticField::GROUP [DataMember(Name = "group", EmitDefaultValue = true)] public string Group { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs index 0d5fce147..7bca51672 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentStaticFieldBase` + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentStaticFieldCheckbox")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentStaticFieldCheckbox() { } /// /// Initializes a new instance of the class. /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "checkbox"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentStaticField::TYPE (required) (default to "checkbox"). + /// _t__TemplateResponseDocumentStaticField::API_ID. + /// _t__TemplateResponseDocumentStaticField::NAME. + /// _t__TemplateResponseDocumentStaticField::SIGNER (default to "me_now"). + /// _t__TemplateResponseDocumentStaticField::X. + /// _t__TemplateResponseDocumentStaticField::Y. + /// _t__TemplateResponseDocumentStaticField::WIDTH. + /// _t__TemplateResponseDocumentStaticField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentStaticField::GROUP. public TemplateResponseDocumentStaticFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -88,9 +88,9 @@ public static TemplateResponseDocumentStaticFieldCheckbox Init(string jsonData) } /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs index 4d30a2038..7fa1c5c31 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentStaticFieldBase` + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentStaticFieldDateSigned")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentStaticFieldDateSigned() { } /// /// Initializes a new instance of the class. /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "date_signed"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentStaticField::TYPE (required) (default to "date_signed"). + /// _t__TemplateResponseDocumentStaticField::API_ID. + /// _t__TemplateResponseDocumentStaticField::NAME. + /// _t__TemplateResponseDocumentStaticField::SIGNER (default to "me_now"). + /// _t__TemplateResponseDocumentStaticField::X. + /// _t__TemplateResponseDocumentStaticField::Y. + /// _t__TemplateResponseDocumentStaticField::WIDTH. + /// _t__TemplateResponseDocumentStaticField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentStaticField::GROUP. public TemplateResponseDocumentStaticFieldDateSigned(string type = @"date_signed", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -88,9 +88,9 @@ public static TemplateResponseDocumentStaticFieldDateSigned Init(string jsonData } /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs index 423e983f4..84574dfad 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentStaticFieldBase` + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentStaticFieldDropdown")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentStaticFieldDropdown() { } /// /// Initializes a new instance of the class. /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "dropdown"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentStaticField::TYPE (required) (default to "dropdown"). + /// _t__TemplateResponseDocumentStaticField::API_ID. + /// _t__TemplateResponseDocumentStaticField::NAME. + /// _t__TemplateResponseDocumentStaticField::SIGNER (default to "me_now"). + /// _t__TemplateResponseDocumentStaticField::X. + /// _t__TemplateResponseDocumentStaticField::Y. + /// _t__TemplateResponseDocumentStaticField::WIDTH. + /// _t__TemplateResponseDocumentStaticField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentStaticField::GROUP. public TemplateResponseDocumentStaticFieldDropdown(string type = @"dropdown", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -88,9 +88,9 @@ public static TemplateResponseDocumentStaticFieldDropdown Init(string jsonData) } /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs index 78b8bd087..4bc65a833 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentStaticFieldBase` + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentStaticFieldHyperlink")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentStaticFieldHyperlink() { } /// /// Initializes a new instance of the class. /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "hyperlink"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentStaticField::TYPE (required) (default to "hyperlink"). + /// _t__TemplateResponseDocumentStaticField::API_ID. + /// _t__TemplateResponseDocumentStaticField::NAME. + /// _t__TemplateResponseDocumentStaticField::SIGNER (default to "me_now"). + /// _t__TemplateResponseDocumentStaticField::X. + /// _t__TemplateResponseDocumentStaticField::Y. + /// _t__TemplateResponseDocumentStaticField::WIDTH. + /// _t__TemplateResponseDocumentStaticField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentStaticField::GROUP. public TemplateResponseDocumentStaticFieldHyperlink(string type = @"hyperlink", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -88,9 +88,9 @@ public static TemplateResponseDocumentStaticFieldHyperlink Init(string jsonData) } /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs index cc5526323..09287b0e8 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentStaticFieldBase` + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentStaticFieldInitials")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentStaticFieldInitials() { } /// /// Initializes a new instance of the class. /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "initials"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentStaticField::TYPE (required) (default to "initials"). + /// _t__TemplateResponseDocumentStaticField::API_ID. + /// _t__TemplateResponseDocumentStaticField::NAME. + /// _t__TemplateResponseDocumentStaticField::SIGNER (default to "me_now"). + /// _t__TemplateResponseDocumentStaticField::X. + /// _t__TemplateResponseDocumentStaticField::Y. + /// _t__TemplateResponseDocumentStaticField::WIDTH. + /// _t__TemplateResponseDocumentStaticField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentStaticField::GROUP. public TemplateResponseDocumentStaticFieldInitials(string type = @"initials", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -88,9 +88,9 @@ public static TemplateResponseDocumentStaticFieldInitials Init(string jsonData) } /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs index 24f09b8c1..0f9415897 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentStaticFieldBase` + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentStaticFieldRadio")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentStaticFieldRadio() { } /// /// Initializes a new instance of the class. /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "radio"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentStaticField::TYPE (required) (default to "radio"). + /// _t__TemplateResponseDocumentStaticField::API_ID. + /// _t__TemplateResponseDocumentStaticField::NAME. + /// _t__TemplateResponseDocumentStaticField::SIGNER (default to "me_now"). + /// _t__TemplateResponseDocumentStaticField::X. + /// _t__TemplateResponseDocumentStaticField::Y. + /// _t__TemplateResponseDocumentStaticField::WIDTH. + /// _t__TemplateResponseDocumentStaticField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentStaticField::GROUP. public TemplateResponseDocumentStaticFieldRadio(string type = @"radio", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -88,9 +88,9 @@ public static TemplateResponseDocumentStaticFieldRadio Init(string jsonData) } /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs index 0d7ea03a6..eda107ecd 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentStaticFieldBase` + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentStaticFieldSignature")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentStaticFieldSignature() { } /// /// Initializes a new instance of the class. /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "signature"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentStaticField::TYPE (required) (default to "signature"). + /// _t__TemplateResponseDocumentStaticField::API_ID. + /// _t__TemplateResponseDocumentStaticField::NAME. + /// _t__TemplateResponseDocumentStaticField::SIGNER (default to "me_now"). + /// _t__TemplateResponseDocumentStaticField::X. + /// _t__TemplateResponseDocumentStaticField::Y. + /// _t__TemplateResponseDocumentStaticField::WIDTH. + /// _t__TemplateResponseDocumentStaticField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentStaticField::GROUP. public TemplateResponseDocumentStaticFieldSignature(string type = @"signature", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -88,9 +88,9 @@ public static TemplateResponseDocumentStaticFieldSignature Init(string jsonData) } /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs index 48c59ea75..4cf8e8d0c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This class extends `TemplateResponseDocumentStaticFieldBase` + /// _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS /// [DataContract(Name = "TemplateResponseDocumentStaticFieldText")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,16 +41,16 @@ protected TemplateResponseDocumentStaticFieldText() { } /// /// Initializes a new instance of the class. /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "text"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. + /// _t__TemplateResponseDocumentStaticField::TYPE (required) (default to "text"). + /// _t__TemplateResponseDocumentStaticField::API_ID. + /// _t__TemplateResponseDocumentStaticField::NAME. + /// _t__TemplateResponseDocumentStaticField::SIGNER (default to "me_now"). + /// _t__TemplateResponseDocumentStaticField::X. + /// _t__TemplateResponseDocumentStaticField::Y. + /// _t__TemplateResponseDocumentStaticField::WIDTH. + /// _t__TemplateResponseDocumentStaticField::HEIGHT. + /// _t__TemplateResponseDocumentStaticField::REQUIRED. + /// _t__TemplateResponseDocumentStaticField::GROUP. public TemplateResponseDocumentStaticFieldText(string type = @"text", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; @@ -88,9 +88,9 @@ public static TemplateResponseDocumentStaticFieldText Init(string jsonData) } /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE /// - /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + /// _t__TemplateResponseDocumentStaticField::TYPE [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs index 3d3ae1df2..971bd7b9f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Average text length in this field. + /// _t__TemplateResponseFieldAvgTextLength::DESCRIPTION /// [DataContract(Name = "TemplateResponseFieldAvgTextLength")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,8 +41,8 @@ protected TemplateResponseFieldAvgTextLength() { } /// /// Initializes a new instance of the class. /// - /// Number of lines.. - /// Number of characters per line.. + /// _t__TemplateResponseFieldAvgTextLength::NUM_LINES. + /// _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE. public TemplateResponseFieldAvgTextLength(int numLines = default(int), int numCharsPerLine = default(int)) { @@ -67,16 +67,16 @@ public static TemplateResponseFieldAvgTextLength Init(string jsonData) } /// - /// Number of lines. + /// _t__TemplateResponseFieldAvgTextLength::NUM_LINES /// - /// Number of lines. + /// _t__TemplateResponseFieldAvgTextLength::NUM_LINES [DataMember(Name = "num_lines", EmitDefaultValue = true)] public int NumLines { get; set; } /// - /// Number of characters per line. + /// _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE /// - /// Number of characters per line. + /// _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE [DataMember(Name = "num_chars_per_line", EmitDefaultValue = true)] public int NumCharsPerLine { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs index db464fd46..9cc9cf0a2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs @@ -41,8 +41,8 @@ protected TemplateResponseSignerRole() { } /// /// Initializes a new instance of the class. /// - /// The name of the Role.. - /// If signer order is assigned this is the 0-based index for this role.. + /// _t__TemplateResponseSignerRole::NAME. + /// _t__TemplateResponseSignerRole::ORDER. public TemplateResponseSignerRole(string name = default(string), int order = default(int)) { @@ -67,16 +67,16 @@ public static TemplateResponseSignerRole Init(string jsonData) } /// - /// The name of the Role. + /// _t__TemplateResponseSignerRole::NAME /// - /// The name of the Role. + /// _t__TemplateResponseSignerRole::NAME [DataMember(Name = "name", EmitDefaultValue = true)] public string Name { get; set; } /// - /// If signer order is assigned this is the 0-based index for this role. + /// _t__TemplateResponseSignerRole::ORDER /// - /// If signer order is assigned this is the 0-based index for this role. + /// _t__TemplateResponseSignerRole::ORDER [DataMember(Name = "order", EmitDefaultValue = true)] public int Order { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs index 4a8863338..493ccb293 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// Contains template id + /// _t__TemplateUpdateFilesResponseTemplate::DESCRIPTION /// [DataContract(Name = "TemplateUpdateFilesResponseTemplate")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,8 +41,8 @@ protected TemplateUpdateFilesResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. - /// A list of warnings.. + /// _t__TemplateResponse::TEMPLATE_ID. + /// _t__WarningResponse::LIST_DESCRIPTION. public TemplateUpdateFilesResponseTemplate(string templateId = default(string), List warnings = default(List)) { @@ -67,16 +67,16 @@ public static TemplateUpdateFilesResponseTemplate Init(string jsonData) } /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID /// - /// The id of the Template. + /// _t__TemplateResponse::TEMPLATE_ID [DataMember(Name = "template_id", EmitDefaultValue = true)] public string TemplateId { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] [Obsolete] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs index 00ece6767..7733cd7a6 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs @@ -72,8 +72,9 @@ protected UnclaimedDraftCreateEmbeddedRequest() { } /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. (default to true). /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). - /// A list describing the attachments. + /// _t__SubAttachment::LIST_DESCRIPTION. /// The email addresses that should be CCed.. /// Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. (required). /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. @@ -88,12 +89,12 @@ protected UnclaimedDraftCreateEmbeddedRequest() { } /// The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. (default to false). /// The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. (default to false). /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. (required). /// The URL you want signers redirected to after they successfully request a signature.. /// This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience.. /// When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. (default to true). - /// Add Signers to your Unclaimed Draft Signature Request.. + /// _t__Sub::UnclaimedDraftSigner::DESCRIPTION. /// signingOptions. /// The URL you want signers redirected to after they successfully sign.. /// Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. (default to false). @@ -104,7 +105,7 @@ protected UnclaimedDraftCreateEmbeddedRequest() { } /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.. - public UnclaimedDraftCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerPage = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool holdRequest = false, bool isForEmbeddedSigning = false, string message = default(string), Dictionary metadata = default(Dictionary), string requesterEmailAddress = default(string), string requestingRedirectUrl = default(string), bool showPreview = default(bool), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), bool skipMeNow = false, string subject = default(string), bool testMode = false, TypeEnum? type = TypeEnum.RequestSignature, bool usePreexistingFields = false, bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + public UnclaimedDraftCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowDecline = false, bool allowFormView = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerPage = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool holdRequest = false, bool isForEmbeddedSigning = false, string message = default(string), Dictionary metadata = default(Dictionary), string requesterEmailAddress = default(string), string requestingRedirectUrl = default(string), bool showPreview = default(bool), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), bool skipMeNow = false, string subject = default(string), bool testMode = false, TypeEnum? type = TypeEnum.RequestSignature, bool usePreexistingFields = false, bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) { // to ensure "clientId" is required (not null) @@ -123,6 +124,7 @@ protected UnclaimedDraftCreateEmbeddedRequest() { } this.FileUrls = fileUrls; this.AllowCcs = allowCcs; this.AllowDecline = allowDecline; + this.AllowFormView = allowFormView; this.AllowReassign = allowReassign; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; @@ -213,6 +215,13 @@ public static UnclaimedDraftCreateEmbeddedRequest Init(string jsonData) [DataMember(Name = "allow_decline", EmitDefaultValue = true)] public bool AllowDecline { get; set; } + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + /// + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] + public bool AllowFormView { get; set; } + /// /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. /// @@ -221,9 +230,9 @@ public static UnclaimedDraftCreateEmbeddedRequest Init(string jsonData) public bool AllowReassign { get; set; } /// - /// A list describing the attachments + /// _t__SubAttachment::LIST_DESCRIPTION /// - /// A list describing the attachments + /// _t__SubAttachment::LIST_DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } @@ -317,9 +326,9 @@ public static UnclaimedDraftCreateEmbeddedRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } @@ -345,9 +354,9 @@ public static UnclaimedDraftCreateEmbeddedRequest Init(string jsonData) public bool ShowProgressStepper { get; set; } /// - /// Add Signers to your Unclaimed Draft Signature Request. + /// _t__Sub::UnclaimedDraftSigner::DESCRIPTION /// - /// Add Signers to your Unclaimed Draft Signature Request. + /// _t__Sub::UnclaimedDraftSigner::DESCRIPTION [DataMember(Name = "signers", EmitDefaultValue = true)] public List Signers { get; set; } @@ -427,6 +436,7 @@ public override string ToString() sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); sb.Append(" AllowCcs: ").Append(AllowCcs).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); + sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); @@ -522,6 +532,10 @@ public bool Equals(UnclaimedDraftCreateEmbeddedRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && + ( + this.AllowFormView == input.AllowFormView || + this.AllowFormView.Equals(input.AllowFormView) + ) && ( this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) @@ -695,6 +709,7 @@ public override int GetHashCode() } hashCode = (hashCode * 59) + this.AllowCcs.GetHashCode(); hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); if (this.Attachments != null) { @@ -844,6 +859,13 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() + { + Name = "allow_form_view", + Property = "AllowFormView", + Type = "bool", + Value = AllowFormView, + }); + types.Add(new OpenApiType() { Name = "allow_reassign", Property = "AllowReassign", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.cs index 05ee292e4..e7653d33d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.cs @@ -55,13 +55,13 @@ protected UnclaimedDraftCreateEmbeddedWithTemplateRequest() { } /// The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. (default to false). /// The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. (default to false). /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). - `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience. **NOTE:** This parameter overwrites `show_preview=1` (if set). (default to false). /// The email address of the user that should be designated as the requester of this draft. (required). /// The URL you want signers redirected to after they successfully request a signature.. /// This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. (default to false). /// When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. (default to true). - /// Add Signers to your Templated-based Signature Request.. + /// _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION. /// signingOptions. /// The URL you want signers redirected to after they successfully sign.. /// Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. (default to false). @@ -248,9 +248,9 @@ public static UnclaimedDraftCreateEmbeddedWithTemplateRequest Init(string jsonDa public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } @@ -283,9 +283,9 @@ public static UnclaimedDraftCreateEmbeddedWithTemplateRequest Init(string jsonDa public bool ShowProgressStepper { get; set; } /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION /// - /// Add Signers to your Templated-based Signature Request. + /// _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION [DataMember(Name = "signers", EmitDefaultValue = true)] public List Signers { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs index 065407e17..c3fa2181b 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs @@ -71,7 +71,8 @@ protected UnclaimedDraftCreateRequest() { } /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// A list describing the attachments. + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). + /// _t__SubAttachment::LIST_DESCRIPTION. /// The email addresses that should be CCed.. /// Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.. /// When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.. @@ -81,9 +82,9 @@ protected UnclaimedDraftCreateRequest() { } /// The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`. /// Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. (default to false). /// The custom message in the email that will be sent to the signers.. - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.. + /// _t__Sub::Metadata::DESCRIPTION. /// When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. (default to true). - /// Add Signers to your Unclaimed Draft Signature Request.. + /// _t__Sub::UnclaimedDraftSigner::DESCRIPTION. /// signingOptions. /// The URL you want signers redirected to after they successfully sign.. /// The subject in the email that will be sent to the signers.. @@ -92,13 +93,14 @@ protected UnclaimedDraftCreateRequest() { } /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.. - public UnclaimedDraftCreateRequest(List files = default(List), List fileUrls = default(List), bool allowDecline = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, TypeEnum type = default(TypeEnum), bool usePreexistingFields = false, bool useTextTags = false, int? expiresAt = default(int?)) + public UnclaimedDraftCreateRequest(List files = default(List), List fileUrls = default(List), bool allowDecline = false, bool allowFormView = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, TypeEnum type = default(TypeEnum), bool usePreexistingFields = false, bool useTextTags = false, int? expiresAt = default(int?)) { this.Type = type; this.Files = files; this.FileUrls = fileUrls; this.AllowDecline = allowDecline; + this.AllowFormView = allowFormView; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; this.ClientId = clientId; @@ -159,9 +161,16 @@ public static UnclaimedDraftCreateRequest Init(string jsonData) public bool AllowDecline { get; set; } /// - /// A list describing the attachments + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. /// - /// A list describing the attachments + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] + public bool AllowFormView { get; set; } + + /// + /// _t__SubAttachment::LIST_DESCRIPTION + /// + /// _t__SubAttachment::LIST_DESCRIPTION [DataMember(Name = "attachments", EmitDefaultValue = true)] public List Attachments { get; set; } @@ -228,9 +237,9 @@ public static UnclaimedDraftCreateRequest Init(string jsonData) public string Message { get; set; } /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION /// - /// Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + /// _t__Sub::Metadata::DESCRIPTION [DataMember(Name = "metadata", EmitDefaultValue = true)] public Dictionary Metadata { get; set; } @@ -242,9 +251,9 @@ public static UnclaimedDraftCreateRequest Init(string jsonData) public bool ShowProgressStepper { get; set; } /// - /// Add Signers to your Unclaimed Draft Signature Request. + /// _t__Sub::UnclaimedDraftSigner::DESCRIPTION /// - /// Add Signers to your Unclaimed Draft Signature Request. + /// _t__Sub::UnclaimedDraftSigner::DESCRIPTION [DataMember(Name = "signers", EmitDefaultValue = true)] public List Signers { get; set; } @@ -308,6 +317,7 @@ public override string ToString() sb.Append(" Files: ").Append(Files).Append("\n"); sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); + sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); @@ -383,6 +393,10 @@ public bool Equals(UnclaimedDraftCreateRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && + ( + this.AllowFormView == input.AllowFormView || + this.AllowFormView.Equals(input.AllowFormView) + ) && ( this.Attachments == input.Attachments || this.Attachments != null && @@ -507,6 +521,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); + hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.Attachments != null) { hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); @@ -629,6 +644,13 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() + { + Name = "allow_form_view", + Property = "AllowFormView", + Type = "bool", + Value = AllowFormView, + }); + types.Add(new OpenApiType() { Name = "attachments", Property = "Attachments", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateResponse.cs index ec01e0526..028c9100e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateResponse.cs @@ -42,7 +42,7 @@ protected UnclaimedDraftCreateResponse() { } /// Initializes a new instance of the class. /// /// unclaimedDraft (required). - /// A list of warnings.. + /// _t__WarningResponse::LIST_DESCRIPTION. public UnclaimedDraftCreateResponse(UnclaimedDraftResponse unclaimedDraft = default(UnclaimedDraftResponse), List warnings = default(List)) { @@ -78,9 +78,9 @@ public static UnclaimedDraftCreateResponse Init(string jsonData) public UnclaimedDraftResponse UnclaimedDraft { get; set; } /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION [DataMember(Name = "warnings", EmitDefaultValue = true)] public List Warnings { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftResponse.cs index e670d6bab..6899e2d9c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftResponse.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// A group of documents that a user can take ownership of via the claim URL. + /// _t__UnclaimedDraftResponse::DESCRIPTION /// [DataContract(Name = "UnclaimedDraftResponse")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,12 +41,12 @@ protected UnclaimedDraftResponse() { } /// /// Initializes a new instance of the class. /// - /// The ID of the signature request that is represented by this UnclaimedDraft.. - /// The URL to be used to claim this UnclaimedDraft.. - /// The URL you want signers redirected to after they successfully sign.. - /// The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).. - /// When the link expires.. - /// Whether this is a test draft. Signature requests made from test drafts have no legal value.. + /// _t__UnclaimedDraft::SIGNATURE_REQUEST_ID. + /// _t__UnclaimedDraft::CLAIM_URL. + /// _t__UnclaimedDraft::SIGNING_REDIRECT_URL. + /// _t__UnclaimedDraft::REQUESTING_REDIRECT_URL. + /// _t__UnclaimedDraft::EXPIRES_AT. + /// _t__UnclaimedDraft::TEST_MODE. public UnclaimedDraftResponse(string signatureRequestId = default(string), string claimUrl = default(string), string signingRedirectUrl = default(string), string requestingRedirectUrl = default(string), int? expiresAt = default(int?), bool testMode = default(bool)) { @@ -75,44 +75,44 @@ public static UnclaimedDraftResponse Init(string jsonData) } /// - /// The ID of the signature request that is represented by this UnclaimedDraft. + /// _t__UnclaimedDraft::SIGNATURE_REQUEST_ID /// - /// The ID of the signature request that is represented by this UnclaimedDraft. + /// _t__UnclaimedDraft::SIGNATURE_REQUEST_ID [DataMember(Name = "signature_request_id", EmitDefaultValue = true)] public string SignatureRequestId { get; set; } /// - /// The URL to be used to claim this UnclaimedDraft. + /// _t__UnclaimedDraft::CLAIM_URL /// - /// The URL to be used to claim this UnclaimedDraft. + /// _t__UnclaimedDraft::CLAIM_URL [DataMember(Name = "claim_url", EmitDefaultValue = true)] public string ClaimUrl { get; set; } /// - /// The URL you want signers redirected to after they successfully sign. + /// _t__UnclaimedDraft::SIGNING_REDIRECT_URL /// - /// The URL you want signers redirected to after they successfully sign. + /// _t__UnclaimedDraft::SIGNING_REDIRECT_URL [DataMember(Name = "signing_redirect_url", EmitDefaultValue = true)] public string SigningRedirectUrl { get; set; } /// - /// The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). + /// _t__UnclaimedDraft::REQUESTING_REDIRECT_URL /// - /// The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). + /// _t__UnclaimedDraft::REQUESTING_REDIRECT_URL [DataMember(Name = "requesting_redirect_url", EmitDefaultValue = true)] public string RequestingRedirectUrl { get; set; } /// - /// When the link expires. + /// _t__UnclaimedDraft::EXPIRES_AT /// - /// When the link expires. + /// _t__UnclaimedDraft::EXPIRES_AT [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int? ExpiresAt { get; set; } /// - /// Whether this is a test draft. Signature requests made from test drafts have no legal value. + /// _t__UnclaimedDraft::TEST_MODE /// - /// Whether this is a test draft. Signature requests made from test drafts have no legal value. + /// _t__UnclaimedDraft::TEST_MODE [DataMember(Name = "test_mode", EmitDefaultValue = true)] public bool TestMode { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/WarningResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/WarningResponse.cs index f57c41f37..dcc404ae2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/WarningResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/WarningResponse.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// A list of warnings. + /// _t__WarningResponse::LIST_DESCRIPTION /// [DataContract(Name = "WarningResponse")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -41,8 +41,8 @@ protected WarningResponse() { } /// /// Initializes a new instance of the class. /// - /// Warning message (required). - /// Warning name (required). + /// _t__WarningResponse::WARNING_MSG (required). + /// _t__WarningResponse::WARNING_NAME (required). public WarningResponse(string warningMsg = default(string), string warningName = default(string)) { @@ -77,16 +77,16 @@ public static WarningResponse Init(string jsonData) } /// - /// Warning message + /// _t__WarningResponse::WARNING_MSG /// - /// Warning message + /// _t__WarningResponse::WARNING_MSG [DataMember(Name = "warning_msg", IsRequired = true, EmitDefaultValue = true)] public string WarningMsg { get; set; } /// - /// Warning name + /// _t__WarningResponse::WARNING_NAME /// - /// Warning name + /// _t__WarningResponse::WARNING_NAME [DataMember(Name = "warning_name", IsRequired = true, EmitDefaultValue = true)] public string WarningName { get; set; } diff --git a/sdks/java-v1/docs/AccountCreateResponse.md b/sdks/java-v1/docs/AccountCreateResponse.md index 7e09def2b..5cec28ba0 100644 --- a/sdks/java-v1/docs/AccountCreateResponse.md +++ b/sdks/java-v1/docs/AccountCreateResponse.md @@ -10,7 +10,7 @@ |------------ | ------------- | ------------- | -------------| | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | | `oauthData` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/AccountGetResponse.md b/sdks/java-v1/docs/AccountGetResponse.md index f5ed78b06..63d6404b9 100644 --- a/sdks/java-v1/docs/AccountGetResponse.md +++ b/sdks/java-v1/docs/AccountGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/AccountResponse.md b/sdks/java-v1/docs/AccountResponse.md index 5b73aa02d..db3336c8c 100644 --- a/sdks/java-v1/docs/AccountResponse.md +++ b/sdks/java-v1/docs/AccountResponse.md @@ -8,16 +8,16 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The ID of the Account | | -| `emailAddress` | ```String``` | The email address associated with the Account. | | -| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `accountId` | ```String``` | _t__Account::ACCOUNT_ID | | +| `emailAddress` | ```String``` | _t__Account::EMAIL_ADDRESS | | +| `isLocked` | ```Boolean``` | _t__Account::IS_LOCKED | | +| `isPaidHs` | ```Boolean``` | _t__Account::IS_PAID_HS | | +| `isPaidHf` | ```Boolean``` | _t__Account::IS_PAID_HF | | | `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | -| `callbackUrl` | ```String``` | The URL that Dropbox Sign events will `POST` to. | | -| `roleCode` | ```String``` | The membership role for the team. | | -| `teamId` | ```String``` | The id of the team account belongs to. | | -| `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. | | +| `callbackUrl` | ```String``` | _t__Account::CALLBACK_URL | | +| `roleCode` | ```String``` | _t__Account::ROLE_CODE | | +| `teamId` | ```String``` | _t__Account::TEAM_ID | | +| `locale` | ```String``` | _t__Account::LOCALE | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | diff --git a/sdks/java-v1/docs/AccountResponseQuotas.md b/sdks/java-v1/docs/AccountResponseQuotas.md index e7510a8d7..d742a9e83 100644 --- a/sdks/java-v1/docs/AccountResponseQuotas.md +++ b/sdks/java-v1/docs/AccountResponseQuotas.md @@ -2,18 +2,18 @@ # AccountResponseQuotas -Details concerning remaining monthly quotas. +_t__Account::QUOTA ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `templatesTotal` | ```Integer``` | Total API templates allowed. | | -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | +| `apiSignatureRequestsLeft` | ```Integer``` | _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documentsLeft` | ```Integer``` | _t__AccountQuota::DOCUMENTS_LEFT | | +| `templatesTotal` | ```Integer``` | _t__AccountQuota::TEMPLATES_TOTAL | | +| `templatesLeft` | ```Integer``` | _t__AccountQuota::TEMPLATES_LEFT | | +| `smsVerificationsLeft` | ```Integer``` | _t__AccountQuota::SMS_VERIFICATIONS_LEFT | | +| `numFaxPagesLeft` | ```Integer``` | _t__AccountQuota::NUM_FAX_PAGES_LEFT | | diff --git a/sdks/java-v1/docs/AccountResponseUsage.md b/sdks/java-v1/docs/AccountResponseUsage.md index 1cdb76629..782ab6465 100644 --- a/sdks/java-v1/docs/AccountResponseUsage.md +++ b/sdks/java-v1/docs/AccountResponseUsage.md @@ -2,13 +2,13 @@ # AccountResponseUsage -Details concerning monthly usage +_t__Account::USAGE ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `faxPagesSent` | ```Integer``` | Number of fax pages sent | | +| `faxPagesSent` | ```Integer``` | _t__AccountUsage::FAX_PAGES_SENT | | diff --git a/sdks/java-v1/docs/AccountVerifyResponse.md b/sdks/java-v1/docs/AccountVerifyResponse.md index 8868f15b2..c5d2054cc 100644 --- a/sdks/java-v1/docs/AccountVerifyResponse.md +++ b/sdks/java-v1/docs/AccountVerifyResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `account` | [```AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/AccountVerifyResponseAccount.md b/sdks/java-v1/docs/AccountVerifyResponseAccount.md index f83f9f0eb..5aa3c1b0f 100644 --- a/sdks/java-v1/docs/AccountVerifyResponseAccount.md +++ b/sdks/java-v1/docs/AccountVerifyResponseAccount.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `emailAddress` | ```String``` | The email address associated with the Account. | | +| `emailAddress` | ```String``` | _t__Account::EMAIL_ADDRESS | | diff --git a/sdks/java-v1/docs/ApiAppGetResponse.md b/sdks/java-v1/docs/ApiAppGetResponse.md index 98e2f98d6..d0e1efaef 100644 --- a/sdks/java-v1/docs/ApiAppGetResponse.md +++ b/sdks/java-v1/docs/ApiAppGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `apiApp`*_required_ | [```ApiAppResponse```](ApiAppResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/ApiAppListResponse.md b/sdks/java-v1/docs/ApiAppListResponse.md index 14c287f97..5e8621ee5 100644 --- a/sdks/java-v1/docs/ApiAppListResponse.md +++ b/sdks/java-v1/docs/ApiAppListResponse.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiApps`*_required_ | [```List```](ApiAppResponse.md) | Contains information about API Apps. | | +| `apiApps`*_required_ | [```List```](ApiAppResponse.md) | _t__ApiAppListResponse::DESCRIPTION | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/ApiAppResponse.md b/sdks/java-v1/docs/ApiAppResponse.md index afe95c850..d140acb51 100644 --- a/sdks/java-v1/docs/ApiAppResponse.md +++ b/sdks/java-v1/docs/ApiAppResponse.md @@ -2,18 +2,18 @@ # ApiAppResponse -Contains information about an API App. +_t__ApiAppResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl` | ```String``` | The app's callback URL (for events) | | -| `clientId` | ```String``` | The app's client id | | -| `createdAt` | ```Integer``` | The time that the app was created | | -| `domains` | ```List``` | The domain name(s) associated with the app | | -| `name` | ```String``` | The name of the app | | -| `isApproved` | ```Boolean``` | Boolean to indicate if the app has been approved | | +| `callbackUrl` | ```String``` | _t__ApiAppResponse::CALLBACK_URL | | +| `clientId` | ```String``` | _t__ApiAppResponse::CLIENT_ID | | +| `createdAt` | ```Integer``` | _t__ApiAppResponse::CREATED_AT | | +| `domains` | ```List``` | _t__ApiAppResponse::DOMAINS | | +| `name` | ```String``` | _t__ApiAppResponse::NAME | | +| `isApproved` | ```Boolean``` | _t__ApiAppResponse::IS_APPROVED | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | | `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | | `ownerAccount` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | diff --git a/sdks/java-v1/docs/ApiAppResponseOAuth.md b/sdks/java-v1/docs/ApiAppResponseOAuth.md index c2f705c7a..b74028732 100644 --- a/sdks/java-v1/docs/ApiAppResponseOAuth.md +++ b/sdks/java-v1/docs/ApiAppResponseOAuth.md @@ -2,16 +2,16 @@ # ApiAppResponseOAuth -An object describing the app's OAuth properties, or null if OAuth is not configured for the app. +_t__ApiAppResponseOAuth::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl` | ```String``` | The app's OAuth callback URL. | | -| `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```List``` | Array of OAuth scopes used by the app. | | -| `chargesUsers` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callbackUrl` | ```String``` | _t__ApiAppResponseOAuth::CALLBACK_URL | | +| `secret` | ```String``` | _t__ApiAppResponseOAuth::SECRET | | +| `scopes` | ```List``` | _t__ApiAppResponseOAuth::SCOPES | | +| `chargesUsers` | ```Boolean``` | _t__ApiAppResponseOAuth::CHARGES_USERS | | diff --git a/sdks/java-v1/docs/ApiAppResponseOptions.md b/sdks/java-v1/docs/ApiAppResponseOptions.md index 07979f387..1f56da408 100644 --- a/sdks/java-v1/docs/ApiAppResponseOptions.md +++ b/sdks/java-v1/docs/ApiAppResponseOptions.md @@ -2,13 +2,13 @@ # ApiAppResponseOptions -An object with options that override account settings. +_t__ApiAppResponseOptions::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `canInsertEverywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `canInsertEverywhere` | ```Boolean``` | _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE | | diff --git a/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md b/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md index b4d6d4249..6acc14f4e 100644 --- a/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/java-v1/docs/ApiAppResponseOwnerAccount.md @@ -2,14 +2,14 @@ # ApiAppResponseOwnerAccount -An object describing the app's owner +_t__ApiAppResponseOwnerAccount::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The owner account's ID | | -| `emailAddress` | ```String``` | The owner account's email address | | +| `accountId` | ```String``` | _t__ApiAppResponseOwnerAccount::ACCOUNT_ID | | +| `emailAddress` | ```String``` | _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS | | diff --git a/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md index be6d022fd..2d7dbfaa2 100644 --- a/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/java-v1/docs/ApiAppResponseWhiteLabelingOptions.md @@ -2,7 +2,7 @@ # ApiAppResponseWhiteLabelingOptions -An object with options to customize the app's signer page +_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION ## Properties diff --git a/sdks/java-v1/docs/BulkSendJobGetResponse.md b/sdks/java-v1/docs/BulkSendJobGetResponse.md index 93395ee2d..7a63dc95d 100644 --- a/sdks/java-v1/docs/BulkSendJobGetResponse.md +++ b/sdks/java-v1/docs/BulkSendJobGetResponse.md @@ -10,8 +10,8 @@ |------------ | ------------- | ------------- | -------------| | `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `signatureRequests`*_required_ | [```List```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `signatureRequests`*_required_ | [```List```](BulkSendJobGetResponseSignatureRequests.md) | _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/java-v1/docs/BulkSendJobGetResponseSignatureRequests.md index 09809ea86..fd76f9157 100644 --- a/sdks/java-v1/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/java-v1/docs/BulkSendJobGetResponseSignatureRequests.md @@ -8,31 +8,31 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `testMode` | ```Boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | | -| `signatureRequestId` | ```String``` | The id of the SignatureRequest. | | -| `requesterEmailAddress` | ```String``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```String``` | The title the specified Account uses for the SignatureRequest. | | -| `originalTitle` | ```String``` | Default Label for account. | | -| `subject` | ```String``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```String``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```Map``` | The metadata attached to the signature request. | | -| `createdAt` | ```Integer``` | Time the signature request was created. | | -| `expiresAt` | ```Integer``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `isComplete` | ```Boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `isDeclined` | ```Boolean``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `hasError` | ```Boolean``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `filesUrl` | ```String``` | The URL where a copy of the request's documents can be downloaded. | | -| `signingUrl` | ```String``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `detailsUrl` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `ccEmailAddresses` | ```List``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signingRedirectUrl` | ```String``` | The URL you want the signer redirected to after they successfully sign. | | -| `finalCopyUri` | ```String``` | The path where the completed document can be downloaded | | -| `templateIds` | ```List``` | Templates IDs used in this SignatureRequest (if any). | | -| `customFields` | [```List```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `responseData` | [```List```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```List```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | +| `testMode` | ```Boolean``` | _t__SignatureRequestResponse::TEST_MODE | | +| `signatureRequestId` | ```String``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requesterEmailAddress` | ```String``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```String``` | _t__SignatureRequestResponse::TITLE | | +| `originalTitle` | ```String``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```String``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```String``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```Map``` | _t__SignatureRequestResponse::METADATA | | +| `createdAt` | ```Integer``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expiresAt` | ```Integer``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `isComplete` | ```Boolean``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `isDeclined` | ```Boolean``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `hasError` | ```Boolean``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `filesUrl` | ```String``` | _t__SignatureRequestResponse::FILES_URL | | +| `signingUrl` | ```String``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `detailsUrl` | ```String``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `ccEmailAddresses` | ```List``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signingRedirectUrl` | ```String``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `finalCopyUri` | ```String``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `templateIds` | ```List``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `customFields` | [```List```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `responseData` | [```List```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```List```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulkSendJobId` | ```String``` | _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID | | diff --git a/sdks/java-v1/docs/BulkSendJobListResponse.md b/sdks/java-v1/docs/BulkSendJobListResponse.md index e5eb2315d..18ca67a32 100644 --- a/sdks/java-v1/docs/BulkSendJobListResponse.md +++ b/sdks/java-v1/docs/BulkSendJobListResponse.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `bulkSendJobs`*_required_ | [```List```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | +| `bulkSendJobs`*_required_ | [```List```](BulkSendJobResponse.md) | _t__BulkSendJobListResponse::BULK_SEND_JOBS | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/BulkSendJobResponse.md b/sdks/java-v1/docs/BulkSendJobResponse.md index eb2278a34..3eb55ac91 100644 --- a/sdks/java-v1/docs/BulkSendJobResponse.md +++ b/sdks/java-v1/docs/BulkSendJobResponse.md @@ -2,16 +2,16 @@ # BulkSendJobResponse -Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. +_t__BulkSendJobResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | -| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | | -| `isCreator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `createdAt` | ```Integer``` | Time that the BulkSendJob was created. | | +| `bulkSendJobId` | ```String``` | _t__BulkSendJobResponse::BULK_SEND_JOB_ID | | +| `total` | ```Integer``` | _t__BulkSendJobResponse::TOTAL | | +| `isCreator` | ```Boolean``` | _t__BulkSendJobResponse::IS_CREATOR | | +| `createdAt` | ```Integer``` | _t__BulkSendJobResponse::CREATED_AT | | diff --git a/sdks/java-v1/docs/BulkSendJobSendResponse.md b/sdks/java-v1/docs/BulkSendJobSendResponse.md index 532b64b5b..e53db9f2c 100644 --- a/sdks/java-v1/docs/BulkSendJobSendResponse.md +++ b/sdks/java-v1/docs/BulkSendJobSendResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/EmbeddedEditUrlRequest.md b/sdks/java-v1/docs/EmbeddedEditUrlRequest.md index 4e2d8c2e9..a6b29059c 100644 --- a/sdks/java-v1/docs/EmbeddedEditUrlRequest.md +++ b/sdks/java-v1/docs/EmbeddedEditUrlRequest.md @@ -9,6 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `allowEditCcs` | ```Boolean``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `forceSignerRoles` | ```Boolean``` | Provide users the ability to review/edit the template signer roles. | | diff --git a/sdks/java-v1/docs/EmbeddedEditUrlResponse.md b/sdks/java-v1/docs/EmbeddedEditUrlResponse.md index 959e0c75f..cb92376ac 100644 --- a/sdks/java-v1/docs/EmbeddedEditUrlResponse.md +++ b/sdks/java-v1/docs/EmbeddedEditUrlResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `embedded`*_required_ | [```EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/EmbeddedEditUrlResponseEmbedded.md b/sdks/java-v1/docs/EmbeddedEditUrlResponseEmbedded.md index 78ad7026c..f1a83bd9a 100644 --- a/sdks/java-v1/docs/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/java-v1/docs/EmbeddedEditUrlResponseEmbedded.md @@ -2,14 +2,14 @@ # EmbeddedEditUrlResponseEmbedded -An embedded template object. +_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `editUrl` | ```String``` | A template url that can be opened in an iFrame. | | -| `expiresAt` | ```Integer``` | The specific time that the the `edit_url` link expires, in epoch. | | +| `editUrl` | ```String``` | _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL | | +| `expiresAt` | ```Integer``` | _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT | | diff --git a/sdks/java-v1/docs/EmbeddedSignUrlResponse.md b/sdks/java-v1/docs/EmbeddedSignUrlResponse.md index 6f39b97fe..8740aa776 100644 --- a/sdks/java-v1/docs/EmbeddedSignUrlResponse.md +++ b/sdks/java-v1/docs/EmbeddedSignUrlResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `embedded`*_required_ | [```EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/EmbeddedSignUrlResponseEmbedded.md b/sdks/java-v1/docs/EmbeddedSignUrlResponseEmbedded.md index b2fd6c9df..b98682a9e 100644 --- a/sdks/java-v1/docs/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/java-v1/docs/EmbeddedSignUrlResponseEmbedded.md @@ -2,14 +2,14 @@ # EmbeddedSignUrlResponseEmbedded -An object that contains necessary information to set up embedded signing. +_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `signUrl` | ```String``` | A signature url that can be opened in an iFrame. | | -| `expiresAt` | ```Integer``` | The specific time that the the `sign_url` link expires, in epoch. | | +| `signUrl` | ```String``` | _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL | | +| `expiresAt` | ```Integer``` | _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT | | diff --git a/sdks/java-v1/docs/ErrorResponseError.md b/sdks/java-v1/docs/ErrorResponseError.md index 656aa5c7f..6c9122d64 100644 --- a/sdks/java-v1/docs/ErrorResponseError.md +++ b/sdks/java-v1/docs/ErrorResponseError.md @@ -2,15 +2,15 @@ # ErrorResponseError -Contains information about an error that occurred. +_t__ErrorResponseError::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `errorMsg`*_required_ | ```String``` | Message describing an error. | | -| `errorName`*_required_ | ```String``` | Name of the error. | | -| `errorPath` | ```String``` | Path at which an error occurred. | | +| `errorMsg`*_required_ | ```String``` | _t__ErrorResponseError::ERROR_MSG | | +| `errorName`*_required_ | ```String``` | _t__ErrorResponseError::ERROR_NAME | | +| `errorPath` | ```String``` | _t__ErrorResponseError::ERROR_PATH | | diff --git a/sdks/java-v1/docs/EventCallbackRequestEvent.md b/sdks/java-v1/docs/EventCallbackRequestEvent.md index 19ab491c2..a0eeedb82 100644 --- a/sdks/java-v1/docs/EventCallbackRequestEvent.md +++ b/sdks/java-v1/docs/EventCallbackRequestEvent.md @@ -2,15 +2,15 @@ # EventCallbackRequestEvent -Basic information about the event that occurred. +_t__EventCallbackRequestEvent::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `eventTime`*_required_ | ```String``` | Time the event was created (using Unix time). | | -| `eventType`*_required_ | [```EventTypeEnum```](#EventTypeEnum) | Type of callback event that was triggered. | | -| `eventHash`*_required_ | ```String``` | Generated hash used to verify source of event data. | | +| `eventTime`*_required_ | ```String``` | _t__EventCallbackRequestEvent::EVENT_TIME | | +| `eventType`*_required_ | [```EventTypeEnum```](#EventTypeEnum) | _t__EventCallbackRequestEvent::EVENT_TYPE | | +| `eventHash`*_required_ | ```String``` | _t__EventCallbackRequestEvent::EVENT_HASH | | | `eventMetadata` | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | | diff --git a/sdks/java-v1/docs/EventCallbackRequestEventMetadata.md b/sdks/java-v1/docs/EventCallbackRequestEventMetadata.md index 13208c2d1..634a78637 100644 --- a/sdks/java-v1/docs/EventCallbackRequestEventMetadata.md +++ b/sdks/java-v1/docs/EventCallbackRequestEventMetadata.md @@ -2,16 +2,16 @@ # EventCallbackRequestEventMetadata -Specific metadata about the event. +_t__EventCallbackRequestEventMetadata::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `relatedSignatureId` | ```String``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | -| `reportedForAccountId` | ```String``` | Account ID the event was reported for. | | -| `reportedForAppId` | ```String``` | App ID the event was reported for. | | -| `eventMessage` | ```String``` | Message about a declined or failed (due to error) signature flow. | | +| `relatedSignatureId` | ```String``` | _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID | | +| `reportedForAccountId` | ```String``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID | | +| `reportedForAppId` | ```String``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID | | +| `eventMessage` | ```String``` | _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE | | diff --git a/sdks/java-v1/docs/FaxGetResponse.md b/sdks/java-v1/docs/FaxGetResponse.md index cc9dc6e57..99f950ac2 100644 --- a/sdks/java-v1/docs/FaxGetResponse.md +++ b/sdks/java-v1/docs/FaxGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/FileResponse.md b/sdks/java-v1/docs/FileResponse.md index 058a80ed5..d2eb324ff 100644 --- a/sdks/java-v1/docs/FileResponse.md +++ b/sdks/java-v1/docs/FileResponse.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `fileUrl`*_required_ | ```String``` | URL to the file. | | -| `expiresAt`*_required_ | ```Integer``` | When the link expires. | | +| `fileUrl`*_required_ | ```String``` | _t__FileResponse::FILE_URL | | +| `expiresAt`*_required_ | ```Integer``` | _t__FileResponse::EXPIRES_AT | | diff --git a/sdks/java-v1/docs/FileResponseDataUri.md b/sdks/java-v1/docs/FileResponseDataUri.md index 65c0b7dbc..97490ae00 100644 --- a/sdks/java-v1/docs/FileResponseDataUri.md +++ b/sdks/java-v1/docs/FileResponseDataUri.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `dataUri`*_required_ | ```String``` | File as base64 encoded string. | | +| `dataUri`*_required_ | ```String``` | _t__FileResponse::DATA_URI | | diff --git a/sdks/java-v1/docs/ListInfoResponse.md b/sdks/java-v1/docs/ListInfoResponse.md index b9d464ec7..e37eca0ac 100644 --- a/sdks/java-v1/docs/ListInfoResponse.md +++ b/sdks/java-v1/docs/ListInfoResponse.md @@ -2,16 +2,16 @@ # ListInfoResponse -Contains pagination information about the data returned. +_t__ListInfoResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numPages` | ```Integer``` | Total number of pages available. | | -| `numResults` | ```Integer``` | Total number of objects available. | | -| `page` | ```Integer``` | Number of the page being returned. | | -| `pageSize` | ```Integer``` | Objects returned per page. | | +| `numPages` | ```Integer``` | _t__ListInfoResponse::NUM_PAGES | | +| `numResults` | ```Integer``` | _t__ListInfoResponse::NUM_RESULTS | | +| `page` | ```Integer``` | _t__ListInfoResponse::PAGE | | +| `pageSize` | ```Integer``` | _t__ListInfoResponse::PAGE_SIZE | | diff --git a/sdks/java-v1/docs/OAuthTokenResponse.md b/sdks/java-v1/docs/OAuthTokenResponse.md index 86824ccb0..cb7b96bea 100644 --- a/sdks/java-v1/docs/OAuthTokenResponse.md +++ b/sdks/java-v1/docs/OAuthTokenResponse.md @@ -11,7 +11,7 @@ | `accessToken` | ```String``` | | | | `tokenType` | ```String``` | | | | `refreshToken` | ```String``` | | | -| `expiresIn` | ```Integer``` | Number of seconds until the `access_token` expires. Uses epoch time. | | +| `expiresIn` | ```Integer``` | _t__OAuthTokenResponse::EXPIRES_IN | | | `state` | ```String``` | | | diff --git a/sdks/java-v1/docs/ReportCreateRequest.md b/sdks/java-v1/docs/ReportCreateRequest.md index d2f4b67e2..78390304c 100644 --- a/sdks/java-v1/docs/ReportCreateRequest.md +++ b/sdks/java-v1/docs/ReportCreateRequest.md @@ -20,6 +20,7 @@ ---- | ----- | USER_ACTIVITY | "user_activity" | | DOCUMENT_STATUS | "document_status" | +| SMS_ACTIVITY | "sms_activity" | diff --git a/sdks/java-v1/docs/ReportCreateResponse.md b/sdks/java-v1/docs/ReportCreateResponse.md index 9fc8565de..a82a15904 100644 --- a/sdks/java-v1/docs/ReportCreateResponse.md +++ b/sdks/java-v1/docs/ReportCreateResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `report`*_required_ | [```ReportResponse```](ReportResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/ReportResponse.md b/sdks/java-v1/docs/ReportResponse.md index b48dde6f4..174c02b67 100644 --- a/sdks/java-v1/docs/ReportResponse.md +++ b/sdks/java-v1/docs/ReportResponse.md @@ -2,16 +2,16 @@ # ReportResponse -Contains information about the report request. +_t__ReportResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `success` | ```String``` | A message indicating the requested operation's success | | -| `startDate` | ```String``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | | -| `endDate` | ```String``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | | -| `reportType` | [```List<ReportTypeEnum>```](#List<ReportTypeEnum>) | 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). | | +| `success` | ```String``` | _t__ReportResponse::SUCCESS | | +| `startDate` | ```String``` | _t__ReportResponse::START_DATE | | +| `endDate` | ```String``` | _t__ReportResponse::END_DATE | | +| `reportType` | [```List<ReportTypeEnum>```](#List<ReportTypeEnum>) | _t__ReportResponse::REPORT_TYPE | | @@ -21,6 +21,7 @@ Contains information about the report request. ---- | ----- | USER_ACTIVITY | "user_activity" | | DOCUMENT_STATUS | "document_status" | +| SMS_ACTIVITY | "sms_activity" | diff --git a/sdks/java-v1/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index 4243ead1c..116960466 100644 --- a/sdks/java-v1/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -16,7 +16,7 @@ | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestBulkSendWithTemplateRequest.md index 1798f6fdc..858ce4fd0 100644 --- a/sdks/java-v1/docs/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestBulkSendWithTemplateRequest.md @@ -16,7 +16,7 @@ | `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md index 383f8a8f3..587f8487c 100644 --- a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md @@ -11,11 +11,12 @@ | `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -24,7 +25,7 @@ | `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 050a7e631..182ae7e12 100644 --- a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -10,14 +10,14 @@ |------------ | ------------- | ------------- | -------------| | `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md index dd8b06061..daa2c01f9 100644 --- a/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md @@ -11,11 +11,12 @@ | `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -24,7 +25,7 @@ | `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index 3cc3dee72..2c55580de 100644 --- a/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -10,14 +10,14 @@ |------------ | ------------- | ------------- | -------------| | `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/SignatureRequestEditRequest.md b/sdks/java-v1/docs/SignatureRequestEditRequest.md index 7fa3aca65..11ad2b410 100644 --- a/sdks/java-v1/docs/SignatureRequestEditRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditRequest.md @@ -10,11 +10,12 @@ |------------ | ------------- | ------------- | -------------| | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -25,7 +26,7 @@ | `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | | `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md index d079524b1..7e3c3193c 100644 --- a/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `clientId` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -18,7 +18,7 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v1/docs/SignatureRequestGetResponse.md b/sdks/java-v1/docs/SignatureRequestGetResponse.md index 25ce665c4..eda5746dc 100644 --- a/sdks/java-v1/docs/SignatureRequestGetResponse.md +++ b/sdks/java-v1/docs/SignatureRequestGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `signatureRequest`*_required_ | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/SignatureRequestListResponse.md b/sdks/java-v1/docs/SignatureRequestListResponse.md index 6384d2ad0..87cccab67 100644 --- a/sdks/java-v1/docs/SignatureRequestListResponse.md +++ b/sdks/java-v1/docs/SignatureRequestListResponse.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `signatureRequests`*_required_ | [```List```](SignatureRequestResponse.md) | Contains information about signature requests. | | +| `signatureRequests`*_required_ | [```List```](SignatureRequestResponse.md) | _t__SignatureRequestListResponse::DESCRIPTION | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/SignatureRequestResponse.md b/sdks/java-v1/docs/SignatureRequestResponse.md index 6e8d9645c..15b148c8e 100644 --- a/sdks/java-v1/docs/SignatureRequestResponse.md +++ b/sdks/java-v1/docs/SignatureRequestResponse.md @@ -2,37 +2,37 @@ # SignatureRequestResponse -Contains information about a signature request. +_t__SignatureRequestResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `testMode` | ```Boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | | -| `signatureRequestId` | ```String``` | The id of the SignatureRequest. | | -| `requesterEmailAddress` | ```String``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```String``` | The title the specified Account uses for the SignatureRequest. | | -| `originalTitle` | ```String``` | Default Label for account. | | -| `subject` | ```String``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```String``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```Map``` | The metadata attached to the signature request. | | -| `createdAt` | ```Integer``` | Time the signature request was created. | | -| `expiresAt` | ```Integer``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `isComplete` | ```Boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `isDeclined` | ```Boolean``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `hasError` | ```Boolean``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `filesUrl` | ```String``` | The URL where a copy of the request's documents can be downloaded. | | -| `signingUrl` | ```String``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `detailsUrl` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `ccEmailAddresses` | ```List``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signingRedirectUrl` | ```String``` | The URL you want the signer redirected to after they successfully sign. | | -| `finalCopyUri` | ```String``` | The path where the completed document can be downloaded | | -| `templateIds` | ```List``` | Templates IDs used in this SignatureRequest (if any). | | -| `customFields` | [```List```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `responseData` | [```List```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```List```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulkSendJobId` | ```String``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `testMode` | ```Boolean``` | _t__SignatureRequestResponse::TEST_MODE | | +| `signatureRequestId` | ```String``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requesterEmailAddress` | ```String``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```String``` | _t__SignatureRequestResponse::TITLE | | +| `originalTitle` | ```String``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```String``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```String``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```Map``` | _t__SignatureRequestResponse::METADATA | | +| `createdAt` | ```Integer``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expiresAt` | ```Integer``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `isComplete` | ```Boolean``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `isDeclined` | ```Boolean``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `hasError` | ```Boolean``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `filesUrl` | ```String``` | _t__SignatureRequestResponse::FILES_URL | | +| `signingUrl` | ```String``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `detailsUrl` | ```String``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `ccEmailAddresses` | ```List``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signingRedirectUrl` | ```String``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `finalCopyUri` | ```String``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `templateIds` | ```List``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `customFields` | [```List```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `responseData` | [```List```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```List```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulkSendJobId` | ```String``` | _t__SignatureRequestResponse::BULK_SEND_JOB_ID | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseAttachment.md b/sdks/java-v1/docs/SignatureRequestResponseAttachment.md index 1ef3a209b..9c336fb99 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseAttachment.md +++ b/sdks/java-v1/docs/SignatureRequestResponseAttachment.md @@ -2,18 +2,18 @@ # SignatureRequestResponseAttachment -Signer attachments. +_t__SignatureRequestResponseAttachment::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `id`*_required_ | ```String``` | The unique ID for this attachment. | | -| `signer`*_required_ | ```String``` | The Signer this attachment is assigned to. | | -| `name`*_required_ | ```String``` | The name of this attachment. | | -| `required`*_required_ | ```Boolean``` | A boolean value denoting if this attachment is required. | | -| `instructions` | ```String``` | Instructions for Signer. | | -| `uploadedAt` | ```Integer``` | Timestamp when attachment was uploaded by Signer. | | +| `id`*_required_ | ```String``` | _t__SignatureRequestResponseAttachment::ID | | +| `signer`*_required_ | ```String``` | _t__SignatureRequestResponseAttachment::SIGNER | | +| `name`*_required_ | ```String``` | _t__SignatureRequestResponseAttachment::NAME | | +| `required`*_required_ | ```Boolean``` | _t__SignatureRequestResponseAttachment::REQUIRED | | +| `instructions` | ```String``` | _t__SignatureRequestResponseAttachment::INSTRUCTIONS | | +| `uploadedAt` | ```Integer``` | _t__SignatureRequestResponseAttachment::UPLOADED_AT | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseCustomFieldBase.md b/sdks/java-v1/docs/SignatureRequestResponseCustomFieldBase.md index 7b5f104c4..9e70c2c04 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/java-v1/docs/SignatureRequestResponseCustomFieldBase.md @@ -2,20 +2,17 @@ # SignatureRequestResponseCustomFieldBase -An array of Custom Field objects containing the name and type of each custom field. - -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` +_t__SignatureRequestResponseCustomField::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `name`*_required_ | ```String``` | The name of the Custom Field. | | -| `required` | ```Boolean``` | A boolean value denoting if this field is required. | | -| `apiId` | ```String``` | The unique ID for this field. | | -| `editor` | ```String``` | The name of the Role that is able to edit this field. | | +| `type`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `name`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::NAME | | +| `required` | ```Boolean``` | _t__SignatureRequestResponseCustomField::REQUIRED | | +| `apiId` | ```String``` | _t__SignatureRequestResponseCustomField::API_ID | | +| `editor` | ```String``` | _t__SignatureRequestResponseCustomField::EDITOR | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/java-v1/docs/SignatureRequestResponseCustomFieldCheckbox.md index c2cb8414b..4456feab9 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/java-v1/docs/SignatureRequestResponseCustomFieldCheckbox.md @@ -2,14 +2,14 @@ # SignatureRequestResponseCustomFieldCheckbox -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `value` | ```Boolean``` | A true/false for checkbox fields | | +| `type`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `value` | ```Boolean``` | _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseCustomFieldText.md b/sdks/java-v1/docs/SignatureRequestResponseCustomFieldText.md index 23ceb565c..aebc7c3a7 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseCustomFieldText.md +++ b/sdks/java-v1/docs/SignatureRequestResponseCustomFieldText.md @@ -2,14 +2,14 @@ # SignatureRequestResponseCustomFieldText -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `value` | ```String``` | A text string for text fields | | +| `type`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseCustomField::VALUE_TEXT | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataBase.md b/sdks/java-v1/docs/SignatureRequestResponseDataBase.md index a9605a44a..98fc540af 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataBase.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataBase.md @@ -2,16 +2,16 @@ # SignatureRequestResponseDataBase -An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. +_t__SignatureRequestResponseData::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiId` | ```String``` | The unique ID for this field. | | -| `signatureId` | ```String``` | The ID of the signature to which this response is linked. | | -| `name` | ```String``` | The name of the form field. | | -| `required` | ```Boolean``` | A boolean value denoting if this field is required. | | +| `apiId` | ```String``` | _t__SignatureRequestResponseData::API_ID | | +| `signatureId` | ```String``` | _t__SignatureRequestResponseData::SIGNATURE_ID | | +| `name` | ```String``` | _t__SignatureRequestResponseData::NAME | | +| `required` | ```Boolean``` | _t__SignatureRequestResponseData::REQUIRED | | | `type` | ```String``` | | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataValueCheckbox.md b/sdks/java-v1/docs/SignatureRequestResponseDataValueCheckbox.md index fda57045a..8223ce4d3 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataValueCheckbox.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A yes/no checkbox | | -| `value` | ```Boolean``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE | | +| `value` | ```Boolean``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/java-v1/docs/SignatureRequestResponseDataValueCheckboxMerge.md index 96af5ebaf..e74347dad 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataValueCheckboxMerge.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A checkbox field that has default value set by the api | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataValueDateSigned.md b/sdks/java-v1/docs/SignatureRequestResponseDataValueDateSigned.md index 308bd8bf2..c81ef7e9f 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataValueDateSigned.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A date | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataValueDropdown.md b/sdks/java-v1/docs/SignatureRequestResponseDataValueDropdown.md index 599cb3cef..a149d835f 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataValueDropdown.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | An input field for dropdowns | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataValueInitials.md b/sdks/java-v1/docs/SignatureRequestResponseDataValueInitials.md index 760618b49..3b23a11b0 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataValueInitials.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataValueInitials.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | An input field for initials | | -| `value` | ```String``` | The value of the form field. | | -| `isSigned` | ```Boolean``` | This field contains the boolean true if the field is signed. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::INITIAL_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `isSigned` | ```Boolean``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataValueRadio.md b/sdks/java-v1/docs/SignatureRequestResponseDataValueRadio.md index b8e073f1f..a883030e9 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataValueRadio.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataValueRadio.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | An input field for radios | | -| `value` | ```Boolean``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::RADIO_TYPE | | +| `value` | ```Boolean``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataValueSignature.md b/sdks/java-v1/docs/SignatureRequestResponseDataValueSignature.md index 8cea5ac2e..77ddcedd4 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataValueSignature.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataValueSignature.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A signature input field | | -| `value` | ```String``` | The value of the form field. | | -| `isSigned` | ```Boolean``` | This field contains the boolean true if the field is signed. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `isSigned` | ```Boolean``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataValueText.md b/sdks/java-v1/docs/SignatureRequestResponseDataValueText.md index e08ec8ff8..51cce03c0 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataValueText.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataValueText.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A text input field | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::TEXT_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseDataValueTextMerge.md b/sdks/java-v1/docs/SignatureRequestResponseDataValueTextMerge.md index 2b5e0d3fe..ff149de94 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/java-v1/docs/SignatureRequestResponseDataValueTextMerge.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A text field that has default text set by the api | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v1/docs/SignatureRequestResponseSignatures.md b/sdks/java-v1/docs/SignatureRequestResponseSignatures.md index 2f0e16dc0..51530b745 100644 --- a/sdks/java-v1/docs/SignatureRequestResponseSignatures.md +++ b/sdks/java-v1/docs/SignatureRequestResponseSignatures.md @@ -2,31 +2,31 @@ # SignatureRequestResponseSignatures -An array of signature objects, 1 for each signer. +_t__SignatureRequestResponseSignatures::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `signatureId` | ```String``` | Signature identifier. | | -| `signerGroupGuid` | ```String``` | Signer Group GUID | | -| `signerEmailAddress` | ```String``` | The email address of the signer. | | -| `signerName` | ```String``` | The name of the signer. | | -| `signerRole` | ```String``` | The role of the signer. | | -| `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this signer. | | -| `statusCode` | ```String``` | The current status of the signature. eg: awaiting_signature, signed, declined. | | -| `declineReason` | ```String``` | The reason provided by the signer for declining the request. | | -| `signedAt` | ```Integer``` | Time that the document was signed or null. | | -| `lastViewedAt` | ```Integer``` | The time that the document was last viewed by this signer or null. | | -| `lastRemindedAt` | ```Integer``` | The time the last reminder email was sent to the signer or null. | | -| `hasPin` | ```Boolean``` | Boolean to indicate whether this signature requires a PIN to access. | | -| `hasSmsAuth` | ```Boolean``` | Boolean to indicate whether this signature has SMS authentication enabled. | | -| `hasSmsDelivery` | ```Boolean``` | Boolean to indicate whether this signature has SMS delivery enabled. | | -| `smsPhoneNumber` | ```String``` | The SMS phone number used for authentication or signature request delivery. | | -| `reassignedBy` | ```String``` | Email address of original signer who reassigned to this signer. | | -| `reassignmentReason` | ```String``` | Reason provided by original signer who reassigned to this signer. | | -| `reassignedFrom` | ```String``` | Previous signature identifier. | | -| `error` | ```String``` | Error message pertaining to this signer, or null. | | +| `signatureId` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNATURE_ID | | +| `signerGroupGuid` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID | | +| `signerEmailAddress` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS | | +| `signerName` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_NAME | | +| `signerRole` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_ROLE | | +| `order` | ```Integer``` | _t__SignatureRequestResponseSignatures::ORDER | | +| `statusCode` | ```String``` | _t__SignatureRequestResponseSignatures::STATUS_CODE | | +| `declineReason` | ```String``` | _t__SignatureRequestResponseSignatures::DECLINE_REASON | | +| `signedAt` | ```Integer``` | _t__SignatureRequestResponseSignatures::SIGNED_AT | | +| `lastViewedAt` | ```Integer``` | _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT | | +| `lastRemindedAt` | ```Integer``` | _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT | | +| `hasPin` | ```Boolean``` | _t__SignatureRequestResponseSignatures::HAS_PIN | | +| `hasSmsAuth` | ```Boolean``` | _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH | | +| `hasSmsDelivery` | ```Boolean``` | _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY | | +| `smsPhoneNumber` | ```String``` | _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER | | +| `reassignedBy` | ```String``` | _t__SignatureRequestResponseSignatures::REASSIGNED_BY | | +| `reassignmentReason` | ```String``` | _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON | | +| `reassignedFrom` | ```String``` | _t__SignatureRequestResponseSignatures::REASSIGNED_FROM | | +| `error` | ```String``` | _t__SignatureRequestResponseSignatures::ERROR | | diff --git a/sdks/java-v1/docs/SignatureRequestSendRequest.md b/sdks/java-v1/docs/SignatureRequestSendRequest.md index 914303935..d0d039382 100644 --- a/sdks/java-v1/docs/SignatureRequestSendRequest.md +++ b/sdks/java-v1/docs/SignatureRequestSendRequest.md @@ -10,11 +10,12 @@ |------------ | ------------- | ------------- | -------------| | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -26,7 +27,7 @@ | `isQualifiedSignature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v1/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestSendWithTemplateRequest.md index 7a8d8c88a..4f648c089 100644 --- a/sdks/java-v1/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestSendWithTemplateRequest.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `clientId` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -19,7 +19,7 @@ | `isQualifiedSignature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v1/docs/SubFormFieldsPerDocumentBase.md b/sdks/java-v1/docs/SubFormFieldsPerDocumentBase.md index a44994a32..6ee822a91 100644 --- a/sdks/java-v1/docs/SubFormFieldsPerDocumentBase.md +++ b/sdks/java-v1/docs/SubFormFieldsPerDocumentBase.md @@ -27,9 +27,9 @@ The fields that should appear on the document, expressed as an array of objects. | `required`*_required_ | ```Boolean``` | Whether this field is required. | | | `signer`*_required_ | ```String``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | | | `type`*_required_ | ```String``` | | | -| `width`*_required_ | ```Integer``` | Size of the field in pixels. | | -| `x`*_required_ | ```Integer``` | Location coordinates of the field in pixels. | | -| `y`*_required_ | ```Integer``` | Location coordinates of the field in pixels. | | +| `width`*_required_ | ```Integer``` | _t__Sub::FormFieldsPerDocument::WIDTH | | +| `x`*_required_ | ```Integer``` | _t__Sub::FormFieldsPerDocument::X | | +| `y`*_required_ | ```Integer``` | _t__Sub::FormFieldsPerDocument::Y | | | `name` | ```String``` | Display name for the field. | | | `page` | ```Integer``` | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | | diff --git a/sdks/java-v1/docs/SubFormFieldsPerDocumentText.md b/sdks/java-v1/docs/SubFormFieldsPerDocumentText.md index d431f5422..2c02080a3 100644 --- a/sdks/java-v1/docs/SubFormFieldsPerDocumentText.md +++ b/sdks/java-v1/docs/SubFormFieldsPerDocumentText.md @@ -13,7 +13,7 @@ This class extends `SubFormFieldsPerDocumentBase`. | `autoFillType` | ```String``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | | | `linkId` | ```String``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | | | `masked` | ```Boolean``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | | -| `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.

**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | | +| `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE | | | `validationCustomRegex` | ```String``` | | | | `validationCustomRegexFormatLabel` | ```String``` | | | | `content` | ```String``` | Content of a `me_now` text field | | diff --git a/sdks/java-v1/docs/SubFormFieldsPerDocumentTextMerge.md b/sdks/java-v1/docs/SubFormFieldsPerDocumentTextMerge.md index e1876cce1..aabd1ff23 100644 --- a/sdks/java-v1/docs/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/java-v1/docs/SubFormFieldsPerDocumentTextMerge.md @@ -8,7 +8,7 @@ This class extends `SubFormFieldsPerDocumentBase`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | | +| `type`*_required_ | ```String``` | _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE | | | `fontFamily` | [```FontFamilyEnum```](#FontFamilyEnum) | Font family for the field. | | | `fontSize` | ```Integer``` | 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. | | diff --git a/sdks/java-v1/docs/SubMergeField.md b/sdks/java-v1/docs/SubMergeField.md index 66582350e..42b68e7f2 100644 --- a/sdks/java-v1/docs/SubMergeField.md +++ b/sdks/java-v1/docs/SubMergeField.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the merge field. Must be unique. | | -| `type`*_required_ | [```TypeEnum```](#TypeEnum) | The type of merge field. | | +| `name`*_required_ | ```String``` | _t__Sub::MergeField::NAME | | +| `type`*_required_ | [```TypeEnum```](#TypeEnum) | _t__Sub::MergeField::TYPE | | diff --git a/sdks/java-v1/docs/SubOAuth.md b/sdks/java-v1/docs/SubOAuth.md index 527d0be78..14b5533be 100644 --- a/sdks/java-v1/docs/SubOAuth.md +++ b/sdks/java-v1/docs/SubOAuth.md @@ -2,14 +2,14 @@ # SubOAuth -OAuth related parameters. +_t__Sub::OAuth::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl` | ```String``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | -| `scopes` | [```List<ScopesEnum>```](#List<ScopesEnum>) | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | +| `callbackUrl` | ```String``` | _t__Sub::OAuth::CALLBACK_URL | | +| `scopes` | [```List<ScopesEnum>```](#List<ScopesEnum>) | _t__Sub::OAuth::SCOPES | | diff --git a/sdks/java-v1/docs/SubOptions.md b/sdks/java-v1/docs/SubOptions.md index c36523a02..c71bcab56 100644 --- a/sdks/java-v1/docs/SubOptions.md +++ b/sdks/java-v1/docs/SubOptions.md @@ -2,13 +2,13 @@ # SubOptions -Additional options supported by API App. +_t__Sub::Options::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `canInsertEverywhere` | ```Boolean``` | Determines if signers can use "Insert Everywhere" when signing a document. | | +| `canInsertEverywhere` | ```Boolean``` | _t__Sub::Options::CAN_INSERT_EVERYWHERE | | diff --git a/sdks/java-v1/docs/SubSignatureRequestGroupedSigners.md b/sdks/java-v1/docs/SubSignatureRequestGroupedSigners.md index 80ace3400..92c98a2d3 100644 --- a/sdks/java-v1/docs/SubSignatureRequestGroupedSigners.md +++ b/sdks/java-v1/docs/SubSignatureRequestGroupedSigners.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `group`*_required_ | ```String``` | The name of the group. | | -| `signers`*_required_ | [```List```](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. | | -| `order` | ```Integer``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | +| `group`*_required_ | ```String``` | _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME | | +| `signers`*_required_ | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestGroupedSigners::SIGNERS | | +| `order` | ```Integer``` | _t__Sub::SignatureRequestGroupedSigners::ORDER | | diff --git a/sdks/java-v1/docs/SubSignatureRequestSigner.md b/sdks/java-v1/docs/SubSignatureRequestSigner.md index 109c422bc..77fac86d8 100644 --- a/sdks/java-v1/docs/SubSignatureRequestSigner.md +++ b/sdks/java-v1/docs/SubSignatureRequestSigner.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the signer. | | -| `emailAddress`*_required_ | ```String``` | The email address of the signer. | | -| `order` | ```Integer``` | The order the signer is required to sign in. | | -| `pin` | ```String``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `smsPhoneNumber` | ```String``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `smsPhoneNumberType` | [```SmsPhoneNumberTypeEnum```](#SmsPhoneNumberTypeEnum) | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `name`*_required_ | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_NAME | | +| `emailAddress`*_required_ | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS | | +| `order` | ```Integer``` | _t__Sub::SignatureRequestSigner::SIGNER_ORDER | | +| `pin` | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_PIN | | +| `smsPhoneNumber` | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER | | +| `smsPhoneNumberType` | [```SmsPhoneNumberTypeEnum```](#SmsPhoneNumberTypeEnum) | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | diff --git a/sdks/java-v1/docs/SubSignatureRequestTemplateSigner.md b/sdks/java-v1/docs/SubSignatureRequestTemplateSigner.md index 866b37355..493ff7554 100644 --- a/sdks/java-v1/docs/SubSignatureRequestTemplateSigner.md +++ b/sdks/java-v1/docs/SubSignatureRequestTemplateSigner.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `role`*_required_ | ```String``` | Must match an existing role in chosen Template(s). It's case-sensitive. | | -| `name`*_required_ | ```String``` | The name of the signer. | | -| `emailAddress`*_required_ | ```String``` | The email address of the signer. | | -| `pin` | ```String``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `smsPhoneNumber` | ```String``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `smsPhoneNumberType` | [```SmsPhoneNumberTypeEnum```](#SmsPhoneNumberTypeEnum) | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `role`*_required_ | ```String``` | _t__Sub::SignatureRequestTemplateSigner::ROLE | | +| `name`*_required_ | ```String``` | _t__Sub::SignatureRequestTemplateSigner::NAME | | +| `emailAddress`*_required_ | ```String``` | _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS | | +| `pin` | ```String``` | _t__Sub::SignatureRequestTemplateSigner::PIN | | +| `smsPhoneNumber` | ```String``` | _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER | | +| `smsPhoneNumberType` | [```SmsPhoneNumberTypeEnum```](#SmsPhoneNumberTypeEnum) | _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | diff --git a/sdks/java-v1/docs/SubSigningOptions.md b/sdks/java-v1/docs/SubSigningOptions.md index bca116053..d56c23080 100644 --- a/sdks/java-v1/docs/SubSigningOptions.md +++ b/sdks/java-v1/docs/SubSigningOptions.md @@ -2,19 +2,17 @@ # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. - -**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +_t__Sub::SigningOptions::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `defaultType`*_required_ | [```DefaultTypeEnum```](#DefaultTypeEnum) | The default type shown (limited to the listed types) | | -| `draw` | ```Boolean``` | Allows drawing the signature | | -| `phone` | ```Boolean``` | Allows using a smartphone to email the signature | | -| `type` | ```Boolean``` | Allows typing the signature | | -| `upload` | ```Boolean``` | Allows uploading the signature | | +| `defaultType`*_required_ | [```DefaultTypeEnum```](#DefaultTypeEnum) | _t__Sub::SigningOptions::DEFAULT | | +| `draw` | ```Boolean``` | _t__Sub::SigningOptions::DRAW | | +| `phone` | ```Boolean``` | _t__Sub::SigningOptions::PHONE | | +| `type` | ```Boolean``` | _t__Sub::SigningOptions::TYPE | | +| `upload` | ```Boolean``` | _t__Sub::SigningOptions::UPLOAD | | diff --git a/sdks/java-v1/docs/SubTeamResponse.md b/sdks/java-v1/docs/SubTeamResponse.md index df784d080..d7c49781d 100644 --- a/sdks/java-v1/docs/SubTeamResponse.md +++ b/sdks/java-v1/docs/SubTeamResponse.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `teamId` | ```String``` | The id of a team | | -| `name` | ```String``` | The name of a team | | +| `teamId` | ```String``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```String``` | _t__TeamGeneral::NAME | | diff --git a/sdks/java-v1/docs/SubTemplateRole.md b/sdks/java-v1/docs/SubTemplateRole.md index a1ee8e0ea..b044c491e 100644 --- a/sdks/java-v1/docs/SubTemplateRole.md +++ b/sdks/java-v1/docs/SubTemplateRole.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | -| `order` | ```Integer``` | The order in which this signer role is required to sign. | | +| `name` | ```String``` | _t__Sub::SignerRole::NAME | | +| `order` | ```Integer``` | _t__Sub::SignerRole::ORDER | | diff --git a/sdks/java-v1/docs/SubUnclaimedDraftSigner.md b/sdks/java-v1/docs/SubUnclaimedDraftSigner.md index fec680ac2..9c8d742e4 100644 --- a/sdks/java-v1/docs/SubUnclaimedDraftSigner.md +++ b/sdks/java-v1/docs/SubUnclaimedDraftSigner.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `emailAddress`*_required_ | ```String``` | The email address of the signer. | | -| `name`*_required_ | ```String``` | The name of the signer. | | -| `order` | ```Integer``` | The order the signer is required to sign in. | | +| `emailAddress`*_required_ | ```String``` | _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS | | +| `name`*_required_ | ```String``` | _t__Sub::UnclaimedDraftSigner::NAME | | +| `order` | ```Integer``` | _t__Sub::UnclaimedDraftSigner::ORDER | | diff --git a/sdks/java-v1/docs/SubUnclaimedDraftTemplateSigner.md b/sdks/java-v1/docs/SubUnclaimedDraftTemplateSigner.md index 1c6547670..8dcf716f0 100644 --- a/sdks/java-v1/docs/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/java-v1/docs/SubUnclaimedDraftTemplateSigner.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `role`*_required_ | ```String``` | Must match an existing role in chosen Template(s). | | -| `name`*_required_ | ```String``` | The name of the signer filling the role of `role`. | | -| `emailAddress`*_required_ | ```String``` | The email address of the signer filling the role of `role`. | | +| `role`*_required_ | ```String``` | _t__Sub::UnclaimedDraftTemplateSigner::ROLE | | +| `name`*_required_ | ```String``` | _t__Sub::UnclaimedDraftTemplateSigner::NAME | | +| `emailAddress`*_required_ | ```String``` | _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS | | diff --git a/sdks/java-v1/docs/SubWhiteLabelingOptions.md b/sdks/java-v1/docs/SubWhiteLabelingOptions.md index 0a5880da3..fb9827b53 100644 --- a/sdks/java-v1/docs/SubWhiteLabelingOptions.md +++ b/sdks/java-v1/docs/SubWhiteLabelingOptions.md @@ -2,9 +2,7 @@ # SubWhiteLabelingOptions -An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) - -Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. +_t__Sub::WhiteLabelingOptions::DESCRIPTION ## Properties @@ -24,7 +22,7 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r | `secondaryButtonTextColorHover` | ```String``` | | | | `textColor1` | ```String``` | | | | `textColor2` | ```String``` | | | -| `resetToDefault` | ```Boolean``` | Resets white labeling options to defaults. Only useful when updating an API App. | | +| `resetToDefault` | ```Boolean``` | _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT | | diff --git a/sdks/java-v1/docs/TeamGetInfoResponse.md b/sdks/java-v1/docs/TeamGetInfoResponse.md index 1d2bc62a7..e660412f6 100644 --- a/sdks/java-v1/docs/TeamGetInfoResponse.md +++ b/sdks/java-v1/docs/TeamGetInfoResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `team`*_required_ | [```TeamInfoResponse```](TeamInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/TeamGetResponse.md b/sdks/java-v1/docs/TeamGetResponse.md index 690796e1f..4da0b2998 100644 --- a/sdks/java-v1/docs/TeamGetResponse.md +++ b/sdks/java-v1/docs/TeamGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `team`*_required_ | [```TeamResponse```](TeamResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/TeamInfoResponse.md b/sdks/java-v1/docs/TeamInfoResponse.md index a776d4e09..180fac535 100644 --- a/sdks/java-v1/docs/TeamInfoResponse.md +++ b/sdks/java-v1/docs/TeamInfoResponse.md @@ -8,11 +8,11 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `teamId` | ```String``` | The id of a team | | +| `teamId` | ```String``` | _t__TeamGeneral::TEAM_ID | | | `teamParent` | [```TeamParentResponse```](TeamParentResponse.md) | | | -| `name` | ```String``` | The name of a team | | -| `numMembers` | ```Integer``` | Number of members within a team | | -| `numSubTeams` | ```Integer``` | Number of sub teams within a team | | +| `name` | ```String``` | _t__TeamGeneral::NAME | | +| `numMembers` | ```Integer``` | _t__TeamGeneral::NUM_MEMBERS | | +| `numSubTeams` | ```Integer``` | _t__TeamGeneral::NUM_SUB_TEAMS | | diff --git a/sdks/java-v1/docs/TeamParentResponse.md b/sdks/java-v1/docs/TeamParentResponse.md index c6ba18a98..b07d49809 100644 --- a/sdks/java-v1/docs/TeamParentResponse.md +++ b/sdks/java-v1/docs/TeamParentResponse.md @@ -8,8 +8,8 @@ Information about the parent team if a team has one, set to `null` otherwise. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `teamId` | ```String``` | The id of a team | | -| `name` | ```String``` | The name of a team | | +| `teamId` | ```String``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```String``` | _t__TeamGeneral::NAME | | diff --git a/sdks/java-v1/docs/TeamResponse.md b/sdks/java-v1/docs/TeamResponse.md index ca6344cfc..705bf01a8 100644 --- a/sdks/java-v1/docs/TeamResponse.md +++ b/sdks/java-v1/docs/TeamResponse.md @@ -2,16 +2,16 @@ # TeamResponse -Contains information about your team and its members +_t__TeamResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of your Team | | +| `name` | ```String``` | _t__Team::NAME | | | `accounts` | [```List```](AccountResponse.md) | | | -| `invitedAccounts` | [```List```](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`. | | -| `invitedEmails` | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `invitedAccounts` | [```List```](AccountResponse.md) | _t__Team::INVITED_ACCOUNTS | | +| `invitedEmails` | ```List``` | _t__Team::INVITED_EMAILS | | diff --git a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md index 05f2497fc..5d858ca9c 100644 --- a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md @@ -13,7 +13,8 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -24,7 +25,7 @@ | `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `mergeFields` | [```List```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```String``` | The default template email message. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `showPreview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | | `signerRoles` | [```List```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | diff --git a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponse.md b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponse.md index f25b48d33..c5d3e8c08 100644 --- a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `template`*_required_ | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 770cce434..2ad1028bb 100644 --- a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -2,16 +2,16 @@ # TemplateCreateEmbeddedDraftResponseTemplate -Template object with parameters: `template_id`, `edit_url`, `expires_at`. +_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `editUrl` | ```String``` | Link to edit the template. | | -| `expiresAt` | ```Integer``` | When the link expires. | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `templateId` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | +| `editUrl` | ```String``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL | | +| `expiresAt` | ```Integer``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/TemplateCreateRequest.md b/sdks/java-v1/docs/TemplateCreateRequest.md index 5f99510d9..c3d23ba82 100644 --- a/sdks/java-v1/docs/TemplateCreateRequest.md +++ b/sdks/java-v1/docs/TemplateCreateRequest.md @@ -13,7 +13,8 @@ | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `clientId` | ```String``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -21,7 +22,7 @@ | `formFieldRules` | [```List```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | | `mergeFields` | [```List```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```String``` | The default template email message. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `subject` | ```String``` | The template title (alias). | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | diff --git a/sdks/java-v1/docs/TemplateCreateResponse.md b/sdks/java-v1/docs/TemplateCreateResponse.md index 3c7389668..aa00f2dd0 100644 --- a/sdks/java-v1/docs/TemplateCreateResponse.md +++ b/sdks/java-v1/docs/TemplateCreateResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `template`*_required_ | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/TemplateCreateResponseTemplate.md b/sdks/java-v1/docs/TemplateCreateResponseTemplate.md index 1dcd4bd79..e250fdad4 100644 --- a/sdks/java-v1/docs/TemplateCreateResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateCreateResponseTemplate.md @@ -2,13 +2,13 @@ # TemplateCreateResponseTemplate -Template object with parameters: `template_id`. +_t__TemplateCreateResponseTemplate::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | diff --git a/sdks/java-v1/docs/TemplateEditResponse.md b/sdks/java-v1/docs/TemplateEditResponse.md index 88d225e68..78ec32e72 100644 --- a/sdks/java-v1/docs/TemplateEditResponse.md +++ b/sdks/java-v1/docs/TemplateEditResponse.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | diff --git a/sdks/java-v1/docs/TemplateGetResponse.md b/sdks/java-v1/docs/TemplateGetResponse.md index 2ee4867f0..ba33f5dd3 100644 --- a/sdks/java-v1/docs/TemplateGetResponse.md +++ b/sdks/java-v1/docs/TemplateGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `template`*_required_ | [```TemplateResponse```](TemplateResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/TemplateListResponse.md b/sdks/java-v1/docs/TemplateListResponse.md index 92b720c58..46d8c5a8b 100644 --- a/sdks/java-v1/docs/TemplateListResponse.md +++ b/sdks/java-v1/docs/TemplateListResponse.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templates`*_required_ | [```List```](TemplateResponse.md) | List of templates that the API caller has access to. | | +| `templates`*_required_ | [```List```](TemplateResponse.md) | _t__TemplateListResponse::DESCRIPTION | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/TemplateResponse.md b/sdks/java-v1/docs/TemplateResponse.md index 40de0fdc8..d39e3205d 100644 --- a/sdks/java-v1/docs/TemplateResponse.md +++ b/sdks/java-v1/docs/TemplateResponse.md @@ -2,28 +2,28 @@ # TemplateResponse -Contains information about the templates you and your team have created. +_t__TemplateResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `updatedAt` | ```Integer``` | Time the template was last updated. | | -| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | -| `isCreator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```Map``` | The metadata attached to the template. | | -| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `templateId` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | +| `title` | ```String``` | _t__TemplateResponse::TITLE | | +| `message` | ```String``` | _t__TemplateResponse::MESSAGE | | +| `updatedAt` | ```Integer``` | _t__TemplateResponse::UPDATED_AT | | +| `isEmbedded` | ```Boolean``` | _t__TemplateResponse::IS_EMBEDDED | | +| `isCreator` | ```Boolean``` | _t__TemplateResponse::IS_CREATOR | | +| `canEdit` | ```Boolean``` | _t__TemplateResponse::CAN_EDIT | | +| `isLocked` | ```Boolean``` | _t__TemplateResponse::IS_LOCKED | | +| `metadata` | ```Map``` | _t__TemplateResponse::METADATA | | +| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | _t__TemplateResponse::SIGNER_ROLES | | +| `ccRoles` | [```List```](TemplateResponseCCRole.md) | _t__TemplateResponse::CC_ROLES | | +| `documents` | [```List```](TemplateResponseDocument.md) | _t__TemplateResponse::DOCUMENTS | | +| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseCustomField::DESCRIPTION | | +| `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseNamedFormField::DESCRIPTION | | +| `accounts` | [```List```](TemplateResponseAccount.md) | _t__TemplateResponse::ACCOUNTS | | +| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | diff --git a/sdks/java-v1/docs/TemplateResponseAccount.md b/sdks/java-v1/docs/TemplateResponseAccount.md index 10c996408..d0902baf0 100644 --- a/sdks/java-v1/docs/TemplateResponseAccount.md +++ b/sdks/java-v1/docs/TemplateResponseAccount.md @@ -8,11 +8,11 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The id of the Account. | | -| `emailAddress` | ```String``` | The email address associated with the Account. | | -| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `accountId` | ```String``` | _t__TemplateResponseAccount::ACCOUNT_ID | | +| `emailAddress` | ```String``` | _t__TemplateResponseAccount::EMAIL_ADDRESS | | +| `isLocked` | ```Boolean``` | _t__TemplateResponseAccount::IS_LOCKED | | +| `isPaidHs` | ```Boolean``` | _t__TemplateResponseAccount::IS_PAID_HS | | +| `isPaidHf` | ```Boolean``` | _t__TemplateResponseAccount::IS_PAID_HF | | | `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/java-v1/docs/TemplateResponseAccountQuota.md b/sdks/java-v1/docs/TemplateResponseAccountQuota.md index ad94c2493..004f4d445 100644 --- a/sdks/java-v1/docs/TemplateResponseAccountQuota.md +++ b/sdks/java-v1/docs/TemplateResponseAccountQuota.md @@ -2,16 +2,16 @@ # TemplateResponseAccountQuota -An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. +_t__TemplateResponseAccountQuota::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `templatesLeft` | ```Integer``` | _t__TemplateResponseAccountQuota::TEMPLATES_LEFT | | +| `apiSignatureRequestsLeft` | ```Integer``` | _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documentsLeft` | ```Integer``` | _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT | | +| `smsVerificationsLeft` | ```Integer``` | _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT | | diff --git a/sdks/java-v1/docs/TemplateResponseCCRole.md b/sdks/java-v1/docs/TemplateResponseCCRole.md index 64069b826..b6877bd2f 100644 --- a/sdks/java-v1/docs/TemplateResponseCCRole.md +++ b/sdks/java-v1/docs/TemplateResponseCCRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name` | ```String``` | _t__TemplateResponseCCRole::NAME | | diff --git a/sdks/java-v1/docs/TemplateResponseDocument.md b/sdks/java-v1/docs/TemplateResponseDocument.md index 65da85d42..aaba331c1 100644 --- a/sdks/java-v1/docs/TemplateResponseDocument.md +++ b/sdks/java-v1/docs/TemplateResponseDocument.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | Name of the associated file. | | -| `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```String``` | _t__TemplateResponseDocument::NAME | | +| `index` | ```Integer``` | _t__TemplateResponseDocument::INDEX | | +| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | _t__TemplateResponseDocument::FIELD_GROUPS | | +| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseDocumentFormField::DESCRIPTION | | +| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseDocumentCustomField::DESCRIPTION | | +| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | _t__TemplateResponseDocumentStaticField::DESCRIPTION | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md index edd461727..a1223c732 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md @@ -2,22 +2,22 @@ # TemplateResponseDocumentCustomFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentCustomField::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | The unique ID for this field. | | -| `name` | ```String``` | The name of the Custom Field. | | -| `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `apiId` | ```String``` | _t__TemplateResponseDocumentCustomField::API_ID | | +| `name` | ```String``` | _t__TemplateResponseDocumentCustomField::NAME | | +| `signer` | ```String``` | _t__TemplateResponseDocumentCustomField::SIGNER | | +| `x` | ```Integer``` | _t__TemplateResponseDocumentCustomField::X | | +| `y` | ```Integer``` | _t__TemplateResponseDocumentCustomField::Y | | +| `width` | ```Integer``` | _t__TemplateResponseDocumentCustomField::WIDTH | | +| `height` | ```Integer``` | _t__TemplateResponseDocumentCustomField::HEIGHT | | +| `required` | ```Boolean``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```String``` | _t__TemplateResponseDocumentCustomField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldCheckbox.md index dbde79072..bcfc582dc 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentCustomFieldCheckbox -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentCustomField::TYPE | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md index ccaf19394..d2b739477 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md @@ -2,17 +2,17 @@ # TemplateResponseDocumentCustomFieldText -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentCustomField::TYPE | | | `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `isMultiline` | ```Boolean``` | _t__TemplateResponseDocumentCustomField::IS_MULTILINE | | +| `originalFontSize` | ```Integer``` | _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE | | +| `fontFamily` | ```String``` | _t__TemplateResponseDocumentCustomField::FONT_FAMILY | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md index 03b5ffbb8..89d747b56 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the form field group. | | +| `name` | ```String``` | _t__TemplateResponseDocumentFieldGroup::NAME | | | `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md index e0f4dcc8a..35b004a51 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFieldGroupRule -The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). +_t__TemplateResponseDocumentFieldGroup::RULE ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `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. | | -| `groupLabel` | ```String``` | Name of the group | | +| `requirement` | ```String``` | _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT | | +| `groupLabel` | ```String``` | _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md index 6ff896074..f60b27372 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md @@ -2,21 +2,21 @@ # TemplateResponseDocumentFormFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentFormField::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the form field. | | -| `name` | ```String``` | The name of the form field. | | -| `signer` | ```String``` | The signer of the Form Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```String``` | _t__TemplateResponseDocumentFormField::API_ID | | +| `name` | ```String``` | _t__TemplateResponseDocumentFormField::NAME | | +| `signer` | ```String``` | _t__TemplateResponseDocumentFormField::SIGNER | | +| `x` | ```Integer``` | _t__TemplateResponseDocumentFormField::X | | +| `y` | ```Integer``` | _t__TemplateResponseDocumentFormField::Y | | +| `width` | ```Integer``` | _t__TemplateResponseDocumentFormField::WIDTH | | +| `height` | ```Integer``` | _t__TemplateResponseDocumentFormField::HEIGHT | | +| `required` | ```Boolean``` | _t__TemplateResponseDocumentFormField::REQUIRED | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md index a7f2cadeb..9fb0dd73c 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldCheckbox -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md index 09b45eec7..b01fca7b3 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldDateSigned -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md index 70e5da455..a8f21ddce 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldDropdown -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md index e8efcf2d7..dab6cd795 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -2,18 +2,18 @@ # TemplateResponseDocumentFormFieldHyperlink -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | | `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `isMultiline` | ```Boolean``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `originalFontSize` | ```Integer``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `fontFamily` | ```String``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md index f1fe1f5b5..2fe0bed3a 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldInitials -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md index 877b842a2..0d829e2d1 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldRadio -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group`*_required_ | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md index 366aaa9b4..a147b1b1b 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldSignature -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md index 1b8d78c02..ec7ead57c 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md @@ -2,21 +2,21 @@ # TemplateResponseDocumentFormFieldText -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | | `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | -| `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | -| `validationCustomRegex` | ```String``` | When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. | | -| `validationCustomRegexFormatLabel` | ```String``` | When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `isMultiline` | ```Boolean``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `originalFontSize` | ```Integer``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `fontFamily` | ```String``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | _t__TemplateResponseDocumentFormField::VALIDATION_TYPE | | +| `validationCustomRegex` | ```String``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX | | +| `validationCustomRegexFormatLabel` | ```String``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md index 4be3cf070..997cd89df 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md @@ -2,22 +2,22 @@ # TemplateResponseDocumentStaticFieldBase -An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. +_t__TemplateResponseDocumentStaticField::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the static field. | | -| `name` | ```String``` | The name of the static field. | | -| `signer` | ```String``` | The signer of the Static Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width` | ```Integer``` | The width in pixels of this static field. | | -| `height` | ```Integer``` | The height in pixels of this static field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `apiId` | ```String``` | _t__TemplateResponseDocumentStaticField::API_ID | | +| `name` | ```String``` | _t__TemplateResponseDocumentStaticField::NAME | | +| `signer` | ```String``` | _t__TemplateResponseDocumentStaticField::SIGNER | | +| `x` | ```Integer``` | _t__TemplateResponseDocumentStaticField::X | | +| `y` | ```Integer``` | _t__TemplateResponseDocumentStaticField::Y | | +| `width` | ```Integer``` | _t__TemplateResponseDocumentStaticField::WIDTH | | +| `height` | ```Integer``` | _t__TemplateResponseDocumentStaticField::HEIGHT | | +| `required` | ```Boolean``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```String``` | _t__TemplateResponseDocumentStaticField::GROUP | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldCheckbox.md index 6cd94853c..f785f8900 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldCheckbox -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldDateSigned.md index d5c530d8b..5d9892ab9 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldDateSigned -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldDropdown.md index 53505315e..5ca87bec6 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldDropdown -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldHyperlink.md index 930658b69..96ff48da6 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldHyperlink -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldInitials.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldInitials.md index 67d755703..eef06958a 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldInitials -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldRadio.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldRadio.md index ed32ccca6..448311ded 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldRadio -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldSignature.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldSignature.md index 61f8902f8..4f236bb2e 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldSignature -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldText.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldText.md index 3dced017f..f8bf833e2 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldText.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldText -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md b/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md index bb66f3057..e635f1f80 100644 --- a/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md @@ -2,14 +2,14 @@ # TemplateResponseFieldAvgTextLength -Average text length in this field. +_t__TemplateResponseFieldAvgTextLength::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numLines` | ```Integer``` | Number of lines. | | -| `numCharsPerLine` | ```Integer``` | Number of characters per line. | | +| `numLines` | ```Integer``` | _t__TemplateResponseFieldAvgTextLength::NUM_LINES | | +| `numCharsPerLine` | ```Integer``` | _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE | | diff --git a/sdks/java-v1/docs/TemplateResponseSignerRole.md b/sdks/java-v1/docs/TemplateResponseSignerRole.md index 15b48cf17..0d4511692 100644 --- a/sdks/java-v1/docs/TemplateResponseSignerRole.md +++ b/sdks/java-v1/docs/TemplateResponseSignerRole.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | -| `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | +| `name` | ```String``` | _t__TemplateResponseSignerRole::NAME | | +| `order` | ```Integer``` | _t__TemplateResponseSignerRole::ORDER | | diff --git a/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md index 6289a9953..f0ce385d0 100644 --- a/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md @@ -2,14 +2,14 @@ # TemplateUpdateFilesResponseTemplate -Contains template id +_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `templateId` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md index aab362d77..94cce4729 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -14,8 +14,9 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -29,11 +30,11 @@ | `holdRequest` | ```Boolean``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | | | `isForEmbeddedSigning` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `requestingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully request a signature. | | | `showPreview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | -| `signers` | [```List```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```List```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `skipMeNow` | ```Boolean``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index 03ad8b9e5..151ff8c52 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -24,12 +24,12 @@ | `holdRequest` | ```Boolean``` | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | | | `isForEmbeddedSigning` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `previewOnly` | ```Boolean``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | | | `requestingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully request a signature. | | | `showPreview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | -| `signers` | [```List```](SubUnclaimedDraftTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers` | [```List```](SubUnclaimedDraftTemplateSigner.md) | _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `skipMeNow` | ```Boolean``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md b/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md index f23c6f4ba..9f1249ca4 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md @@ -12,7 +12,8 @@ | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -22,9 +23,9 @@ | `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hideTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | -| `signers` | [```List```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```List```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateResponse.md b/sdks/java-v1/docs/UnclaimedDraftCreateResponse.md index d2d3a7c4a..b27b2529d 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateResponse.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `unclaimedDraft`*_required_ | [```UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v1/docs/UnclaimedDraftResponse.md b/sdks/java-v1/docs/UnclaimedDraftResponse.md index ab470a27d..15d49b3c2 100644 --- a/sdks/java-v1/docs/UnclaimedDraftResponse.md +++ b/sdks/java-v1/docs/UnclaimedDraftResponse.md @@ -2,18 +2,18 @@ # UnclaimedDraftResponse -A group of documents that a user can take ownership of via the claim URL. +_t__UnclaimedDraftResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `signatureRequestId` | ```String``` | The ID of the signature request that is represented by this UnclaimedDraft. | | -| `claimUrl` | ```String``` | The URL to be used to claim this UnclaimedDraft. | | -| `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | -| `requestingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). | | -| `expiresAt` | ```Integer``` | When the link expires. | | -| `testMode` | ```Boolean``` | Whether this is a test draft. Signature requests made from test drafts have no legal value. | | +| `signatureRequestId` | ```String``` | _t__UnclaimedDraft::SIGNATURE_REQUEST_ID | | +| `claimUrl` | ```String``` | _t__UnclaimedDraft::CLAIM_URL | | +| `signingRedirectUrl` | ```String``` | _t__UnclaimedDraft::SIGNING_REDIRECT_URL | | +| `requestingRedirectUrl` | ```String``` | _t__UnclaimedDraft::REQUESTING_REDIRECT_URL | | +| `expiresAt` | ```Integer``` | _t__UnclaimedDraft::EXPIRES_AT | | +| `testMode` | ```Boolean``` | _t__UnclaimedDraft::TEST_MODE | | diff --git a/sdks/java-v1/docs/WarningResponse.md b/sdks/java-v1/docs/WarningResponse.md index 50cad9b58..88ab0c964 100644 --- a/sdks/java-v1/docs/WarningResponse.md +++ b/sdks/java-v1/docs/WarningResponse.md @@ -2,14 +2,14 @@ # WarningResponse -A list of warnings. +_t__WarningResponse::LIST_DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `warningMsg`*_required_ | ```String``` | Warning message | | -| `warningName`*_required_ | ```String``` | Warning name | | +| `warningMsg`*_required_ | ```String``` | _t__WarningResponse::WARNING_MSG | | +| `warningName`*_required_ | ```String``` | _t__WarningResponse::WARNING_NAME | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java index 328622b72..be1d8d06c 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java @@ -123,7 +123,7 @@ public AccountCreateResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountGetResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountGetResponse.java index c63b7c4b9..be7de3e0e 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountGetResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountGetResponse.java @@ -94,7 +94,7 @@ public AccountGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java index 02ee9cf83..454d19bb0 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponse.java @@ -97,7 +97,7 @@ public AccountResponse accountId(@javax.annotation.Nullable String accountId) { } /** - * The ID of the Account + * _t__Account::ACCOUNT_ID * * @return accountId */ @@ -119,7 +119,7 @@ public AccountResponse emailAddress(@javax.annotation.Nullable String emailAddre } /** - * The email address associated with the Account. + * _t__Account::EMAIL_ADDRESS * * @return emailAddress */ @@ -141,7 +141,7 @@ public AccountResponse isLocked(@javax.annotation.Nullable Boolean isLocked) { } /** - * Returns `true` if the user has been locked out of their account by a team admin. + * _t__Account::IS_LOCKED * * @return isLocked */ @@ -163,7 +163,7 @@ public AccountResponse isPaidHs(@javax.annotation.Nullable Boolean isPaidHs) { } /** - * Returns `true` if the user has a paid Dropbox Sign account. + * _t__Account::IS_PAID_HS * * @return isPaidHs */ @@ -185,7 +185,7 @@ public AccountResponse isPaidHf(@javax.annotation.Nullable Boolean isPaidHf) { } /** - * Returns `true` if the user has a paid HelloFax account. + * _t__Account::IS_PAID_HF * * @return isPaidHf */ @@ -229,7 +229,7 @@ public AccountResponse callbackUrl(@javax.annotation.Nullable String callbackUrl } /** - * The URL that Dropbox Sign events will `POST` to. + * _t__Account::CALLBACK_URL * * @return callbackUrl */ @@ -251,7 +251,7 @@ public AccountResponse roleCode(@javax.annotation.Nullable String roleCode) { } /** - * The membership role for the team. + * _t__Account::ROLE_CODE * * @return roleCode */ @@ -273,7 +273,7 @@ public AccountResponse teamId(@javax.annotation.Nullable String teamId) { } /** - * The id of the team account belongs to. + * _t__Account::TEAM_ID * * @return teamId */ @@ -295,9 +295,7 @@ public AccountResponse locale(@javax.annotation.Nullable String locale) { } /** - * 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. + * _t__Account::LOCALE * * @return locale */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java index 9385b863c..756bc2c49 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** Details concerning remaining monthly quotas. */ +/** _t__Account::QUOTA */ @JsonPropertyOrder({ AccountResponseQuotas.JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT, AccountResponseQuotas.JSON_PROPERTY_DOCUMENTS_LEFT, @@ -80,7 +80,7 @@ public AccountResponseQuotas apiSignatureRequestsLeft( } /** - * API signature requests remaining. + * _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT * * @return apiSignatureRequestsLeft */ @@ -103,7 +103,7 @@ public AccountResponseQuotas documentsLeft(@javax.annotation.Nullable Integer do } /** - * Signature requests remaining. + * _t__AccountQuota::DOCUMENTS_LEFT * * @return documentsLeft */ @@ -125,7 +125,7 @@ public AccountResponseQuotas templatesTotal(@javax.annotation.Nullable Integer t } /** - * Total API templates allowed. + * _t__AccountQuota::TEMPLATES_TOTAL * * @return templatesTotal */ @@ -147,7 +147,7 @@ public AccountResponseQuotas templatesLeft(@javax.annotation.Nullable Integer te } /** - * API templates remaining. + * _t__AccountQuota::TEMPLATES_LEFT * * @return templatesLeft */ @@ -170,7 +170,7 @@ public AccountResponseQuotas smsVerificationsLeft( } /** - * SMS verifications remaining. + * _t__AccountQuota::SMS_VERIFICATIONS_LEFT * * @return smsVerificationsLeft */ @@ -193,7 +193,7 @@ public AccountResponseQuotas numFaxPagesLeft( } /** - * Number of fax pages left + * _t__AccountQuota::NUM_FAX_PAGES_LEFT * * @return numFaxPagesLeft */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java index 7906498fe..a5f211c42 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** Details concerning monthly usage */ +/** _t__Account::USAGE */ @JsonPropertyOrder({AccountResponseUsage.JSON_PROPERTY_FAX_PAGES_SENT}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -55,7 +55,7 @@ public AccountResponseUsage faxPagesSent(@javax.annotation.Nullable Integer faxP } /** - * Number of fax pages sent + * _t__AccountUsage::FAX_PAGES_SENT * * @return faxPagesSent */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java index d5b7c64bb..2f55330e2 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java @@ -96,7 +96,7 @@ public AccountVerifyResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java index e8002ca39..735007037 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java @@ -58,7 +58,7 @@ public AccountVerifyResponseAccount emailAddress( } /** - * The email address associated with the Account. + * _t__Account::EMAIL_ADDRESS * * @return emailAddress */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java index 54ce2c4bb..844b1f8ac 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java @@ -94,7 +94,7 @@ public ApiAppGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java index 8a50aef37..ff2e101ac 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java @@ -75,7 +75,7 @@ public ApiAppListResponse addApiAppsItem(ApiAppResponse apiAppsItem) { } /** - * Contains information about API Apps. + * _t__ApiAppListResponse::DESCRIPTION * * @return apiApps */ @@ -129,7 +129,7 @@ public ApiAppListResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java index 913a1e2c3..b1eb17bd5 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponse.java @@ -25,7 +25,7 @@ import java.util.Map; import java.util.Objects; -/** Contains information about an API App. */ +/** _t__ApiAppResponse::DESCRIPTION */ @JsonPropertyOrder({ ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, ApiAppResponse.JSON_PROPERTY_CLIENT_ID, @@ -95,7 +95,7 @@ public ApiAppResponse callbackUrl(@javax.annotation.Nullable String callbackUrl) } /** - * The app's callback URL (for events) + * _t__ApiAppResponse::CALLBACK_URL * * @return callbackUrl */ @@ -117,7 +117,7 @@ public ApiAppResponse clientId(@javax.annotation.Nullable String clientId) { } /** - * The app's client id + * _t__ApiAppResponse::CLIENT_ID * * @return clientId */ @@ -139,7 +139,7 @@ public ApiAppResponse createdAt(@javax.annotation.Nullable Integer createdAt) { } /** - * The time that the app was created + * _t__ApiAppResponse::CREATED_AT * * @return createdAt */ @@ -169,7 +169,7 @@ public ApiAppResponse addDomainsItem(String domainsItem) { } /** - * The domain name(s) associated with the app + * _t__ApiAppResponse::DOMAINS * * @return domains */ @@ -191,7 +191,7 @@ public ApiAppResponse name(@javax.annotation.Nullable String name) { } /** - * The name of the app + * _t__ApiAppResponse::NAME * * @return name */ @@ -213,7 +213,7 @@ public ApiAppResponse isApproved(@javax.annotation.Nullable Boolean isApproved) } /** - * Boolean to indicate if the app has been approved + * _t__ApiAppResponse::IS_APPROVED * * @return isApproved */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java index daf3f0826..73cb62983 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java @@ -25,10 +25,7 @@ import java.util.Map; import java.util.Objects; -/** - * An object describing the app's OAuth properties, or null if OAuth is not configured for the - * app. - */ +/** _t__ApiAppResponseOAuth::DESCRIPTION */ @JsonPropertyOrder({ ApiAppResponseOAuth.JSON_PROPERTY_CALLBACK_URL, ApiAppResponseOAuth.JSON_PROPERTY_SECRET, @@ -74,7 +71,7 @@ public ApiAppResponseOAuth callbackUrl(@javax.annotation.Nullable String callbac } /** - * The app's OAuth callback URL. + * _t__ApiAppResponseOAuth::CALLBACK_URL * * @return callbackUrl */ @@ -96,7 +93,7 @@ public ApiAppResponseOAuth secret(@javax.annotation.Nullable String secret) { } /** - * The app's OAuth secret, or null if the app does not belong to user. + * _t__ApiAppResponseOAuth::SECRET * * @return secret */ @@ -126,7 +123,7 @@ public ApiAppResponseOAuth addScopesItem(String scopesItem) { } /** - * Array of OAuth scopes used by the app. + * _t__ApiAppResponseOAuth::SCOPES * * @return scopes */ @@ -148,8 +145,7 @@ public ApiAppResponseOAuth chargesUsers(@javax.annotation.Nullable Boolean charg } /** - * Boolean indicating whether the app owner or the account granting permission is billed for - * OAuth requests. + * _t__ApiAppResponseOAuth::CHARGES_USERS * * @return chargesUsers */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java index ace145fa9..2d733056e 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** An object with options that override account settings. */ +/** _t__ApiAppResponseOptions::DESCRIPTION */ @JsonPropertyOrder({ApiAppResponseOptions.JSON_PROPERTY_CAN_INSERT_EVERYWHERE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -57,8 +57,7 @@ public ApiAppResponseOptions canInsertEverywhere( } /** - * Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a - * document + * _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE * * @return canInsertEverywhere */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java index de840b202..685e2dcfc 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** An object describing the app's owner */ +/** _t__ApiAppResponseOwnerAccount::DESCRIPTION */ @JsonPropertyOrder({ ApiAppResponseOwnerAccount.JSON_PROPERTY_ACCOUNT_ID, ApiAppResponseOwnerAccount.JSON_PROPERTY_EMAIL_ADDRESS @@ -63,7 +63,7 @@ public ApiAppResponseOwnerAccount accountId(@javax.annotation.Nullable String ac } /** - * The owner account's ID + * _t__ApiAppResponseOwnerAccount::ACCOUNT_ID * * @return accountId */ @@ -85,7 +85,7 @@ public ApiAppResponseOwnerAccount emailAddress(@javax.annotation.Nullable String } /** - * The owner account's email address + * _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS * * @return emailAddress */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java index ae9441e24..95064b7e1 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** An object with options to customize the app's signer page */ +/** _t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION */ @JsonPropertyOrder({ ApiAppResponseWhiteLabelingOptions.JSON_PROPERTY_HEADER_BACKGROUND_COLOR, ApiAppResponseWhiteLabelingOptions.JSON_PROPERTY_LEGAL_VERSION, diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java index 80ade2f0d..4d01eaf58 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java @@ -132,7 +132,7 @@ public BulkSendJobGetResponse addSignatureRequestsItem( } /** - * Contains information about the Signature Requests sent in bulk. + * _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS * * @return signatureRequests */ @@ -166,7 +166,7 @@ public BulkSendJobGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java index dc04b97e4..1004c93b8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java @@ -160,8 +160,7 @@ public BulkSendJobGetResponseSignatureRequests testMode( } /** - * Whether this is a test signature request. Test requests have no legal value. Defaults to - * `false`. + * _t__SignatureRequestResponse::TEST_MODE * * @return testMode */ @@ -184,7 +183,7 @@ public BulkSendJobGetResponseSignatureRequests signatureRequestId( } /** - * The id of the SignatureRequest. + * _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID * * @return signatureRequestId */ @@ -207,7 +206,7 @@ public BulkSendJobGetResponseSignatureRequests requesterEmailAddress( } /** - * The email address of the initiator of the SignatureRequest. + * _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS * * @return requesterEmailAddress */ @@ -229,7 +228,7 @@ public BulkSendJobGetResponseSignatureRequests title(@javax.annotation.Nullable } /** - * The title the specified Account uses for the SignatureRequest. + * _t__SignatureRequestResponse::TITLE * * @return title */ @@ -252,7 +251,7 @@ public BulkSendJobGetResponseSignatureRequests originalTitle( } /** - * Default Label for account. + * _t__SignatureRequestResponse::ORIGINAL_TITLE * * @return originalTitle */ @@ -275,7 +274,7 @@ public BulkSendJobGetResponseSignatureRequests subject( } /** - * The subject in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::SUBJECT * * @return subject */ @@ -298,7 +297,7 @@ public BulkSendJobGetResponseSignatureRequests message( } /** - * The custom message in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::MESSAGE * * @return message */ @@ -330,7 +329,7 @@ public BulkSendJobGetResponseSignatureRequests putMetadataItem( } /** - * The metadata attached to the signature request. + * _t__SignatureRequestResponse::METADATA * * @return metadata */ @@ -353,7 +352,7 @@ public BulkSendJobGetResponseSignatureRequests createdAt( } /** - * Time the signature request was created. + * _t__SignatureRequestResponse::CREATED_AT * * @return createdAt */ @@ -376,9 +375,7 @@ public BulkSendJobGetResponseSignatureRequests expiresAt( } /** - * The time when the signature request will expire unsigned signatures. See [Signature Request - * Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for - * details. + * _t__SignatureRequestResponse::EXPIRES_AT * * @return expiresAt */ @@ -401,7 +398,7 @@ public BulkSendJobGetResponseSignatureRequests isComplete( } /** - * Whether or not the SignatureRequest has been fully executed by all signers. + * _t__SignatureRequestResponse::IS_COMPLETE * * @return isComplete */ @@ -424,7 +421,7 @@ public BulkSendJobGetResponseSignatureRequests isDeclined( } /** - * Whether or not the SignatureRequest has been declined by a signer. + * _t__SignatureRequestResponse::IS_DECLINED * * @return isDeclined */ @@ -447,8 +444,7 @@ public BulkSendJobGetResponseSignatureRequests hasError( } /** - * Whether or not an error occurred (either during the creation of the SignatureRequest or - * during one of the signings). + * _t__SignatureRequestResponse::HAS_ERROR * * @return hasError */ @@ -471,7 +467,7 @@ public BulkSendJobGetResponseSignatureRequests filesUrl( } /** - * The URL where a copy of the request's documents can be downloaded. + * _t__SignatureRequestResponse::FILES_URL * * @return filesUrl */ @@ -494,9 +490,7 @@ public BulkSendJobGetResponseSignatureRequests signingUrl( } /** - * The URL where a signer, after authenticating, can sign the documents. This should only be - * used by users with existing Dropbox Sign accounts as they will be required to log in before - * signing. + * _t__SignatureRequestResponse::SIGNING_URL * * @return signingUrl */ @@ -519,8 +513,7 @@ public BulkSendJobGetResponseSignatureRequests detailsUrl( } /** - * The URL where the requester and the signers can view the current status of the - * SignatureRequest. + * _t__SignatureRequestResponse::DETAILS_URL * * @return detailsUrl */ @@ -552,8 +545,7 @@ public BulkSendJobGetResponseSignatureRequests addCcEmailAddressesItem( } /** - * A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of - * the final PDF once all the signers have signed. + * _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES * * @return ccEmailAddresses */ @@ -576,7 +568,7 @@ public BulkSendJobGetResponseSignatureRequests signingRedirectUrl( } /** - * The URL you want the signer redirected to after they successfully sign. + * _t__SignatureRequestResponse::SIGNING_REDIRECT_URL * * @return signingRedirectUrl */ @@ -599,7 +591,7 @@ public BulkSendJobGetResponseSignatureRequests finalCopyUri( } /** - * The path where the completed document can be downloaded + * _t__SignatureRequestResponse::FINAL_COPY_URI * * @return finalCopyUri */ @@ -630,7 +622,7 @@ public BulkSendJobGetResponseSignatureRequests addTemplateIdsItem(String templat } /** - * Templates IDs used in this SignatureRequest (if any). + * _t__SignatureRequestResponse::TEMPLATE_IDS * * @return templateIds */ @@ -662,9 +654,7 @@ public BulkSendJobGetResponseSignatureRequests addCustomFieldsItem( } /** - * An array of Custom Field objects containing the name and type of each custom field. * Text - * Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses - * `SignatureRequestResponseCustomFieldCheckbox` + * _t__SignatureRequestResponseCustomField::DESCRIPTION * * @return customFields */ @@ -697,7 +687,7 @@ public BulkSendJobGetResponseSignatureRequests addAttachmentsItem( } /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION * * @return attachments */ @@ -730,8 +720,7 @@ public BulkSendJobGetResponseSignatureRequests addResponseDataItem( } /** - * An array of form field objects containing the name, value, and type of each textbox or - * checkmark field filled in by the signers. + * _t__SignatureRequestResponseData::DESCRIPTION * * @return responseData */ @@ -764,7 +753,7 @@ public BulkSendJobGetResponseSignatureRequests addSignaturesItem( } /** - * An array of signature objects, 1 for each signer. + * _t__SignatureRequestResponseSignatures::DESCRIPTION * * @return signatures */ @@ -788,7 +777,7 @@ public BulkSendJobGetResponseSignatureRequests bulkSendJobId( } /** - * The id of the BulkSendJob. + * _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID * * @return bulkSendJobId */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java index a47d9a259..c540eca14 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java @@ -77,7 +77,7 @@ public BulkSendJobListResponse addBulkSendJobsItem(BulkSendJobResponse bulkSendJ } /** - * Contains a list of BulkSendJobs that the API caller has access to. + * _t__BulkSendJobListResponse::BULK_SEND_JOBS * * @return bulkSendJobs */ @@ -132,7 +132,7 @@ public BulkSendJobListResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java index 442e2b628..7927c50e5 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java @@ -23,10 +23,7 @@ import java.util.Map; import java.util.Objects; -/** - * Contains information about the BulkSendJob such as when it was created and how many signature - * requests are queued. - */ +/** _t__BulkSendJobResponse::DESCRIPTION */ @JsonPropertyOrder({ BulkSendJobResponse.JSON_PROPERTY_BULK_SEND_JOB_ID, BulkSendJobResponse.JSON_PROPERTY_TOTAL, @@ -72,7 +69,7 @@ public BulkSendJobResponse bulkSendJobId(@javax.annotation.Nullable String bulkS } /** - * The id of the BulkSendJob. + * _t__BulkSendJobResponse::BULK_SEND_JOB_ID * * @return bulkSendJobId */ @@ -94,7 +91,7 @@ public BulkSendJobResponse total(@javax.annotation.Nullable Integer total) { } /** - * The total amount of Signature Requests queued for sending. + * _t__BulkSendJobResponse::TOTAL * * @return total */ @@ -116,8 +113,7 @@ public BulkSendJobResponse isCreator(@javax.annotation.Nullable Boolean isCreato } /** - * True if you are the owner of this BulkSendJob, false if it's been shared with you by a - * team member. + * _t__BulkSendJobResponse::IS_CREATOR * * @return isCreator */ @@ -139,7 +135,7 @@ public BulkSendJobResponse createdAt(@javax.annotation.Nullable Integer createdA } /** - * Time that the BulkSendJob was created. + * _t__BulkSendJobResponse::CREATED_AT * * @return createdAt */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java index b59c28092..edb86eb32 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java @@ -97,7 +97,7 @@ public BulkSendJobSendResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java index e46d30980..a1628c72d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java @@ -28,6 +28,7 @@ /** EmbeddedEditUrlRequest */ @JsonPropertyOrder({ EmbeddedEditUrlRequest.JSON_PROPERTY_ALLOW_EDIT_CCS, + EmbeddedEditUrlRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, EmbeddedEditUrlRequest.JSON_PROPERTY_CC_ROLES, EmbeddedEditUrlRequest.JSON_PROPERTY_EDITOR_OPTIONS, EmbeddedEditUrlRequest.JSON_PROPERTY_FORCE_SIGNER_ROLES, @@ -46,6 +47,9 @@ public class EmbeddedEditUrlRequest { public static final String JSON_PROPERTY_ALLOW_EDIT_CCS = "allow_edit_ccs"; @javax.annotation.Nullable private Boolean allowEditCcs = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @javax.annotation.Nullable private Boolean allowFormView = false; + public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; @javax.annotation.Nullable private List ccRoles = null; @@ -113,6 +117,29 @@ public void setAllowEditCcs(@javax.annotation.Nullable Boolean allowEditCcs) { this.allowEditCcs = allowEditCcs; } + public EmbeddedEditUrlRequest allowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to + * `false`. + * + * @return allowFormView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowFormView() { + return allowFormView; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + public EmbeddedEditUrlRequest ccRoles(@javax.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; return this; @@ -350,6 +377,7 @@ public boolean equals(Object o) { } EmbeddedEditUrlRequest embeddedEditUrlRequest = (EmbeddedEditUrlRequest) o; return Objects.equals(this.allowEditCcs, embeddedEditUrlRequest.allowEditCcs) + && Objects.equals(this.allowFormView, embeddedEditUrlRequest.allowFormView) && Objects.equals(this.ccRoles, embeddedEditUrlRequest.ccRoles) && Objects.equals(this.editorOptions, embeddedEditUrlRequest.editorOptions) && Objects.equals(this.forceSignerRoles, embeddedEditUrlRequest.forceSignerRoles) @@ -367,6 +395,7 @@ public boolean equals(Object o) { public int hashCode() { return Objects.hash( allowEditCcs, + allowFormView, ccRoles, editorOptions, forceSignerRoles, @@ -383,6 +412,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class EmbeddedEditUrlRequest {\n"); sb.append(" allowEditCcs: ").append(toIndentedString(allowEditCcs)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" editorOptions: ").append(toIndentedString(editorOptions)).append("\n"); sb.append(" forceSignerRoles: ").append(toIndentedString(forceSignerRoles)).append("\n"); @@ -424,6 +454,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowEditCcs)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) + || allowFormView.getClass().equals(Integer.class) + || allowFormView.getClass().equals(String.class) + || allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for (int i = 0; i < getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } else { + map.put( + "allow_form_view", + JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (ccRoles != null) { if (isFileTypeOrListOfFiles(ccRoles)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java index 30bd517e5..c458db1a7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java @@ -97,7 +97,7 @@ public EmbeddedEditUrlResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java index 92ea6cbe0..33943a7ab 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** An embedded template object. */ +/** _t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION */ @JsonPropertyOrder({ EmbeddedEditUrlResponseEmbedded.JSON_PROPERTY_EDIT_URL, EmbeddedEditUrlResponseEmbedded.JSON_PROPERTY_EXPIRES_AT @@ -63,7 +63,7 @@ public EmbeddedEditUrlResponseEmbedded editUrl(@javax.annotation.Nullable String } /** - * A template url that can be opened in an iFrame. + * _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL * * @return editUrl */ @@ -85,7 +85,7 @@ public EmbeddedEditUrlResponseEmbedded expiresAt(@javax.annotation.Nullable Inte } /** - * The specific time that the the `edit_url` link expires, in epoch. + * _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT * * @return expiresAt */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java index a49ec4993..02d97c02d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java @@ -97,7 +97,7 @@ public EmbeddedSignUrlResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java index cb4820ae6..fdc8d93ec 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** An object that contains necessary information to set up embedded signing. */ +/** _t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION */ @JsonPropertyOrder({ EmbeddedSignUrlResponseEmbedded.JSON_PROPERTY_SIGN_URL, EmbeddedSignUrlResponseEmbedded.JSON_PROPERTY_EXPIRES_AT @@ -63,7 +63,7 @@ public EmbeddedSignUrlResponseEmbedded signUrl(@javax.annotation.Nullable String } /** - * A signature url that can be opened in an iFrame. + * _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL * * @return signUrl */ @@ -85,7 +85,7 @@ public EmbeddedSignUrlResponseEmbedded expiresAt(@javax.annotation.Nullable Inte } /** - * The specific time that the the `sign_url` link expires, in epoch. + * _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT * * @return expiresAt */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ErrorResponseError.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ErrorResponseError.java index e9624c65f..716264dd0 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ErrorResponseError.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ErrorResponseError.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** Contains information about an error that occurred. */ +/** _t__ErrorResponseError::DESCRIPTION */ @JsonPropertyOrder({ ErrorResponseError.JSON_PROPERTY_ERROR_MSG, ErrorResponseError.JSON_PROPERTY_ERROR_NAME, @@ -65,7 +65,7 @@ public ErrorResponseError errorMsg(@javax.annotation.Nonnull String errorMsg) { } /** - * Message describing an error. + * _t__ErrorResponseError::ERROR_MSG * * @return errorMsg */ @@ -88,7 +88,7 @@ public ErrorResponseError errorName(@javax.annotation.Nonnull String errorName) } /** - * Name of the error. + * _t__ErrorResponseError::ERROR_NAME * * @return errorName */ @@ -111,7 +111,7 @@ public ErrorResponseError errorPath(@javax.annotation.Nullable String errorPath) } /** - * Path at which an error occurred. + * _t__ErrorResponseError::ERROR_PATH * * @return errorPath */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java index a3e999816..5055d43b9 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java @@ -25,7 +25,7 @@ import java.util.Map; import java.util.Objects; -/** Basic information about the event that occurred. */ +/** _t__EventCallbackRequestEvent::DESCRIPTION */ @JsonPropertyOrder({ EventCallbackRequestEvent.JSON_PROPERTY_EVENT_TIME, EventCallbackRequestEvent.JSON_PROPERTY_EVENT_TYPE, @@ -40,7 +40,7 @@ public class EventCallbackRequestEvent { public static final String JSON_PROPERTY_EVENT_TIME = "event_time"; @javax.annotation.Nonnull private String eventTime; - /** Type of callback event that was triggered. */ + /** _t__EventCallbackRequestEvent::EVENT_TYPE */ public enum EventTypeEnum { ACCOUNT_CONFIRMED(String.valueOf("account_confirmed")), @@ -148,7 +148,7 @@ public EventCallbackRequestEvent eventTime(@javax.annotation.Nonnull String even } /** - * Time the event was created (using Unix time). + * _t__EventCallbackRequestEvent::EVENT_TIME * * @return eventTime */ @@ -171,7 +171,7 @@ public EventCallbackRequestEvent eventType(@javax.annotation.Nonnull EventTypeEn } /** - * Type of callback event that was triggered. + * _t__EventCallbackRequestEvent::EVENT_TYPE * * @return eventType */ @@ -194,7 +194,7 @@ public EventCallbackRequestEvent eventHash(@javax.annotation.Nonnull String even } /** - * Generated hash used to verify source of event data. + * _t__EventCallbackRequestEvent::EVENT_HASH * * @return eventHash */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java index 453c6a291..df0444895 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** Specific metadata about the event. */ +/** _t__EventCallbackRequestEventMetadata::DESCRIPTION */ @JsonPropertyOrder({ EventCallbackRequestEventMetadata.JSON_PROPERTY_RELATED_SIGNATURE_ID, EventCallbackRequestEventMetadata.JSON_PROPERTY_REPORTED_FOR_ACCOUNT_ID, @@ -72,8 +72,7 @@ public EventCallbackRequestEventMetadata relatedSignatureId( } /** - * Signature ID for a specific signer. Applicable to `signature_request_signed` and - * `signature_request_viewed` events. + * _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID * * @return relatedSignatureId */ @@ -96,7 +95,7 @@ public EventCallbackRequestEventMetadata reportedForAccountId( } /** - * Account ID the event was reported for. + * _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID * * @return reportedForAccountId */ @@ -119,7 +118,7 @@ public EventCallbackRequestEventMetadata reportedForAppId( } /** - * App ID the event was reported for. + * _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID * * @return reportedForAppId */ @@ -142,7 +141,7 @@ public EventCallbackRequestEventMetadata eventMessage( } /** - * Message about a declined or failed (due to error) signature flow. + * _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE * * @return eventMessage */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxGetResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxGetResponse.java index 8d018468f..3c68c3abd 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxGetResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxGetResponse.java @@ -91,7 +91,7 @@ public FaxGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FileResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FileResponse.java index c03740895..14008321a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FileResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FileResponse.java @@ -58,7 +58,7 @@ public FileResponse fileUrl(@javax.annotation.Nonnull String fileUrl) { } /** - * URL to the file. + * _t__FileResponse::FILE_URL * * @return fileUrl */ @@ -81,7 +81,7 @@ public FileResponse expiresAt(@javax.annotation.Nonnull Integer expiresAt) { } /** - * When the link expires. + * _t__FileResponse::EXPIRES_AT * * @return expiresAt */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java index 2a27822eb..ce347def0 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java @@ -55,7 +55,7 @@ public FileResponseDataUri dataUri(@javax.annotation.Nonnull String dataUri) { } /** - * File as base64 encoded string. + * _t__FileResponse::DATA_URI * * @return dataUri */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ListInfoResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ListInfoResponse.java index 3ed8ddfe5..ff44a1d00 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ListInfoResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ListInfoResponse.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** Contains pagination information about the data returned. */ +/** _t__ListInfoResponse::DESCRIPTION */ @JsonPropertyOrder({ ListInfoResponse.JSON_PROPERTY_NUM_PAGES, ListInfoResponse.JSON_PROPERTY_NUM_RESULTS, @@ -69,7 +69,7 @@ public ListInfoResponse numPages(@javax.annotation.Nullable Integer numPages) { } /** - * Total number of pages available. + * _t__ListInfoResponse::NUM_PAGES * * @return numPages */ @@ -91,7 +91,7 @@ public ListInfoResponse numResults(@javax.annotation.Nullable Integer numResults } /** - * Total number of objects available. + * _t__ListInfoResponse::NUM_RESULTS * * @return numResults */ @@ -113,7 +113,7 @@ public ListInfoResponse page(@javax.annotation.Nullable Integer page) { } /** - * Number of the page being returned. + * _t__ListInfoResponse::PAGE * * @return page */ @@ -135,7 +135,7 @@ public ListInfoResponse pageSize(@javax.annotation.Nullable Integer pageSize) { } /** - * Objects returned per page. + * _t__ListInfoResponse::PAGE_SIZE * * @return pageSize */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java index 278d62579..9c25345ff 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java @@ -139,7 +139,7 @@ public OAuthTokenResponse expiresIn(@javax.annotation.Nullable Integer expiresIn } /** - * Number of seconds until the `access_token` expires. Uses epoch time. + * _t__OAuthTokenResponse::EXPIRES_IN * * @return expiresIn */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java index c5c3fd88f..38e625dc3 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java @@ -45,7 +45,9 @@ public class ReportCreateRequest { public enum ReportTypeEnum { USER_ACTIVITY(String.valueOf("user_activity")), - DOCUMENT_STATUS(String.valueOf("document_status")); + DOCUMENT_STATUS(String.valueOf("document_status")), + + SMS_ACTIVITY(String.valueOf("sms_activity")); private String value; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java index 70af485a1..cd4d6b2e8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java @@ -95,7 +95,7 @@ public ReportCreateResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportResponse.java index 29d5b88cf..4604386c5 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/ReportResponse.java @@ -27,7 +27,7 @@ import java.util.Map; import java.util.Objects; -/** Contains information about the report request. */ +/** _t__ReportResponse::DESCRIPTION */ @JsonPropertyOrder({ ReportResponse.JSON_PROPERTY_SUCCESS, ReportResponse.JSON_PROPERTY_START_DATE, @@ -52,7 +52,9 @@ public class ReportResponse { public enum ReportTypeEnum { USER_ACTIVITY(String.valueOf("user_activity")), - DOCUMENT_STATUS(String.valueOf("document_status")); + DOCUMENT_STATUS(String.valueOf("document_status")), + + SMS_ACTIVITY(String.valueOf("sms_activity")); private String value; @@ -106,7 +108,7 @@ public ReportResponse success(@javax.annotation.Nullable String success) { } /** - * A message indicating the requested operation's success + * _t__ReportResponse::SUCCESS * * @return success */ @@ -128,7 +130,7 @@ public ReportResponse startDate(@javax.annotation.Nullable String startDate) { } /** - * The (inclusive) start date for the report data in MM/DD/YYYY format. + * _t__ReportResponse::START_DATE * * @return startDate */ @@ -150,7 +152,7 @@ public ReportResponse endDate(@javax.annotation.Nullable String endDate) { } /** - * The (inclusive) end date for the report data in MM/DD/YYYY format. + * _t__ReportResponse::END_DATE * * @return endDate */ @@ -180,10 +182,7 @@ public ReportResponse addReportTypeItem(ReportTypeEnum reportTypeItem) { } /** - * 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). + * _t__ReportResponse::REPORT_TYPE * * @return reportType */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java index fda33d504..991952227 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java @@ -375,11 +375,7 @@ public SignatureRequestBulkCreateEmbeddedWithTemplateRequest putMetadataItem( } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java index 67ab53ea1..0cac122cd 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java @@ -372,11 +372,7 @@ public SignatureRequestBulkSendWithTemplateRequest putMetadataItem( } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java index 8e1987c37..37fbb3256 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java @@ -34,6 +34,7 @@ SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_SIGNERS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -77,6 +78,9 @@ public class SignatureRequestCreateEmbeddedRequest { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @javax.annotation.Nullable private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; @@ -256,8 +260,7 @@ public SignatureRequestCreateEmbeddedRequest addSignersItem( } /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or - * **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION * * @return signers */ @@ -289,8 +292,7 @@ public SignatureRequestCreateEmbeddedRequest addGroupedSignersItem( } /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or - * **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * * @return groupedSigners */ @@ -331,6 +333,30 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } + public SignatureRequestCreateEmbeddedRequest allowFormView( + @javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to + * `false`. + * + * @return allowFormView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowFormView() { + return allowFormView; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + public SignatureRequestCreateEmbeddedRequest allowReassign( @javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; @@ -370,7 +396,7 @@ public SignatureRequestCreateEmbeddedRequest addAttachmentsItem(SubAttachment at } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * * @return attachments */ @@ -665,11 +691,7 @@ public SignatureRequestCreateEmbeddedRequest putMetadataItem(String key, Object } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ @@ -874,6 +896,8 @@ public boolean equals(Object o) { this.groupedSigners, signatureRequestCreateEmbeddedRequest.groupedSigners) && Objects.equals( this.allowDecline, signatureRequestCreateEmbeddedRequest.allowDecline) + && Objects.equals( + this.allowFormView, signatureRequestCreateEmbeddedRequest.allowFormView) && Objects.equals( this.allowReassign, signatureRequestCreateEmbeddedRequest.allowReassign) && Objects.equals( @@ -918,6 +942,7 @@ public int hashCode() { signers, groupedSigners, allowDecline, + allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -948,6 +973,7 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1094,6 +1120,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) + || allowFormView.getClass().equals(Integer.class) + || allowFormView.getClass().equals(String.class) + || allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for (int i = 0; i < getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } else { + map.put( + "allow_form_view", + JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java index a6b8c00ec..caed64c59 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java @@ -193,7 +193,7 @@ public SignatureRequestCreateEmbeddedWithTemplateRequest addSignersItem( } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * * @return signers */ @@ -402,11 +402,7 @@ public SignatureRequestCreateEmbeddedWithTemplateRequest putMetadataItem( } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java index 752946426..7991cbc5b 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java @@ -34,6 +34,7 @@ SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNERS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -77,6 +78,9 @@ public class SignatureRequestEditEmbeddedRequest { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @javax.annotation.Nullable private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; @@ -254,8 +258,7 @@ public SignatureRequestEditEmbeddedRequest addSignersItem( } /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or - * **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION * * @return signers */ @@ -287,8 +290,7 @@ public SignatureRequestEditEmbeddedRequest addGroupedSignersItem( } /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or - * **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * * @return groupedSigners */ @@ -329,6 +331,30 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } + public SignatureRequestEditEmbeddedRequest allowFormView( + @javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to + * `false`. + * + * @return allowFormView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowFormView() { + return allowFormView; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + public SignatureRequestEditEmbeddedRequest allowReassign( @javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; @@ -368,7 +394,7 @@ public SignatureRequestEditEmbeddedRequest addAttachmentsItem(SubAttachment atta } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * * @return attachments */ @@ -662,11 +688,7 @@ public SignatureRequestEditEmbeddedRequest putMetadataItem(String key, Object me } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ @@ -870,6 +892,8 @@ public boolean equals(Object o) { this.groupedSigners, signatureRequestEditEmbeddedRequest.groupedSigners) && Objects.equals( this.allowDecline, signatureRequestEditEmbeddedRequest.allowDecline) + && Objects.equals( + this.allowFormView, signatureRequestEditEmbeddedRequest.allowFormView) && Objects.equals( this.allowReassign, signatureRequestEditEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestEditEmbeddedRequest.attachments) @@ -911,6 +935,7 @@ public int hashCode() { signers, groupedSigners, allowDecline, + allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -941,6 +966,7 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1087,6 +1113,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) + || allowFormView.getClass().equals(Integer.class) + || allowFormView.getClass().equals(String.class) + || allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for (int i = 0; i < getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } else { + map.put( + "allow_form_view", + JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java index 6cd3dbed4..612351fa5 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java @@ -193,7 +193,7 @@ public SignatureRequestEditEmbeddedWithTemplateRequest addSignersItem( } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * * @return signers */ @@ -402,11 +402,7 @@ public SignatureRequestEditEmbeddedWithTemplateRequest putMetadataItem( } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java index 0173d32e5..104d3183c 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java @@ -33,6 +33,7 @@ SignatureRequestEditRequest.JSON_PROPERTY_SIGNERS, SignatureRequestEditRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestEditRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestEditRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -75,6 +76,9 @@ public class SignatureRequestEditRequest { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @javax.annotation.Nullable private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; @@ -231,8 +235,7 @@ public SignatureRequestEditRequest addSignersItem(SubSignatureRequestSigner sign } /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or - * **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION * * @return signers */ @@ -264,8 +267,7 @@ public SignatureRequestEditRequest addGroupedSignersItem( } /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or - * **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * * @return groupedSigners */ @@ -306,6 +308,30 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } + public SignatureRequestEditRequest allowFormView( + @javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to + * `false`. + * + * @return allowFormView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowFormView() { + return allowFormView; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + public SignatureRequestEditRequest allowReassign( @javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; @@ -346,7 +372,7 @@ public SignatureRequestEditRequest addAttachmentsItem(SubAttachment attachmentsI } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * * @return attachments */ @@ -686,11 +712,7 @@ public SignatureRequestEditRequest putMetadataItem(String key, Object metadataIt } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ @@ -882,6 +904,7 @@ public boolean equals(Object o) { && Objects.equals(this.signers, signatureRequestEditRequest.signers) && Objects.equals(this.groupedSigners, signatureRequestEditRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestEditRequest.allowDecline) + && Objects.equals(this.allowFormView, signatureRequestEditRequest.allowFormView) && Objects.equals(this.allowReassign, signatureRequestEditRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestEditRequest.attachments) && Objects.equals( @@ -916,6 +939,7 @@ public int hashCode() { signers, groupedSigners, allowDecline, + allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -947,6 +971,7 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1075,6 +1100,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) + || allowFormView.getClass().equals(Integer.class) + || allowFormView.getClass().equals(String.class) + || allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for (int i = 0; i < getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } else { + map.put( + "allow_form_view", + JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java index c49c66ff3..d2533c1f3 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java @@ -168,7 +168,7 @@ public SignatureRequestEditWithTemplateRequest addSignersItem( } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * * @return signers */ @@ -426,11 +426,7 @@ public SignatureRequestEditWithTemplateRequest putMetadataItem( } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java index 713db0586..0b671d5a5 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java @@ -99,7 +99,7 @@ public SignatureRequestGetResponse addWarningsItem(WarningResponse warningsItem) } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java index 2829c0ded..73ab12c01 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java @@ -81,7 +81,7 @@ public SignatureRequestListResponse addSignatureRequestsItem( } /** - * Contains information about signature requests. + * _t__SignatureRequestListResponse::DESCRIPTION * * @return signatureRequests */ @@ -138,7 +138,7 @@ public SignatureRequestListResponse addWarningsItem(WarningResponse warningsItem } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java index 85da7fb61..cf9c168ec 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java @@ -25,7 +25,7 @@ import java.util.Map; import java.util.Objects; -/** Contains information about a signature request. */ +/** _t__SignatureRequestResponse::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponse.JSON_PROPERTY_TEST_MODE, SignatureRequestResponse.JSON_PROPERTY_SIGNATURE_REQUEST_ID, @@ -158,8 +158,7 @@ public SignatureRequestResponse testMode(@javax.annotation.Nullable Boolean test } /** - * Whether this is a test signature request. Test requests have no legal value. Defaults to - * `false`. + * _t__SignatureRequestResponse::TEST_MODE * * @return testMode */ @@ -182,7 +181,7 @@ public SignatureRequestResponse signatureRequestId( } /** - * The id of the SignatureRequest. + * _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID * * @return signatureRequestId */ @@ -205,7 +204,7 @@ public SignatureRequestResponse requesterEmailAddress( } /** - * The email address of the initiator of the SignatureRequest. + * _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS * * @return requesterEmailAddress */ @@ -227,7 +226,7 @@ public SignatureRequestResponse title(@javax.annotation.Nullable String title) { } /** - * The title the specified Account uses for the SignatureRequest. + * _t__SignatureRequestResponse::TITLE * * @return title */ @@ -249,7 +248,7 @@ public SignatureRequestResponse originalTitle(@javax.annotation.Nullable String } /** - * Default Label for account. + * _t__SignatureRequestResponse::ORIGINAL_TITLE * * @return originalTitle */ @@ -271,7 +270,7 @@ public SignatureRequestResponse subject(@javax.annotation.Nullable String subjec } /** - * The subject in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::SUBJECT * * @return subject */ @@ -293,7 +292,7 @@ public SignatureRequestResponse message(@javax.annotation.Nullable String messag } /** - * The custom message in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::MESSAGE * * @return message */ @@ -324,7 +323,7 @@ public SignatureRequestResponse putMetadataItem(String key, Object metadataItem) } /** - * The metadata attached to the signature request. + * _t__SignatureRequestResponse::METADATA * * @return metadata */ @@ -346,7 +345,7 @@ public SignatureRequestResponse createdAt(@javax.annotation.Nullable Integer cre } /** - * Time the signature request was created. + * _t__SignatureRequestResponse::CREATED_AT * * @return createdAt */ @@ -368,9 +367,7 @@ public SignatureRequestResponse expiresAt(@javax.annotation.Nullable Integer exp } /** - * The time when the signature request will expire unsigned signatures. See [Signature Request - * Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for - * details. + * _t__SignatureRequestResponse::EXPIRES_AT * * @return expiresAt */ @@ -392,7 +389,7 @@ public SignatureRequestResponse isComplete(@javax.annotation.Nullable Boolean is } /** - * Whether or not the SignatureRequest has been fully executed by all signers. + * _t__SignatureRequestResponse::IS_COMPLETE * * @return isComplete */ @@ -414,7 +411,7 @@ public SignatureRequestResponse isDeclined(@javax.annotation.Nullable Boolean is } /** - * Whether or not the SignatureRequest has been declined by a signer. + * _t__SignatureRequestResponse::IS_DECLINED * * @return isDeclined */ @@ -436,8 +433,7 @@ public SignatureRequestResponse hasError(@javax.annotation.Nullable Boolean hasE } /** - * Whether or not an error occurred (either during the creation of the SignatureRequest or - * during one of the signings). + * _t__SignatureRequestResponse::HAS_ERROR * * @return hasError */ @@ -459,7 +455,7 @@ public SignatureRequestResponse filesUrl(@javax.annotation.Nullable String files } /** - * The URL where a copy of the request's documents can be downloaded. + * _t__SignatureRequestResponse::FILES_URL * * @return filesUrl */ @@ -481,9 +477,7 @@ public SignatureRequestResponse signingUrl(@javax.annotation.Nullable String sig } /** - * The URL where a signer, after authenticating, can sign the documents. This should only be - * used by users with existing Dropbox Sign accounts as they will be required to log in before - * signing. + * _t__SignatureRequestResponse::SIGNING_URL * * @return signingUrl */ @@ -505,8 +499,7 @@ public SignatureRequestResponse detailsUrl(@javax.annotation.Nullable String det } /** - * The URL where the requester and the signers can view the current status of the - * SignatureRequest. + * _t__SignatureRequestResponse::DETAILS_URL * * @return detailsUrl */ @@ -537,8 +530,7 @@ public SignatureRequestResponse addCcEmailAddressesItem(String ccEmailAddressesI } /** - * A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of - * the final PDF once all the signers have signed. + * _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES * * @return ccEmailAddresses */ @@ -561,7 +553,7 @@ public SignatureRequestResponse signingRedirectUrl( } /** - * The URL you want the signer redirected to after they successfully sign. + * _t__SignatureRequestResponse::SIGNING_REDIRECT_URL * * @return signingRedirectUrl */ @@ -583,7 +575,7 @@ public SignatureRequestResponse finalCopyUri(@javax.annotation.Nullable String f } /** - * The path where the completed document can be downloaded + * _t__SignatureRequestResponse::FINAL_COPY_URI * * @return finalCopyUri */ @@ -614,7 +606,7 @@ public SignatureRequestResponse addTemplateIdsItem(String templateIdsItem) { } /** - * Templates IDs used in this SignatureRequest (if any). + * _t__SignatureRequestResponse::TEMPLATE_IDS * * @return templateIds */ @@ -646,9 +638,7 @@ public SignatureRequestResponse addCustomFieldsItem( } /** - * An array of Custom Field objects containing the name and type of each custom field. * Text - * Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses - * `SignatureRequestResponseCustomFieldCheckbox` + * _t__SignatureRequestResponseCustomField::DESCRIPTION * * @return customFields */ @@ -681,7 +671,7 @@ public SignatureRequestResponse addAttachmentsItem( } /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION * * @return attachments */ @@ -714,8 +704,7 @@ public SignatureRequestResponse addResponseDataItem( } /** - * An array of form field objects containing the name, value, and type of each textbox or - * checkmark field filled in by the signers. + * _t__SignatureRequestResponseData::DESCRIPTION * * @return responseData */ @@ -748,7 +737,7 @@ public SignatureRequestResponse addSignaturesItem( } /** - * An array of signature objects, 1 for each signer. + * _t__SignatureRequestResponseSignatures::DESCRIPTION * * @return signatures */ @@ -771,7 +760,7 @@ public SignatureRequestResponse bulkSendJobId(@javax.annotation.Nullable String } /** - * The ID of the Bulk Send job which sent the signature request, if applicable. + * _t__SignatureRequestResponse::BULK_SEND_JOB_ID * * @return bulkSendJobId */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java index 8c0486a26..2c724844a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** Signer attachments. */ +/** _t__SignatureRequestResponseAttachment::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponseAttachment.JSON_PROPERTY_ID, SignatureRequestResponseAttachment.JSON_PROPERTY_SIGNER, @@ -79,7 +79,7 @@ public SignatureRequestResponseAttachment id(@javax.annotation.Nonnull String id } /** - * The unique ID for this attachment. + * _t__SignatureRequestResponseAttachment::ID * * @return id */ @@ -107,7 +107,7 @@ public SignatureRequestResponseAttachment signer(Integer signer) { } /** - * The Signer this attachment is assigned to. + * _t__SignatureRequestResponseAttachment::SIGNER * * @return signer */ @@ -134,7 +134,7 @@ public SignatureRequestResponseAttachment name(@javax.annotation.Nonnull String } /** - * The name of this attachment. + * _t__SignatureRequestResponseAttachment::NAME * * @return name */ @@ -157,7 +157,7 @@ public SignatureRequestResponseAttachment required(@javax.annotation.Nonnull Boo } /** - * A boolean value denoting if this attachment is required. + * _t__SignatureRequestResponseAttachment::REQUIRED * * @return required */ @@ -181,7 +181,7 @@ public SignatureRequestResponseAttachment instructions( } /** - * Instructions for Signer. + * _t__SignatureRequestResponseAttachment::INSTRUCTIONS * * @return instructions */ @@ -204,7 +204,7 @@ public SignatureRequestResponseAttachment uploadedAt( } /** - * Timestamp when attachment was uploaded by Signer. + * _t__SignatureRequestResponseAttachment::UPLOADED_AT * * @return uploadedAt */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java index 4eb96aa4d..29f5453d6 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java @@ -25,11 +25,7 @@ import java.util.Map; import java.util.Objects; -/** - * An array of Custom Field objects containing the name and type of each custom field. * Text Field - * uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses - * `SignatureRequestResponseCustomFieldCheckbox` - */ +/** _t__SignatureRequestResponseCustomField::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponseCustomFieldBase.JSON_PROPERTY_TYPE, SignatureRequestResponseCustomFieldBase.JSON_PROPERTY_NAME, @@ -95,8 +91,7 @@ public SignatureRequestResponseCustomFieldBase type(@javax.annotation.Nonnull St } /** - * The type of this Custom Field. Only 'text' and 'checkbox' are currently - * supported. + * _t__SignatureRequestResponseCustomField::TYPE * * @return type */ @@ -119,7 +114,7 @@ public SignatureRequestResponseCustomFieldBase name(@javax.annotation.Nonnull St } /** - * The name of the Custom Field. + * _t__SignatureRequestResponseCustomField::NAME * * @return name */ @@ -143,7 +138,7 @@ public SignatureRequestResponseCustomFieldBase required( } /** - * A boolean value denoting if this field is required. + * _t__SignatureRequestResponseCustomField::REQUIRED * * @return required */ @@ -165,7 +160,7 @@ public SignatureRequestResponseCustomFieldBase apiId(@javax.annotation.Nullable } /** - * The unique ID for this field. + * _t__SignatureRequestResponseCustomField::API_ID * * @return apiId */ @@ -188,7 +183,7 @@ public SignatureRequestResponseCustomFieldBase editor( } /** - * The name of the Role that is able to edit this field. + * _t__SignatureRequestResponseCustomField::EDITOR * * @return editor */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java index 8e0952e3d..37f8c4d41 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `SignatureRequestResponseCustomFieldBase`. */ +/** _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ SignatureRequestResponseCustomFieldCheckbox.JSON_PROPERTY_TYPE, SignatureRequestResponseCustomFieldCheckbox.JSON_PROPERTY_VALUE @@ -74,8 +74,7 @@ public SignatureRequestResponseCustomFieldCheckbox type(@javax.annotation.Nonnul } /** - * The type of this Custom Field. Only 'text' and 'checkbox' are currently - * supported. + * _t__SignatureRequestResponseCustomField::TYPE * * @return type */ @@ -99,7 +98,7 @@ public SignatureRequestResponseCustomFieldCheckbox value( } /** - * A true/false for checkbox fields + * _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX * * @return value */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java index bb882571a..a645c5429 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `SignatureRequestResponseCustomFieldBase`. */ +/** _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ SignatureRequestResponseCustomFieldText.JSON_PROPERTY_TYPE, SignatureRequestResponseCustomFieldText.JSON_PROPERTY_VALUE @@ -73,8 +73,7 @@ public SignatureRequestResponseCustomFieldText type(@javax.annotation.Nonnull St } /** - * The type of this Custom Field. Only 'text' and 'checkbox' are currently - * supported. + * _t__SignatureRequestResponseCustomField::TYPE * * @return type */ @@ -97,7 +96,7 @@ public SignatureRequestResponseCustomFieldText value(@javax.annotation.Nullable } /** - * A text string for text fields + * _t__SignatureRequestResponseCustomField::VALUE_TEXT * * @return value */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java index e50d2024f..154ddea01 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java @@ -25,10 +25,7 @@ import java.util.Map; import java.util.Objects; -/** - * An array of form field objects containing the name, value, and type of each textbox or checkmark - * field filled in by the signers. - */ +/** _t__SignatureRequestResponseData::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponseDataBase.JSON_PROPERTY_API_ID, SignatureRequestResponseDataBase.JSON_PROPERTY_SIGNATURE_ID, @@ -106,7 +103,7 @@ public SignatureRequestResponseDataBase apiId(@javax.annotation.Nullable String } /** - * The unique ID for this field. + * _t__SignatureRequestResponseData::API_ID * * @return apiId */ @@ -129,7 +126,7 @@ public SignatureRequestResponseDataBase signatureId( } /** - * The ID of the signature to which this response is linked. + * _t__SignatureRequestResponseData::SIGNATURE_ID * * @return signatureId */ @@ -151,7 +148,7 @@ public SignatureRequestResponseDataBase name(@javax.annotation.Nullable String n } /** - * The name of the form field. + * _t__SignatureRequestResponseData::NAME * * @return name */ @@ -173,7 +170,7 @@ public SignatureRequestResponseDataBase required(@javax.annotation.Nullable Bool } /** - * A boolean value denoting if this field is required. + * _t__SignatureRequestResponseData::REQUIRED * * @return required */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java index aa196e173..35576ac61 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java @@ -72,7 +72,7 @@ public SignatureRequestResponseDataValueCheckbox type(@javax.annotation.Nullable } /** - * A yes/no checkbox + * _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE * * @return type */ @@ -95,7 +95,7 @@ public SignatureRequestResponseDataValueCheckbox value( } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * * @return value */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java index 99139c870..1c638c156 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java @@ -76,7 +76,7 @@ public SignatureRequestResponseDataValueCheckboxMerge type( } /** - * A checkbox field that has default value set by the api + * _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE * * @return type */ @@ -99,7 +99,7 @@ public SignatureRequestResponseDataValueCheckboxMerge value( } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * * @return value */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java index 038a3cc60..d74a174c6 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java @@ -74,7 +74,7 @@ public SignatureRequestResponseDataValueDateSigned type( } /** - * A date + * _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE * * @return type */ @@ -97,7 +97,7 @@ public SignatureRequestResponseDataValueDateSigned value( } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * * @return value */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java index e702df116..3222aadf1 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java @@ -72,7 +72,7 @@ public SignatureRequestResponseDataValueDropdown type(@javax.annotation.Nullable } /** - * An input field for dropdowns + * _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE * * @return type */ @@ -95,7 +95,7 @@ public SignatureRequestResponseDataValueDropdown value( } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * * @return value */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java index bd936ff8d..e1ca18b6b 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java @@ -76,7 +76,7 @@ public SignatureRequestResponseDataValueInitials type(@javax.annotation.Nullable } /** - * An input field for initials + * _t__SignatureRequestResponseDataValue::INITIAL_TYPE * * @return type */ @@ -99,7 +99,7 @@ public SignatureRequestResponseDataValueInitials value( } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * * @return value */ @@ -122,7 +122,7 @@ public SignatureRequestResponseDataValueInitials isSigned( } /** - * This field contains the boolean true if the field is signed. + * _t__SignatureRequestResponseDataValue::IS_SIGNED * * @return isSigned */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java index 58eb6518c..1b99bf0c8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java @@ -71,7 +71,7 @@ public SignatureRequestResponseDataValueRadio type(@javax.annotation.Nullable St } /** - * An input field for radios + * _t__SignatureRequestResponseDataValue::RADIO_TYPE * * @return type */ @@ -93,7 +93,7 @@ public SignatureRequestResponseDataValueRadio value(@javax.annotation.Nullable B } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * * @return value */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java index e08d208d0..863da1903 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java @@ -77,7 +77,7 @@ public SignatureRequestResponseDataValueSignature type(@javax.annotation.Nullabl } /** - * A signature input field + * _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE * * @return type */ @@ -100,7 +100,7 @@ public SignatureRequestResponseDataValueSignature value( } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * * @return value */ @@ -123,7 +123,7 @@ public SignatureRequestResponseDataValueSignature isSigned( } /** - * This field contains the boolean true if the field is signed. + * _t__SignatureRequestResponseDataValue::IS_SIGNED * * @return isSigned */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java index ea517a79b..1bd998d26 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java @@ -71,7 +71,7 @@ public SignatureRequestResponseDataValueText type(@javax.annotation.Nullable Str } /** - * A text input field + * _t__SignatureRequestResponseDataValue::TEXT_TYPE * * @return type */ @@ -93,7 +93,7 @@ public SignatureRequestResponseDataValueText value(@javax.annotation.Nullable St } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * * @return value */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java index 0c3deed89..c7cb35701 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java @@ -73,7 +73,7 @@ public SignatureRequestResponseDataValueTextMerge type(@javax.annotation.Nullabl } /** - * A text field that has default text set by the api + * _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE * * @return type */ @@ -96,7 +96,7 @@ public SignatureRequestResponseDataValueTextMerge value( } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * * @return value */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java index ede6ebb32..00c609bb0 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** An array of signature objects, 1 for each signer. */ +/** _t__SignatureRequestResponseSignatures::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponseSignatures.JSON_PROPERTY_SIGNATURE_ID, SignatureRequestResponseSignatures.JSON_PROPERTY_SIGNER_GROUP_GUID, @@ -132,7 +132,7 @@ public SignatureRequestResponseSignatures signatureId( } /** - * Signature identifier. + * _t__SignatureRequestResponseSignatures::SIGNATURE_ID * * @return signatureId */ @@ -155,7 +155,7 @@ public SignatureRequestResponseSignatures signerGroupGuid( } /** - * Signer Group GUID + * _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID * * @return signerGroupGuid */ @@ -178,7 +178,7 @@ public SignatureRequestResponseSignatures signerEmailAddress( } /** - * The email address of the signer. + * _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS * * @return signerEmailAddress */ @@ -201,7 +201,7 @@ public SignatureRequestResponseSignatures signerName( } /** - * The name of the signer. + * _t__SignatureRequestResponseSignatures::SIGNER_NAME * * @return signerName */ @@ -224,7 +224,7 @@ public SignatureRequestResponseSignatures signerRole( } /** - * The role of the signer. + * _t__SignatureRequestResponseSignatures::SIGNER_ROLE * * @return signerRole */ @@ -246,7 +246,7 @@ public SignatureRequestResponseSignatures order(@javax.annotation.Nullable Integ } /** - * If signer order is assigned this is the 0-based index for this signer. + * _t__SignatureRequestResponseSignatures::ORDER * * @return order */ @@ -269,7 +269,7 @@ public SignatureRequestResponseSignatures statusCode( } /** - * The current status of the signature. eg: awaiting_signature, signed, declined. + * _t__SignatureRequestResponseSignatures::STATUS_CODE * * @return statusCode */ @@ -292,7 +292,7 @@ public SignatureRequestResponseSignatures declineReason( } /** - * The reason provided by the signer for declining the request. + * _t__SignatureRequestResponseSignatures::DECLINE_REASON * * @return declineReason */ @@ -315,7 +315,7 @@ public SignatureRequestResponseSignatures signedAt( } /** - * Time that the document was signed or null. + * _t__SignatureRequestResponseSignatures::SIGNED_AT * * @return signedAt */ @@ -338,7 +338,7 @@ public SignatureRequestResponseSignatures lastViewedAt( } /** - * The time that the document was last viewed by this signer or null. + * _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT * * @return lastViewedAt */ @@ -361,7 +361,7 @@ public SignatureRequestResponseSignatures lastRemindedAt( } /** - * The time the last reminder email was sent to the signer or null. + * _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT * * @return lastRemindedAt */ @@ -383,7 +383,7 @@ public SignatureRequestResponseSignatures hasPin(@javax.annotation.Nullable Bool } /** - * Boolean to indicate whether this signature requires a PIN to access. + * _t__SignatureRequestResponseSignatures::HAS_PIN * * @return hasPin */ @@ -406,7 +406,7 @@ public SignatureRequestResponseSignatures hasSmsAuth( } /** - * Boolean to indicate whether this signature has SMS authentication enabled. + * _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH * * @return hasSmsAuth */ @@ -429,7 +429,7 @@ public SignatureRequestResponseSignatures hasSmsDelivery( } /** - * Boolean to indicate whether this signature has SMS delivery enabled. + * _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY * * @return hasSmsDelivery */ @@ -452,7 +452,7 @@ public SignatureRequestResponseSignatures smsPhoneNumber( } /** - * The SMS phone number used for authentication or signature request delivery. + * _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER * * @return smsPhoneNumber */ @@ -475,7 +475,7 @@ public SignatureRequestResponseSignatures reassignedBy( } /** - * Email address of original signer who reassigned to this signer. + * _t__SignatureRequestResponseSignatures::REASSIGNED_BY * * @return reassignedBy */ @@ -498,7 +498,7 @@ public SignatureRequestResponseSignatures reassignmentReason( } /** - * Reason provided by original signer who reassigned to this signer. + * _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON * * @return reassignmentReason */ @@ -521,7 +521,7 @@ public SignatureRequestResponseSignatures reassignedFrom( } /** - * Previous signature identifier. + * _t__SignatureRequestResponseSignatures::REASSIGNED_FROM * * @return reassignedFrom */ @@ -543,7 +543,7 @@ public SignatureRequestResponseSignatures error(@javax.annotation.Nullable Strin } /** - * Error message pertaining to this signer, or null. + * _t__SignatureRequestResponseSignatures::ERROR * * @return error */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index 252b39102..aeec32796 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java @@ -34,6 +34,7 @@ SignatureRequestSendRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_DECLINE, SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_REASSIGN, + SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestSendRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestSendRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, SignatureRequestSendRequest.JSON_PROPERTY_CLIENT_ID, @@ -79,6 +80,9 @@ public class SignatureRequestSendRequest { public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @javax.annotation.Nullable private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @javax.annotation.Nullable private List attachments = null; @@ -235,8 +239,7 @@ public SignatureRequestSendRequest addSignersItem(SubSignatureRequestSigner sign } /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or - * **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION * * @return signers */ @@ -268,8 +271,7 @@ public SignatureRequestSendRequest addGroupedSignersItem( } /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or - * **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * * @return groupedSigners */ @@ -335,6 +337,30 @@ public void setAllowReassign(@javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } + public SignatureRequestSendRequest allowFormView( + @javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to + * `false`. + * + * @return allowFormView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowFormView() { + return allowFormView; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + public SignatureRequestSendRequest attachments( @javax.annotation.Nullable List attachments) { this.attachments = attachments; @@ -350,7 +376,7 @@ public SignatureRequestSendRequest addAttachmentsItem(SubAttachment attachmentsI } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * * @return attachments */ @@ -721,11 +747,7 @@ public SignatureRequestSendRequest putMetadataItem(String key, Object metadataIt } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ @@ -918,6 +940,7 @@ public boolean equals(Object o) { && Objects.equals(this.groupedSigners, signatureRequestSendRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestSendRequest.allowDecline) && Objects.equals(this.allowReassign, signatureRequestSendRequest.allowReassign) + && Objects.equals(this.allowFormView, signatureRequestSendRequest.allowFormView) && Objects.equals(this.attachments, signatureRequestSendRequest.attachments) && Objects.equals( this.ccEmailAddresses, signatureRequestSendRequest.ccEmailAddresses) @@ -954,6 +977,7 @@ public int hashCode() { groupedSigners, allowDecline, allowReassign, + allowFormView, attachments, ccEmailAddresses, clientId, @@ -986,6 +1010,7 @@ public String toString() { sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -1136,6 +1161,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) + || allowFormView.getClass().equals(Integer.class) + || allowFormView.getClass().equals(String.class) + || allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for (int i = 0; i < getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } else { + map.put( + "allow_form_view", + JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java index eba4b1488..3048141eb 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java @@ -172,7 +172,7 @@ public SignatureRequestSendWithTemplateRequest addSignersItem( } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * * @return signers */ @@ -461,11 +461,7 @@ public SignatureRequestSendWithTemplateRequest putMetadataItem( } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java index 34bfc8529..977c81789 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java @@ -290,7 +290,7 @@ public SubFormFieldsPerDocumentBase width(@javax.annotation.Nonnull Integer widt } /** - * Size of the field in pixels. + * _t__Sub::FormFieldsPerDocument::WIDTH * * @return width */ @@ -313,7 +313,7 @@ public SubFormFieldsPerDocumentBase x(@javax.annotation.Nonnull Integer x) { } /** - * Location coordinates of the field in pixels. + * _t__Sub::FormFieldsPerDocument::X * * @return x */ @@ -336,7 +336,7 @@ public SubFormFieldsPerDocumentBase y(@javax.annotation.Nonnull Integer y) { } /** - * Location coordinates of the field in pixels. + * _t__Sub::FormFieldsPerDocument::Y * * @return y */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java index 00d47ecb5..1e197ae19 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java @@ -67,14 +67,7 @@ public class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_MASKED = "masked"; @javax.annotation.Nullable private Boolean masked; - /** - * Each text field may contain a `validation_type` parameter. Check out the list of - * [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about - * the possible values. **NOTE:** When using `custom_regex` you are required to pass a - * second parameter `validation_custom_regex` and you can optionally provide - * `validation_custom_regex_format_label` for the error message the user will see in - * case of an invalid value. - */ + /** _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE */ public enum ValidationTypeEnum { NUMBERS_ONLY(String.valueOf("numbers_only")), @@ -344,12 +337,7 @@ public SubFormFieldsPerDocumentText validationType( } /** - * Each text field may contain a `validation_type` parameter. Check out the list of - * [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about - * the possible values. **NOTE:** When using `custom_regex` you are required to pass a - * second parameter `validation_custom_regex` and you can optionally provide - * `validation_custom_regex_format_label` for the error message the user will see in - * case of an invalid value. + * _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE * * @return validationType */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java index d4bf984d5..32f93f39b 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java @@ -138,8 +138,7 @@ public SubFormFieldsPerDocumentTextMerge type(@javax.annotation.Nonnull String t } /** - * A text field that has default text set using pre-filled data. Use the - * `SubFormFieldsPerDocumentTextMerge` class. + * _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubMergeField.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubMergeField.java index d4f7fba9f..e0bd6b77a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubMergeField.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubMergeField.java @@ -35,7 +35,7 @@ public class SubMergeField { public static final String JSON_PROPERTY_NAME = "name"; @javax.annotation.Nonnull private String name; - /** The type of merge field. */ + /** _t__Sub::MergeField::TYPE */ public enum TypeEnum { TEXT(String.valueOf("text")), @@ -93,7 +93,7 @@ public SubMergeField name(@javax.annotation.Nonnull String name) { } /** - * The name of the merge field. Must be unique. + * _t__Sub::MergeField::NAME * * @return name */ @@ -116,7 +116,7 @@ public SubMergeField type(@javax.annotation.Nonnull TypeEnum type) { } /** - * The type of merge field. + * _t__Sub::MergeField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubOAuth.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubOAuth.java index 1d7220b38..c02ab87a1 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubOAuth.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubOAuth.java @@ -27,7 +27,7 @@ import java.util.Map; import java.util.Objects; -/** OAuth related parameters. */ +/** _t__Sub::OAuth::DESCRIPTION */ @JsonPropertyOrder({SubOAuth.JSON_PROPERTY_CALLBACK_URL, SubOAuth.JSON_PROPERTY_SCOPES}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -107,8 +107,7 @@ public SubOAuth callbackUrl(@javax.annotation.Nullable String callbackUrl) { } /** - * The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is - * provided) + * _t__Sub::OAuth::CALLBACK_URL * * @return callbackUrl */ @@ -138,8 +137,7 @@ public SubOAuth addScopesItem(ScopesEnum scopesItem) { } /** - * A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if - * `oauth[callback_url]` is provided). + * _t__Sub::OAuth::SCOPES * * @return scopes */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubOptions.java index dca71d2ef..264603988 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubOptions.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** Additional options supported by API App. */ +/** _t__Sub::Options::DESCRIPTION */ @JsonPropertyOrder({SubOptions.JSON_PROPERTY_CAN_INSERT_EVERYWHERE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -55,7 +55,7 @@ public SubOptions canInsertEverywhere(@javax.annotation.Nullable Boolean canInse } /** - * Determines if signers can use \"Insert Everywhere\" when signing a document. + * _t__Sub::Options::CAN_INSERT_EVERYWHERE * * @return canInsertEverywhere */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java index b67ccb989..11654bb0b 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java @@ -69,7 +69,7 @@ public SubSignatureRequestGroupedSigners group(@javax.annotation.Nonnull String } /** - * The name of the group. + * _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME * * @return group */ @@ -101,9 +101,7 @@ public SubSignatureRequestGroupedSigners addSignersItem(SubSignatureRequestSigne } /** - * 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. + * _t__Sub::SignatureRequestGroupedSigners::SIGNERS * * @return signers */ @@ -126,8 +124,7 @@ public SubSignatureRequestGroupedSigners order(@javax.annotation.Nullable Intege } /** - * The order the group is required to sign in. Use this instead of Signer-level - * `order`. + * _t__Sub::SignatureRequestGroupedSigners::ORDER * * @return order */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java index 6bfe0c6eb..be8a029fa 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java @@ -54,12 +54,7 @@ public class SubSignatureRequestSigner { public static final String JSON_PROPERTY_SMS_PHONE_NUMBER = "sms_phone_number"; @javax.annotation.Nullable private String smsPhoneNumber; - /** - * Specifies the feature used with the `sms_phone_number`. Default - * `authentication`. If `authentication`, signer is sent a verification code - * via SMS that is required to access the document. If `delivery`, a link to complete - * the signature request is delivered via SMS (_and_ email). - */ + /** _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE */ public enum SmsPhoneNumberTypeEnum { AUTHENTICATION(String.valueOf("authentication")), @@ -119,7 +114,7 @@ public SubSignatureRequestSigner name(@javax.annotation.Nonnull String name) { } /** - * The name of the signer. + * _t__Sub::SignatureRequestSigner::SIGNER_NAME * * @return name */ @@ -142,7 +137,7 @@ public SubSignatureRequestSigner emailAddress(@javax.annotation.Nonnull String e } /** - * The email address of the signer. + * _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS * * @return emailAddress */ @@ -165,7 +160,7 @@ public SubSignatureRequestSigner order(@javax.annotation.Nullable Integer order) } /** - * The order the signer is required to sign in. + * _t__Sub::SignatureRequestSigner::SIGNER_ORDER * * @return order */ @@ -187,7 +182,7 @@ public SubSignatureRequestSigner pin(@javax.annotation.Nullable String pin) { } /** - * The 4- to 12-character access code that will secure this signer's signature page. + * _t__Sub::SignatureRequestSigner::SIGNER_PIN * * @return pin */ @@ -210,12 +205,7 @@ public SubSignatureRequestSigner smsPhoneNumber( } /** - * An E.164 formatted phone number. By using the feature, you agree you are responsible for - * obtaining a signer's consent to receive text messages from Dropbox Sign related to this - * signature request and confirm you have obtained such consent from all signers prior to - * enabling SMS delivery for this signature request. [Learn - * more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - * **NOTE:** Not available in test mode and requires a Standard plan or higher. + * _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER * * @return smsPhoneNumber */ @@ -238,10 +228,7 @@ public SubSignatureRequestSigner smsPhoneNumberType( } /** - * Specifies the feature used with the `sms_phone_number`. Default - * `authentication`. If `authentication`, signer is sent a verification code - * via SMS that is required to access the document. If `delivery`, a link to complete - * the signature request is delivered via SMS (_and_ email). + * _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE * * @return smsPhoneNumberType */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java index a43dfa702..5952d961c 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java @@ -54,12 +54,7 @@ public class SubSignatureRequestTemplateSigner { public static final String JSON_PROPERTY_SMS_PHONE_NUMBER = "sms_phone_number"; @javax.annotation.Nullable private String smsPhoneNumber; - /** - * Specifies the feature used with the `sms_phone_number`. Default - * `authentication`. If `authentication`, signer is sent a verification code - * via SMS that is required to access the document. If `delivery`, a link to complete - * the signature request is delivered via SMS (_and_ email). - */ + /** _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE */ public enum SmsPhoneNumberTypeEnum { AUTHENTICATION(String.valueOf("authentication")), @@ -119,7 +114,7 @@ public SubSignatureRequestTemplateSigner role(@javax.annotation.Nonnull String r } /** - * Must match an existing role in chosen Template(s). It's case-sensitive. + * _t__Sub::SignatureRequestTemplateSigner::ROLE * * @return role */ @@ -142,7 +137,7 @@ public SubSignatureRequestTemplateSigner name(@javax.annotation.Nonnull String n } /** - * The name of the signer. + * _t__Sub::SignatureRequestTemplateSigner::NAME * * @return name */ @@ -166,7 +161,7 @@ public SubSignatureRequestTemplateSigner emailAddress( } /** - * The email address of the signer. + * _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS * * @return emailAddress */ @@ -189,7 +184,7 @@ public SubSignatureRequestTemplateSigner pin(@javax.annotation.Nullable String p } /** - * The 4- to 12-character access code that will secure this signer's signature page. + * _t__Sub::SignatureRequestTemplateSigner::PIN * * @return pin */ @@ -212,12 +207,7 @@ public SubSignatureRequestTemplateSigner smsPhoneNumber( } /** - * An E.164 formatted phone number. By using the feature, you agree you are responsible for - * obtaining a signer's consent to receive text messages from Dropbox Sign related to this - * signature request and confirm you have obtained such consent from all signers prior to - * enabling SMS delivery for this signature request. [Learn - * more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - * **NOTE:** Not available in test mode and requires a Standard plan or higher. + * _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER * * @return smsPhoneNumber */ @@ -240,10 +230,7 @@ public SubSignatureRequestTemplateSigner smsPhoneNumberType( } /** - * Specifies the feature used with the `sms_phone_number`. Default - * `authentication`. If `authentication`, signer is sent a verification code - * via SMS that is required to access the document. If `delivery`, a link to complete - * the signature request is delivered via SMS (_and_ email). + * _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE * * @return smsPhoneNumberType */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSigningOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSigningOptions.java index 0dea6a670..189cfb209 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSigningOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSigningOptions.java @@ -25,11 +25,7 @@ import java.util.Map; import java.util.Objects; -/** - * This allows the requester to specify the types allowed for creating a signature. **NOTE:** If - * `signing_options` are not defined in the request, the allowed types will default to - * those specified in the account settings. - */ +/** _t__Sub::SigningOptions::DESCRIPTION */ @JsonPropertyOrder({ SubSigningOptions.JSON_PROPERTY_DEFAULT_TYPE, SubSigningOptions.JSON_PROPERTY_DRAW, @@ -42,7 +38,7 @@ comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown = true) public class SubSigningOptions { - /** The default type shown (limited to the listed types) */ + /** _t__Sub::SigningOptions::DEFAULT */ public enum DefaultTypeEnum { DRAW(String.valueOf("draw")), @@ -116,7 +112,7 @@ public SubSigningOptions defaultType(@javax.annotation.Nonnull DefaultTypeEnum d } /** - * The default type shown (limited to the listed types) + * _t__Sub::SigningOptions::DEFAULT * * @return defaultType */ @@ -139,7 +135,7 @@ public SubSigningOptions draw(@javax.annotation.Nullable Boolean draw) { } /** - * Allows drawing the signature + * _t__Sub::SigningOptions::DRAW * * @return draw */ @@ -161,7 +157,7 @@ public SubSigningOptions phone(@javax.annotation.Nullable Boolean phone) { } /** - * Allows using a smartphone to email the signature + * _t__Sub::SigningOptions::PHONE * * @return phone */ @@ -183,7 +179,7 @@ public SubSigningOptions type(@javax.annotation.Nullable Boolean type) { } /** - * Allows typing the signature + * _t__Sub::SigningOptions::TYPE * * @return type */ @@ -205,7 +201,7 @@ public SubSigningOptions upload(@javax.annotation.Nullable Boolean upload) { } /** - * Allows uploading the signature + * _t__Sub::SigningOptions::UPLOAD * * @return upload */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubTeamResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubTeamResponse.java index 34ff420c4..f93e830cf 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubTeamResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubTeamResponse.java @@ -58,7 +58,7 @@ public SubTeamResponse teamId(@javax.annotation.Nullable String teamId) { } /** - * The id of a team + * _t__TeamGeneral::TEAM_ID * * @return teamId */ @@ -80,7 +80,7 @@ public SubTeamResponse name(@javax.annotation.Nullable String name) { } /** - * The name of a team + * _t__TeamGeneral::NAME * * @return name */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubTemplateRole.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubTemplateRole.java index d1d482e85..4bceac53b 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubTemplateRole.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubTemplateRole.java @@ -58,8 +58,7 @@ public SubTemplateRole name(@javax.annotation.Nullable String name) { } /** - * The role name of the signer that will be displayed when the template is used to create a - * signature request. + * _t__Sub::SignerRole::NAME * * @return name */ @@ -81,7 +80,7 @@ public SubTemplateRole order(@javax.annotation.Nullable Integer order) { } /** - * The order in which this signer role is required to sign. + * _t__Sub::SignerRole::ORDER * * @return order */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java index e7761bd14..d4ff4f205 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java @@ -66,7 +66,7 @@ public SubUnclaimedDraftSigner emailAddress(@javax.annotation.Nonnull String ema } /** - * The email address of the signer. + * _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS * * @return emailAddress */ @@ -89,7 +89,7 @@ public SubUnclaimedDraftSigner name(@javax.annotation.Nonnull String name) { } /** - * The name of the signer. + * _t__Sub::UnclaimedDraftSigner::NAME * * @return name */ @@ -112,7 +112,7 @@ public SubUnclaimedDraftSigner order(@javax.annotation.Nullable Integer order) { } /** - * The order the signer is required to sign in. + * _t__Sub::UnclaimedDraftSigner::ORDER * * @return order */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java index 337c82ff8..05c8c9e17 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java @@ -67,7 +67,7 @@ public SubUnclaimedDraftTemplateSigner role(@javax.annotation.Nonnull String rol } /** - * Must match an existing role in chosen Template(s). + * _t__Sub::UnclaimedDraftTemplateSigner::ROLE * * @return role */ @@ -90,7 +90,7 @@ public SubUnclaimedDraftTemplateSigner name(@javax.annotation.Nonnull String nam } /** - * The name of the signer filling the role of `role`. + * _t__Sub::UnclaimedDraftTemplateSigner::NAME * * @return name */ @@ -114,7 +114,7 @@ public SubUnclaimedDraftTemplateSigner emailAddress( } /** - * The email address of the signer filling the role of `role`. + * _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS * * @return emailAddress */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java index aaa5e980f..b69b66967 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java @@ -25,11 +25,7 @@ import java.util.Map; import java.util.Objects; -/** - * An array of elements and values serialized to a string, to be used to customize the app's - * signer page. (Only applies to some API plans) Take a look at our [white labeling - * guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. - */ +/** _t__Sub::WhiteLabelingOptions::DESCRIPTION */ @JsonPropertyOrder({ SubWhiteLabelingOptions.JSON_PROPERTY_HEADER_BACKGROUND_COLOR, SubWhiteLabelingOptions.JSON_PROPERTY_LEGAL_VERSION, @@ -485,7 +481,7 @@ public SubWhiteLabelingOptions resetToDefault( } /** - * Resets white labeling options to defaults. Only useful when updating an API App. + * _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT * * @return resetToDefault */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java index b26c99715..3c8f1115c 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java @@ -94,7 +94,7 @@ public TeamGetInfoResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamGetResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamGetResponse.java index 2bee16d9e..98d0adf14 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamGetResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamGetResponse.java @@ -91,7 +91,7 @@ public TeamGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java index 09b1f9c66..9888a8026 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java @@ -73,7 +73,7 @@ public TeamInfoResponse teamId(@javax.annotation.Nullable String teamId) { } /** - * The id of a team + * _t__TeamGeneral::TEAM_ID * * @return teamId */ @@ -117,7 +117,7 @@ public TeamInfoResponse name(@javax.annotation.Nullable String name) { } /** - * The name of a team + * _t__TeamGeneral::NAME * * @return name */ @@ -139,7 +139,7 @@ public TeamInfoResponse numMembers(@javax.annotation.Nullable Integer numMembers } /** - * Number of members within a team + * _t__TeamGeneral::NUM_MEMBERS * * @return numMembers */ @@ -161,7 +161,7 @@ public TeamInfoResponse numSubTeams(@javax.annotation.Nullable Integer numSubTea } /** - * Number of sub teams within a team + * _t__TeamGeneral::NUM_SUB_TEAMS * * @return numSubTeams */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamParentResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamParentResponse.java index 9c8125e4b..f9cb80125 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamParentResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamParentResponse.java @@ -61,7 +61,7 @@ public TeamParentResponse teamId(@javax.annotation.Nullable String teamId) { } /** - * The id of a team + * _t__TeamGeneral::TEAM_ID * * @return teamId */ @@ -83,7 +83,7 @@ public TeamParentResponse name(@javax.annotation.Nullable String name) { } /** - * The name of a team + * _t__TeamGeneral::NAME * * @return name */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java index 6fcc0fd87..d4153e5dd 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TeamResponse.java @@ -25,7 +25,7 @@ import java.util.Map; import java.util.Objects; -/** Contains information about your team and its members */ +/** _t__TeamResponse::DESCRIPTION */ @JsonPropertyOrder({ TeamResponse.JSON_PROPERTY_NAME, TeamResponse.JSON_PROPERTY_ACCOUNTS, @@ -71,7 +71,7 @@ public TeamResponse name(@javax.annotation.Nullable String name) { } /** - * The name of your Team + * _t__Team::NAME * * @return name */ @@ -132,8 +132,7 @@ public TeamResponse addInvitedAccountsItem(AccountResponse invitedAccountsItem) } /** - * 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`. + * _t__Team::INVITED_ACCOUNTS * * @return invitedAccounts */ @@ -164,8 +163,7 @@ public TeamResponse addInvitedEmailsItem(String invitedEmailsItem) { } /** - * A list of email addresses that have an outstanding invitation to join your Team and do not - * yet have a Dropbox Sign account. + * _t__Team::INVITED_EMAILS * * @return invitedEmails */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java index 0061bf657..e03eb7041 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java @@ -33,6 +33,7 @@ TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_FILE_URLS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_CCS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_REASSIGN, + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ATTACHMENTS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_CC_ROLES, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_EDITOR_OPTIONS, @@ -74,6 +75,9 @@ public class TemplateCreateEmbeddedDraftRequest { public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @javax.annotation.Nullable private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @javax.annotation.Nullable private List attachments = null; @@ -289,6 +293,30 @@ public void setAllowReassign(@javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } + public TemplateCreateEmbeddedDraftRequest allowFormView( + @javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to + * `false`. + * + * @return allowFormView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowFormView() { + return allowFormView; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + public TemplateCreateEmbeddedDraftRequest attachments( @javax.annotation.Nullable List attachments) { this.attachments = attachments; @@ -304,7 +332,7 @@ public TemplateCreateEmbeddedDraftRequest addAttachmentsItem(SubAttachment attac } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * * @return attachments */ @@ -631,11 +659,7 @@ public TemplateCreateEmbeddedDraftRequest putMetadataItem(String key, Object met } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ @@ -867,6 +891,8 @@ public boolean equals(Object o) { && Objects.equals(this.allowCcs, templateCreateEmbeddedDraftRequest.allowCcs) && Objects.equals( this.allowReassign, templateCreateEmbeddedDraftRequest.allowReassign) + && Objects.equals( + this.allowFormView, templateCreateEmbeddedDraftRequest.allowFormView) && Objects.equals(this.attachments, templateCreateEmbeddedDraftRequest.attachments) && Objects.equals(this.ccRoles, templateCreateEmbeddedDraftRequest.ccRoles) && Objects.equals( @@ -910,6 +936,7 @@ public int hashCode() { fileUrls, allowCcs, allowReassign, + allowFormView, attachments, ccRoles, editorOptions, @@ -941,6 +968,7 @@ public String toString() { sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowCcs: ").append(toIndentedString(allowCcs)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" editorOptions: ").append(toIndentedString(editorOptions)).append("\n"); @@ -1075,6 +1103,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) + || allowFormView.getClass().equals(Integer.class) + || allowFormView.getClass().equals(String.class) + || allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for (int i = 0; i < getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } else { + map.put( + "allow_form_view", + JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java index d9ab41602..3cbce27ce 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java @@ -99,7 +99,7 @@ public TemplateCreateEmbeddedDraftResponse addWarningsItem(WarningResponse warni } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java index 1f11a454b..e7900c557 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java @@ -25,10 +25,7 @@ import java.util.Map; import java.util.Objects; -/** - * Template object with parameters: `template_id`, `edit_url`, - * `expires_at`. - */ +/** _t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION */ @JsonPropertyOrder({ TemplateCreateEmbeddedDraftResponseTemplate.JSON_PROPERTY_TEMPLATE_ID, TemplateCreateEmbeddedDraftResponseTemplate.JSON_PROPERTY_EDIT_URL, @@ -79,7 +76,7 @@ public TemplateCreateEmbeddedDraftResponseTemplate templateId( } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * * @return templateId */ @@ -102,7 +99,7 @@ public TemplateCreateEmbeddedDraftResponseTemplate editUrl( } /** - * Link to edit the template. + * _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL * * @return editUrl */ @@ -125,7 +122,7 @@ public TemplateCreateEmbeddedDraftResponseTemplate expiresAt( } /** - * When the link expires. + * _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT * * @return expiresAt */ @@ -158,7 +155,7 @@ public TemplateCreateEmbeddedDraftResponseTemplate addWarningsItem( } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings * @deprecated diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java index 8e3815a5b..e1162f192 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java @@ -33,6 +33,7 @@ TemplateCreateRequest.JSON_PROPERTY_FILES, TemplateCreateRequest.JSON_PROPERTY_FILE_URLS, TemplateCreateRequest.JSON_PROPERTY_ALLOW_REASSIGN, + TemplateCreateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateCreateRequest.JSON_PROPERTY_ATTACHMENTS, TemplateCreateRequest.JSON_PROPERTY_CC_ROLES, TemplateCreateRequest.JSON_PROPERTY_CLIENT_ID, @@ -69,6 +70,9 @@ public class TemplateCreateRequest { public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @javax.annotation.Nullable private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @javax.annotation.Nullable private List attachments = null; @@ -293,6 +297,29 @@ public void setAllowReassign(@javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } + public TemplateCreateRequest allowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to + * `false`. + * + * @return allowFormView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowFormView() { + return allowFormView; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + public TemplateCreateRequest attachments( @javax.annotation.Nullable List attachments) { this.attachments = attachments; @@ -308,7 +335,7 @@ public TemplateCreateRequest addAttachmentsItem(SubAttachment attachmentsItem) { } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * * @return attachments */ @@ -537,11 +564,7 @@ public TemplateCreateRequest putMetadataItem(String key, Object metadataItem) { } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ @@ -665,6 +688,7 @@ public boolean equals(Object o) { && Objects.equals(this.files, templateCreateRequest.files) && Objects.equals(this.fileUrls, templateCreateRequest.fileUrls) && Objects.equals(this.allowReassign, templateCreateRequest.allowReassign) + && Objects.equals(this.allowFormView, templateCreateRequest.allowFormView) && Objects.equals(this.attachments, templateCreateRequest.attachments) && Objects.equals(this.ccRoles, templateCreateRequest.ccRoles) && Objects.equals(this.clientId, templateCreateRequest.clientId) @@ -689,6 +713,7 @@ public int hashCode() { files, fileUrls, allowReassign, + allowFormView, attachments, ccRoles, clientId, @@ -715,6 +740,7 @@ public String toString() { sb.append(" files: ").append(toIndentedString(files)).append("\n"); sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -840,6 +866,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) + || allowFormView.getClass().equals(Integer.class) + || allowFormView.getClass().equals(String.class) + || allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for (int i = 0; i < getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } else { + map.put( + "allow_form_view", + JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java index 511bb2391..6c2dcb635 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java @@ -97,7 +97,7 @@ public TemplateCreateResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java index 5368e41b3..c27510894 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** Template object with parameters: `template_id`. */ +/** _t__TemplateCreateResponseTemplate::DESCRIPTION */ @JsonPropertyOrder({TemplateCreateResponseTemplate.JSON_PROPERTY_TEMPLATE_ID}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -57,7 +57,7 @@ public TemplateCreateResponseTemplate templateId(@javax.annotation.Nullable Stri } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * * @return templateId */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java index 095b796a1..feee3b9b5 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java @@ -55,7 +55,7 @@ public TemplateEditResponse templateId(@javax.annotation.Nonnull String template } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * * @return templateId */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java index f1e79244d..b2a6aee84 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java @@ -94,7 +94,7 @@ public TemplateGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateListResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateListResponse.java index 624836a79..3c4f38466 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateListResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateListResponse.java @@ -76,7 +76,7 @@ public TemplateListResponse addTemplatesItem(TemplateResponse templatesItem) { } /** - * List of templates that the API caller has access to. + * _t__TemplateListResponse::DESCRIPTION * * @return templates */ @@ -131,7 +131,7 @@ public TemplateListResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 794722520..4a0f841ab 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -25,7 +25,7 @@ import java.util.Map; import java.util.Objects; -/** Contains information about the templates you and your team have created. */ +/** _t__TemplateResponse::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponse.JSON_PROPERTY_TEMPLATE_ID, TemplateResponse.JSON_PROPERTY_TITLE, @@ -121,7 +121,7 @@ public TemplateResponse templateId(@javax.annotation.Nullable String templateId) } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * * @return templateId */ @@ -143,9 +143,7 @@ public TemplateResponse title(@javax.annotation.Nullable String title) { } /** - * The title of the Template. This will also be the default subject of the message sent to - * signers when using this Template to send a SignatureRequest. This can be overridden when - * sending the SignatureRequest. + * _t__TemplateResponse::TITLE * * @return title */ @@ -167,8 +165,7 @@ public TemplateResponse message(@javax.annotation.Nullable String message) { } /** - * The default message that will be sent to signers when using this Template to send a - * SignatureRequest. This can be overridden when sending the SignatureRequest. + * _t__TemplateResponse::MESSAGE * * @return message */ @@ -190,7 +187,7 @@ public TemplateResponse updatedAt(@javax.annotation.Nullable Integer updatedAt) } /** - * Time the template was last updated. + * _t__TemplateResponse::UPDATED_AT * * @return updatedAt */ @@ -212,9 +209,7 @@ public TemplateResponse isEmbedded(@javax.annotation.Nullable Boolean isEmbedded } /** - * `true` if this template was created using an embedded flow, `false` if it - * was created on our website. Will be `null` when you are not the creator of the - * Template. + * _t__TemplateResponse::IS_EMBEDDED * * @return isEmbedded */ @@ -236,8 +231,7 @@ public TemplateResponse isCreator(@javax.annotation.Nullable Boolean isCreator) } /** - * `true` if you are the owner of this template, `false` if it's been - * shared with you by a team member. + * _t__TemplateResponse::IS_CREATOR * * @return isCreator */ @@ -259,8 +253,7 @@ public TemplateResponse canEdit(@javax.annotation.Nullable Boolean canEdit) { } /** - * Indicates whether edit rights have been granted to you by the owner (always `true` - * if that's you). + * _t__TemplateResponse::CAN_EDIT * * @return canEdit */ @@ -282,9 +275,7 @@ public TemplateResponse isLocked(@javax.annotation.Nullable Boolean isLocked) { } /** - * Indicates whether the template is locked. If `true`, then the template was created - * outside your quota and can only be used in `test_mode`. If `false`, then - * the template is within your quota and can be used to create signature requests. + * _t__TemplateResponse::IS_LOCKED * * @return isLocked */ @@ -314,7 +305,7 @@ public TemplateResponse putMetadataItem(String key, Object metadataItem) { } /** - * The metadata attached to the template. + * _t__TemplateResponse::METADATA * * @return metadata */ @@ -345,8 +336,7 @@ public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRole } /** - * An array of the designated signer roles that must be specified when sending a - * SignatureRequest using this Template. + * _t__TemplateResponse::SIGNER_ROLES * * @return signerRoles */ @@ -378,8 +368,7 @@ public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { } /** - * An array of the designated CC roles that must be specified when sending a SignatureRequest - * using this Template. + * _t__TemplateResponse::CC_ROLES * * @return ccRoles */ @@ -410,8 +399,7 @@ public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) } /** - * An array describing each document associated with this Template. Includes form field data for - * each document. + * _t__TemplateResponse::DOCUMENTS * * @return documents */ @@ -444,9 +432,7 @@ public TemplateResponse addCustomFieldsItem( } /** - * Deprecated. Use `custom_fields` inside the - * [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) - * array instead. + * _t__TemplateResponseCustomField::DESCRIPTION * * @return customFields * @deprecated @@ -483,9 +469,7 @@ public TemplateResponse addNamedFormFieldsItem( } /** - * Deprecated. Use `form_fields` inside the - * [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) - * array instead. + * _t__TemplateResponseNamedFormField::DESCRIPTION * * @return namedFormFields * @deprecated @@ -520,7 +504,7 @@ public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { } /** - * An array of the Accounts that can use this Template. + * _t__TemplateResponse::ACCOUNTS * * @return accounts */ @@ -551,7 +535,7 @@ public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment at } /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION * * @return attachments */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java index 1f8cdbab4..57b579a30 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java @@ -78,7 +78,7 @@ public TemplateResponseAccount accountId(@javax.annotation.Nullable String accou } /** - * The id of the Account. + * _t__TemplateResponseAccount::ACCOUNT_ID * * @return accountId */ @@ -100,7 +100,7 @@ public TemplateResponseAccount emailAddress(@javax.annotation.Nullable String em } /** - * The email address associated with the Account. + * _t__TemplateResponseAccount::EMAIL_ADDRESS * * @return emailAddress */ @@ -122,7 +122,7 @@ public TemplateResponseAccount isLocked(@javax.annotation.Nullable Boolean isLoc } /** - * Returns `true` if the user has been locked out of their account by a team admin. + * _t__TemplateResponseAccount::IS_LOCKED * * @return isLocked */ @@ -144,7 +144,7 @@ public TemplateResponseAccount isPaidHs(@javax.annotation.Nullable Boolean isPai } /** - * Returns `true` if the user has a paid Dropbox Sign account. + * _t__TemplateResponseAccount::IS_PAID_HS * * @return isPaidHs */ @@ -166,7 +166,7 @@ public TemplateResponseAccount isPaidHf(@javax.annotation.Nullable Boolean isPai } /** - * Returns `true` if the user has a paid HelloFax account. + * _t__TemplateResponseAccount::IS_PAID_HF * * @return isPaidHf */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java index edad6110e..3e49f328d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java @@ -23,10 +23,7 @@ import java.util.Map; import java.util.Objects; -/** - * An array of the designated CC roles that must be specified when sending a SignatureRequest using - * this Template. - */ +/** _t__TemplateResponseAccountQuota::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseAccountQuota.JSON_PROPERTY_TEMPLATES_LEFT, TemplateResponseAccountQuota.JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT, @@ -76,7 +73,7 @@ public TemplateResponseAccountQuota templatesLeft( } /** - * API templates remaining. + * _t__TemplateResponseAccountQuota::TEMPLATES_LEFT * * @return templatesLeft */ @@ -99,7 +96,7 @@ public TemplateResponseAccountQuota apiSignatureRequestsLeft( } /** - * API signature requests remaining. + * _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT * * @return apiSignatureRequestsLeft */ @@ -123,7 +120,7 @@ public TemplateResponseAccountQuota documentsLeft( } /** - * Signature requests remaining. + * _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT * * @return documentsLeft */ @@ -146,7 +143,7 @@ public TemplateResponseAccountQuota smsVerificationsLeft( } /** - * SMS verifications remaining. + * _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT * * @return smsVerificationsLeft */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java index 00f72e343..821c3bd8f 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java @@ -56,7 +56,7 @@ public TemplateResponseCCRole name(@javax.annotation.Nullable String name) { } /** - * The name of the Role. + * _t__TemplateResponseCCRole::NAME * * @return name */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java index 3cabbf112..17e8e6170 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java @@ -84,7 +84,7 @@ public TemplateResponseDocument name(@javax.annotation.Nullable String name) { } /** - * Name of the associated file. + * _t__TemplateResponseDocument::NAME * * @return name */ @@ -106,8 +106,7 @@ public TemplateResponseDocument index(@javax.annotation.Nullable Integer index) } /** - * Document ordering, the lowest index is displayed first and the highest last (0-based - * indexing). + * _t__TemplateResponseDocument::INDEX * * @return index */ @@ -139,7 +138,7 @@ public TemplateResponseDocument addFieldGroupsItem( } /** - * An array of Form Field Group objects. + * _t__TemplateResponseDocument::FIELD_GROUPS * * @return fieldGroups */ @@ -172,7 +171,7 @@ public TemplateResponseDocument addFormFieldsItem( } /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentFormField::DESCRIPTION * * @return formFields */ @@ -205,7 +204,7 @@ public TemplateResponseDocument addCustomFieldsItem( } /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentCustomField::DESCRIPTION * * @return customFields */ @@ -238,8 +237,7 @@ public TemplateResponseDocument addStaticFieldsItem( } /** - * An array describing static overlay fields. **NOTE:** Only available for certain - * subscriptions. + * _t__TemplateResponseDocumentStaticField::DESCRIPTION * * @return staticFields */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java index f1190eac4..0fbc13c71 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java @@ -25,7 +25,7 @@ import java.util.Map; import java.util.Objects; -/** An array of Form Field objects containing the name and type of each named field. */ +/** _t__TemplateResponseDocumentCustomField::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_API_ID, @@ -134,7 +134,7 @@ public TemplateResponseDocumentCustomFieldBase apiId(@javax.annotation.Nullable } /** - * The unique ID for this field. + * _t__TemplateResponseDocumentCustomField::API_ID * * @return apiId */ @@ -156,7 +156,7 @@ public TemplateResponseDocumentCustomFieldBase name(@javax.annotation.Nullable S } /** - * The name of the Custom Field. + * _t__TemplateResponseDocumentCustomField::NAME * * @return name */ @@ -184,8 +184,7 @@ public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { } /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned - * to Sender). + * _t__TemplateResponseDocumentCustomField::SIGNER * * @return signer */ @@ -211,7 +210,7 @@ public TemplateResponseDocumentCustomFieldBase x(@javax.annotation.Nullable Inte } /** - * The horizontal offset in pixels for this form field. + * _t__TemplateResponseDocumentCustomField::X * * @return x */ @@ -233,7 +232,7 @@ public TemplateResponseDocumentCustomFieldBase y(@javax.annotation.Nullable Inte } /** - * The vertical offset in pixels for this form field. + * _t__TemplateResponseDocumentCustomField::Y * * @return y */ @@ -255,7 +254,7 @@ public TemplateResponseDocumentCustomFieldBase width(@javax.annotation.Nullable } /** - * The width in pixels of this form field. + * _t__TemplateResponseDocumentCustomField::WIDTH * * @return width */ @@ -278,7 +277,7 @@ public TemplateResponseDocumentCustomFieldBase height( } /** - * The height in pixels of this form field. + * _t__TemplateResponseDocumentCustomField::HEIGHT * * @return height */ @@ -301,7 +300,7 @@ public TemplateResponseDocumentCustomFieldBase required( } /** - * Boolean showing whether or not this field is required. + * _t__TemplateResponseDocumentStaticField::REQUIRED * * @return required */ @@ -323,8 +322,7 @@ public TemplateResponseDocumentCustomFieldBase group(@javax.annotation.Nullable } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null`. + * _t__TemplateResponseDocumentCustomField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java index ffde88fb2..882361fc2 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentCustomFieldBase` */ +/** _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({TemplateResponseDocumentCustomFieldCheckbox.JSON_PROPERTY_TYPE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -68,9 +68,7 @@ public TemplateResponseDocumentCustomFieldCheckbox type(@javax.annotation.Nonnul } /** - * The type of this Custom Field. Only `text` and `checkbox` are currently - * supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses - * `TemplateResponseDocumentCustomFieldCheckbox` + * _t__TemplateResponseDocumentCustomField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java index 1540bbba5..5ead12c0f 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentCustomFieldBase` */ +/** _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentCustomFieldText.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldText.JSON_PROPERTY_AVG_TEXT_LENGTH, @@ -85,9 +85,7 @@ public TemplateResponseDocumentCustomFieldText type(@javax.annotation.Nonnull St } /** - * The type of this Custom Field. Only `text` and `checkbox` are currently - * supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses - * `TemplateResponseDocumentCustomFieldCheckbox` + * _t__TemplateResponseDocumentCustomField::TYPE * * @return type */ @@ -135,7 +133,7 @@ public TemplateResponseDocumentCustomFieldText isMultiline( } /** - * Whether this form field is multiline text. + * _t__TemplateResponseDocumentCustomField::IS_MULTILINE * * @return isMultiline */ @@ -158,7 +156,7 @@ public TemplateResponseDocumentCustomFieldText originalFontSize( } /** - * Original font size used in this form field's text. + * _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE * * @return originalFontSize */ @@ -181,7 +179,7 @@ public TemplateResponseDocumentCustomFieldText fontFamily( } /** - * Font family used in this form field's text. + * _t__TemplateResponseDocumentCustomField::FONT_FAMILY * * @return fontFamily */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java index d7e2969d5..9d7859066 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java @@ -63,7 +63,7 @@ public TemplateResponseDocumentFieldGroup name(@javax.annotation.Nullable String } /** - * The name of the form field group. + * _t__TemplateResponseDocumentFieldGroup::NAME * * @return name */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java index ea499db4b..d681be290 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java @@ -23,10 +23,7 @@ import java.util.Map; import java.util.Objects; -/** - * The rule used to validate checkboxes in the form field group. See [checkbox field - * grouping](/api/reference/constants/#checkbox-field-grouping). - */ +/** _t__TemplateResponseDocumentFieldGroup::RULE */ @JsonPropertyOrder({ TemplateResponseDocumentFieldGroupRule.JSON_PROPERTY_REQUIREMENT, TemplateResponseDocumentFieldGroupRule.JSON_PROPERTY_GROUP_LABEL @@ -67,12 +64,7 @@ public TemplateResponseDocumentFieldGroupRule requirement( } /** - * 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. + * _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT * * @return requirement */ @@ -95,7 +87,7 @@ public TemplateResponseDocumentFieldGroupRule groupLabel( } /** - * Name of the group + * _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL * * @return groupLabel */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java index 9ab25a45b..d7bcc1eaf 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java @@ -25,7 +25,7 @@ import java.util.Map; import java.util.Objects; -/** An array of Form Field objects containing the name and type of each named field. */ +/** _t__TemplateResponseDocumentFormField::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_API_ID, @@ -139,7 +139,7 @@ public TemplateResponseDocumentFormFieldBase apiId(@javax.annotation.Nullable St } /** - * A unique id for the form field. + * _t__TemplateResponseDocumentFormField::API_ID * * @return apiId */ @@ -161,7 +161,7 @@ public TemplateResponseDocumentFormFieldBase name(@javax.annotation.Nullable Str } /** - * The name of the form field. + * _t__TemplateResponseDocumentFormField::NAME * * @return name */ @@ -188,7 +188,7 @@ public TemplateResponseDocumentFormFieldBase signer(Integer signer) { } /** - * The signer of the Form Field. + * _t__TemplateResponseDocumentFormField::SIGNER * * @return signer */ @@ -214,7 +214,7 @@ public TemplateResponseDocumentFormFieldBase x(@javax.annotation.Nullable Intege } /** - * The horizontal offset in pixels for this form field. + * _t__TemplateResponseDocumentFormField::X * * @return x */ @@ -236,7 +236,7 @@ public TemplateResponseDocumentFormFieldBase y(@javax.annotation.Nullable Intege } /** - * The vertical offset in pixels for this form field. + * _t__TemplateResponseDocumentFormField::Y * * @return y */ @@ -258,7 +258,7 @@ public TemplateResponseDocumentFormFieldBase width(@javax.annotation.Nullable In } /** - * The width in pixels of this form field. + * _t__TemplateResponseDocumentFormField::WIDTH * * @return width */ @@ -280,7 +280,7 @@ public TemplateResponseDocumentFormFieldBase height(@javax.annotation.Nullable I } /** - * The height in pixels of this form field. + * _t__TemplateResponseDocumentFormField::HEIGHT * * @return height */ @@ -303,7 +303,7 @@ public TemplateResponseDocumentFormFieldBase required( } /** - * Boolean showing whether or not this field is required. + * _t__TemplateResponseDocumentFormField::REQUIRED * * @return required */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java index 2e7cc69cf..64074a3f7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentFormFieldBase` */ +/** _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_GROUP @@ -73,15 +73,7 @@ public TemplateResponseDocumentFormFieldCheckbox type(@javax.annotation.Nonnull } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text - * Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses - * `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentFormFieldRadio` * Signature Field uses - * `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * * @return type */ @@ -105,8 +97,7 @@ public TemplateResponseDocumentFormFieldCheckbox group( } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java index 80cfc712f..daf0e54c9 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentFormFieldBase` */ +/** _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_GROUP @@ -74,15 +74,7 @@ public TemplateResponseDocumentFormFieldDateSigned type(@javax.annotation.Nonnul } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text - * Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses - * `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentFormFieldRadio` * Signature Field uses - * `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * * @return type */ @@ -106,8 +98,7 @@ public TemplateResponseDocumentFormFieldDateSigned group( } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java index 109b3413f..67a94348f 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentFormFieldBase` */ +/** _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_GROUP @@ -73,15 +73,7 @@ public TemplateResponseDocumentFormFieldDropdown type(@javax.annotation.Nonnull } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text - * Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses - * `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentFormFieldRadio` * Signature Field uses - * `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * * @return type */ @@ -105,8 +97,7 @@ public TemplateResponseDocumentFormFieldDropdown group( } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java index d1d89de56..4ecb653aa 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentFormFieldBase` */ +/** _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_AVG_TEXT_LENGTH, @@ -90,15 +90,7 @@ public TemplateResponseDocumentFormFieldHyperlink type(@javax.annotation.Nonnull } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text - * Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses - * `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentFormFieldRadio` * Signature Field uses - * `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * * @return type */ @@ -146,7 +138,7 @@ public TemplateResponseDocumentFormFieldHyperlink isMultiline( } /** - * Whether this form field is multiline text. + * _t__TemplateResponseDocumentFormField::IS_MULTILINE * * @return isMultiline */ @@ -169,7 +161,7 @@ public TemplateResponseDocumentFormFieldHyperlink originalFontSize( } /** - * Original font size used in this form field's text. + * _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE * * @return originalFontSize */ @@ -192,7 +184,7 @@ public TemplateResponseDocumentFormFieldHyperlink fontFamily( } /** - * Font family used in this form field's text. + * _t__TemplateResponseDocumentFormField::FONT_FAMILY * * @return fontFamily */ @@ -215,8 +207,7 @@ public TemplateResponseDocumentFormFieldHyperlink group( } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java index 6e0f78592..80e097245 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentFormFieldBase` */ +/** _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_GROUP @@ -73,15 +73,7 @@ public TemplateResponseDocumentFormFieldInitials type(@javax.annotation.Nonnull } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text - * Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses - * `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentFormFieldRadio` * Signature Field uses - * `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * * @return type */ @@ -105,8 +97,7 @@ public TemplateResponseDocumentFormFieldInitials group( } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java index 0ff1b8a4b..3702c2923 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentFormFieldBase` */ +/** _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_GROUP @@ -71,15 +71,7 @@ public TemplateResponseDocumentFormFieldRadio type(@javax.annotation.Nonnull Str } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text - * Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses - * `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentFormFieldRadio` * Signature Field uses - * `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * * @return type */ @@ -102,8 +94,7 @@ public TemplateResponseDocumentFormFieldRadio group(@javax.annotation.Nonnull St } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java index 53e1b3776..9f0c1aad3 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentFormFieldBase` */ +/** _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_GROUP @@ -74,15 +74,7 @@ public TemplateResponseDocumentFormFieldSignature type(@javax.annotation.Nonnull } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text - * Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses - * `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentFormFieldRadio` * Signature Field uses - * `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * * @return type */ @@ -106,8 +98,7 @@ public TemplateResponseDocumentFormFieldSignature group( } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java index 1eb8a426c..c3e69490a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java @@ -26,7 +26,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentFormFieldBase` */ +/** _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldText.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_AVG_TEXT_LENGTH, @@ -65,11 +65,7 @@ public class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum public static final String JSON_PROPERTY_FONT_FAMILY = "fontFamily"; @javax.annotation.Nullable private String fontFamily; - /** - * Each text field may contain a `validation_type` parameter. Check out the list of - * [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about - * the possible values. - */ + /** _t__TemplateResponseDocumentFormField::VALIDATION_TYPE */ public enum ValidationTypeEnum { NUMBERS_ONLY(String.valueOf("numbers_only")), @@ -155,15 +151,7 @@ public TemplateResponseDocumentFormFieldText type(@javax.annotation.Nonnull Stri } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text - * Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses - * `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentFormFieldRadio` * Signature Field uses - * `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * * @return type */ @@ -211,7 +199,7 @@ public TemplateResponseDocumentFormFieldText isMultiline( } /** - * Whether this form field is multiline text. + * _t__TemplateResponseDocumentFormField::IS_MULTILINE * * @return isMultiline */ @@ -234,7 +222,7 @@ public TemplateResponseDocumentFormFieldText originalFontSize( } /** - * Original font size used in this form field's text. + * _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE * * @return originalFontSize */ @@ -257,7 +245,7 @@ public TemplateResponseDocumentFormFieldText fontFamily( } /** - * Font family used in this form field's text. + * _t__TemplateResponseDocumentFormField::FONT_FAMILY * * @return fontFamily */ @@ -280,9 +268,7 @@ public TemplateResponseDocumentFormFieldText validationType( } /** - * Each text field may contain a `validation_type` parameter. Check out the list of - * [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about - * the possible values. + * _t__TemplateResponseDocumentFormField::VALIDATION_TYPE * * @return validationType */ @@ -305,8 +291,7 @@ public TemplateResponseDocumentFormFieldText validationCustomRegex( } /** - * When `validation_type` is set to `custom_regex`, this specifies the - * custom regular expression pattern that will be used to validate the text field. + * _t__TemplateResponseDocumentFormField::CUSTOM_REGEX * * @return validationCustomRegex */ @@ -329,8 +314,7 @@ public TemplateResponseDocumentFormFieldText validationCustomRegexFormatLabel( } /** - * When `validation_type` is set to `custom_regex`, this specifies the error - * message displayed to the signer when the text does not match the provided regex pattern. + * _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL * * @return validationCustomRegexFormatLabel */ @@ -353,8 +337,7 @@ public TemplateResponseDocumentFormFieldText group(@javax.annotation.Nullable St } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java index 6a2ae2ce6..5335cd7aa 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java @@ -25,9 +25,7 @@ import java.util.Map; import java.util.Objects; -/** - * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. - */ +/** _t__TemplateResponseDocumentStaticField::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_API_ID, @@ -152,7 +150,7 @@ public TemplateResponseDocumentStaticFieldBase apiId(@javax.annotation.Nullable } /** - * A unique id for the static field. + * _t__TemplateResponseDocumentStaticField::API_ID * * @return apiId */ @@ -174,7 +172,7 @@ public TemplateResponseDocumentStaticFieldBase name(@javax.annotation.Nullable S } /** - * The name of the static field. + * _t__TemplateResponseDocumentStaticField::NAME * * @return name */ @@ -197,7 +195,7 @@ public TemplateResponseDocumentStaticFieldBase signer( } /** - * The signer of the Static Field. + * _t__TemplateResponseDocumentStaticField::SIGNER * * @return signer */ @@ -219,7 +217,7 @@ public TemplateResponseDocumentStaticFieldBase x(@javax.annotation.Nullable Inte } /** - * The horizontal offset in pixels for this static field. + * _t__TemplateResponseDocumentStaticField::X * * @return x */ @@ -241,7 +239,7 @@ public TemplateResponseDocumentStaticFieldBase y(@javax.annotation.Nullable Inte } /** - * The vertical offset in pixels for this static field. + * _t__TemplateResponseDocumentStaticField::Y * * @return y */ @@ -263,7 +261,7 @@ public TemplateResponseDocumentStaticFieldBase width(@javax.annotation.Nullable } /** - * The width in pixels of this static field. + * _t__TemplateResponseDocumentStaticField::WIDTH * * @return width */ @@ -286,7 +284,7 @@ public TemplateResponseDocumentStaticFieldBase height( } /** - * The height in pixels of this static field. + * _t__TemplateResponseDocumentStaticField::HEIGHT * * @return height */ @@ -309,7 +307,7 @@ public TemplateResponseDocumentStaticFieldBase required( } /** - * Boolean showing whether or not this field is required. + * _t__TemplateResponseDocumentStaticField::REQUIRED * * @return required */ @@ -331,8 +329,7 @@ public TemplateResponseDocumentStaticFieldBase group(@javax.annotation.Nullable } /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null`. + * _t__TemplateResponseDocumentStaticField::GROUP * * @return group */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java index 97294dd19..8d5c89043 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentStaticFieldBase` */ +/** _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({TemplateResponseDocumentStaticFieldCheckbox.JSON_PROPERTY_TYPE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -68,15 +68,7 @@ public TemplateResponseDocumentStaticFieldCheckbox type(@javax.annotation.Nonnul } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * - * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses - * `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses - * `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java index 3a42fbb7b..8c177e6ac 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentStaticFieldBase` */ +/** _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({TemplateResponseDocumentStaticFieldDateSigned.JSON_PROPERTY_TYPE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -70,15 +70,7 @@ public TemplateResponseDocumentStaticFieldDateSigned type( } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * - * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses - * `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses - * `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java index ba9fc8e2d..26819775a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentStaticFieldBase` */ +/** _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({TemplateResponseDocumentStaticFieldDropdown.JSON_PROPERTY_TYPE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -68,15 +68,7 @@ public TemplateResponseDocumentStaticFieldDropdown type(@javax.annotation.Nonnul } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * - * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses - * `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses - * `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java index 29052c92c..98b44cea9 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentStaticFieldBase` */ +/** _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({TemplateResponseDocumentStaticFieldHyperlink.JSON_PROPERTY_TYPE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -69,15 +69,7 @@ public TemplateResponseDocumentStaticFieldHyperlink type( } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * - * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses - * `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses - * `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java index bd5c5f0e5..342b062c7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentStaticFieldBase` */ +/** _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({TemplateResponseDocumentStaticFieldInitials.JSON_PROPERTY_TYPE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -68,15 +68,7 @@ public TemplateResponseDocumentStaticFieldInitials type(@javax.annotation.Nonnul } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * - * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses - * `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses - * `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java index 3b0590111..e5fe0bc96 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentStaticFieldBase` */ +/** _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({TemplateResponseDocumentStaticFieldRadio.JSON_PROPERTY_TYPE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -67,15 +67,7 @@ public TemplateResponseDocumentStaticFieldRadio type(@javax.annotation.Nonnull S } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * - * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses - * `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses - * `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java index cd319353d..9504368cf 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentStaticFieldBase` */ +/** _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({TemplateResponseDocumentStaticFieldSignature.JSON_PROPERTY_TYPE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -69,15 +69,7 @@ public TemplateResponseDocumentStaticFieldSignature type( } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * - * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses - * `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses - * `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java index ca3d5682c..5aac9ce1b 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java @@ -24,7 +24,7 @@ import java.util.Map; import java.util.Objects; -/** This class extends `TemplateResponseDocumentStaticFieldBase` */ +/** _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({TemplateResponseDocumentStaticFieldText.JSON_PROPERTY_TYPE}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -67,15 +67,7 @@ public TemplateResponseDocumentStaticFieldText type(@javax.annotation.Nonnull St } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * - * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses - * `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses - * `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses - * `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses - * `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses - * `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses - * `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses - * `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * * @return type */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java index 9c0fca40a..ea170eb94 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** Average text length in this field. */ +/** _t__TemplateResponseFieldAvgTextLength::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseFieldAvgTextLength.JSON_PROPERTY_NUM_LINES, TemplateResponseFieldAvgTextLength.JSON_PROPERTY_NUM_CHARS_PER_LINE @@ -64,7 +64,7 @@ public TemplateResponseFieldAvgTextLength numLines( } /** - * Number of lines. + * _t__TemplateResponseFieldAvgTextLength::NUM_LINES * * @return numLines */ @@ -87,7 +87,7 @@ public TemplateResponseFieldAvgTextLength numCharsPerLine( } /** - * Number of characters per line. + * _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE * * @return numCharsPerLine */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java index b313ab8d8..e8e3b0190 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java @@ -63,7 +63,7 @@ public TemplateResponseSignerRole name(@javax.annotation.Nullable String name) { } /** - * The name of the Role. + * _t__TemplateResponseSignerRole::NAME * * @return name */ @@ -85,7 +85,7 @@ public TemplateResponseSignerRole order(@javax.annotation.Nullable Integer order } /** - * If signer order is assigned this is the 0-based index for this role. + * _t__TemplateResponseSignerRole::ORDER * * @return order */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java index 26fa213ca..808cffdca 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java @@ -25,7 +25,7 @@ import java.util.Map; import java.util.Objects; -/** Contains template id */ +/** _t__TemplateUpdateFilesResponseTemplate::DESCRIPTION */ @JsonPropertyOrder({ TemplateUpdateFilesResponseTemplate.JSON_PROPERTY_TEMPLATE_ID, TemplateUpdateFilesResponseTemplate.JSON_PROPERTY_WARNINGS @@ -66,7 +66,7 @@ public TemplateUpdateFilesResponseTemplate templateId( } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * * @return templateId */ @@ -98,7 +98,7 @@ public TemplateUpdateFilesResponseTemplate addWarningsItem(WarningResponse warni } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings * @deprecated diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java index 4b758039a..27814d90a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java @@ -36,6 +36,7 @@ UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_FILE_URLS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_CCS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, + UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -90,6 +91,9 @@ public class UnclaimedDraftCreateEmbeddedRequest { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @javax.annotation.Nullable private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; @@ -396,6 +400,30 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } + public UnclaimedDraftCreateEmbeddedRequest allowFormView( + @javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to + * `false`. + * + * @return allowFormView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowFormView() { + return allowFormView; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + public UnclaimedDraftCreateEmbeddedRequest allowReassign( @javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; @@ -436,7 +464,7 @@ public UnclaimedDraftCreateEmbeddedRequest addAttachmentsItem(SubAttachment atta } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * * @return attachments */ @@ -850,11 +878,7 @@ public UnclaimedDraftCreateEmbeddedRequest putMetadataItem(String key, Object me } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ @@ -958,7 +982,7 @@ public UnclaimedDraftCreateEmbeddedRequest addSignersItem(SubUnclaimedDraftSigne } /** - * Add Signers to your Unclaimed Draft Signature Request. + * _t__Sub::UnclaimedDraftSigner::DESCRIPTION * * @return signers */ @@ -1245,6 +1269,8 @@ public boolean equals(Object o) { && Objects.equals(this.allowCcs, unclaimedDraftCreateEmbeddedRequest.allowCcs) && Objects.equals( this.allowDecline, unclaimedDraftCreateEmbeddedRequest.allowDecline) + && Objects.equals( + this.allowFormView, unclaimedDraftCreateEmbeddedRequest.allowFormView) && Objects.equals( this.allowReassign, unclaimedDraftCreateEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, unclaimedDraftCreateEmbeddedRequest.attachments) @@ -1312,6 +1338,7 @@ public int hashCode() { fileUrls, allowCcs, allowDecline, + allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -1356,6 +1383,7 @@ public String toString() { sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowCcs: ").append(toIndentedString(allowCcs)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1532,6 +1560,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) + || allowFormView.getClass().equals(Integer.class) + || allowFormView.getClass().equals(String.class) + || allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for (int i = 0; i < getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } else { + map.put( + "allow_form_view", + JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java index 94848f92d..075f60a93 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java @@ -622,11 +622,7 @@ public UnclaimedDraftCreateEmbeddedWithTemplateRequest putMetadataItem( } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ @@ -758,7 +754,7 @@ public UnclaimedDraftCreateEmbeddedWithTemplateRequest addSignersItem( } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION * * @return signers */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java index 0b0b6b61b..c33d0e55a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java @@ -34,6 +34,7 @@ UnclaimedDraftCreateRequest.JSON_PROPERTY_FILES, UnclaimedDraftCreateRequest.JSON_PROPERTY_FILE_URLS, UnclaimedDraftCreateRequest.JSON_PROPERTY_ALLOW_DECLINE, + UnclaimedDraftCreateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, UnclaimedDraftCreateRequest.JSON_PROPERTY_ATTACHMENTS, UnclaimedDraftCreateRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, UnclaimedDraftCreateRequest.JSON_PROPERTY_CLIENT_ID, @@ -109,6 +110,9 @@ public static TypeEnum fromValue(String value) { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @javax.annotation.Nullable private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @javax.annotation.Nullable private List attachments = null; @@ -299,6 +303,30 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } + public UnclaimedDraftCreateRequest allowFormView( + @javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to + * `false`. + * + * @return allowFormView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getAllowFormView() { + return allowFormView; + } + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + public UnclaimedDraftCreateRequest attachments( @javax.annotation.Nullable List attachments) { this.attachments = attachments; @@ -314,7 +342,7 @@ public UnclaimedDraftCreateRequest addAttachmentsItem(SubAttachment attachmentsI } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * * @return attachments */ @@ -629,11 +657,7 @@ public UnclaimedDraftCreateRequest putMetadataItem(String key, Object metadataIt } /** - * Key-value data that should be attached to the signature request. This metadata is included in - * all API responses and events involving the signature request. For example, use the metadata - * field to store a signer's order number for look up when receiving events for the - * signature request. Each request can include up to 10 metadata keys (or 50 nested metadata - * keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * * @return metadata */ @@ -688,7 +712,7 @@ public UnclaimedDraftCreateRequest addSignersItem(SubUnclaimedDraftSigner signer } /** - * Add Signers to your Unclaimed Draft Signature Request. + * _t__Sub::UnclaimedDraftSigner::DESCRIPTION * * @return signers */ @@ -891,6 +915,7 @@ public boolean equals(Object o) { && Objects.equals(this.files, unclaimedDraftCreateRequest.files) && Objects.equals(this.fileUrls, unclaimedDraftCreateRequest.fileUrls) && Objects.equals(this.allowDecline, unclaimedDraftCreateRequest.allowDecline) + && Objects.equals(this.allowFormView, unclaimedDraftCreateRequest.allowFormView) && Objects.equals(this.attachments, unclaimedDraftCreateRequest.attachments) && Objects.equals( this.ccEmailAddresses, unclaimedDraftCreateRequest.ccEmailAddresses) @@ -926,6 +951,7 @@ public int hashCode() { files, fileUrls, allowDecline, + allowFormView, attachments, ccEmailAddresses, clientId, @@ -956,6 +982,7 @@ public String toString() { sb.append(" files: ").append(toIndentedString(files)).append("\n"); sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -1068,6 +1095,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) + || allowFormView.getClass().equals(Integer.class) + || allowFormView.getClass().equals(String.class) + || allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for (int i = 0; i < getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } else { + map.put( + "allow_form_view", + JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java index f93c402e8..c99b9ff31 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java @@ -98,7 +98,7 @@ public UnclaimedDraftCreateResponse addWarningsItem(WarningResponse warningsItem } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @return warnings */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java index cf497fce5..4d361342a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** A group of documents that a user can take ownership of via the claim URL. */ +/** _t__UnclaimedDraftResponse::DESCRIPTION */ @JsonPropertyOrder({ UnclaimedDraftResponse.JSON_PROPERTY_SIGNATURE_REQUEST_ID, UnclaimedDraftResponse.JSON_PROPERTY_CLAIM_URL, @@ -79,7 +79,7 @@ public UnclaimedDraftResponse signatureRequestId( } /** - * The ID of the signature request that is represented by this UnclaimedDraft. + * _t__UnclaimedDraft::SIGNATURE_REQUEST_ID * * @return signatureRequestId */ @@ -101,7 +101,7 @@ public UnclaimedDraftResponse claimUrl(@javax.annotation.Nullable String claimUr } /** - * The URL to be used to claim this UnclaimedDraft. + * _t__UnclaimedDraft::CLAIM_URL * * @return claimUrl */ @@ -124,7 +124,7 @@ public UnclaimedDraftResponse signingRedirectUrl( } /** - * The URL you want signers redirected to after they successfully sign. + * _t__UnclaimedDraft::SIGNING_REDIRECT_URL * * @return signingRedirectUrl */ @@ -147,8 +147,7 @@ public UnclaimedDraftResponse requestingRedirectUrl( } /** - * The URL you want signers redirected to after they successfully request a signature (Will only - * be returned in the response if it is applicable to the request.). + * _t__UnclaimedDraft::REQUESTING_REDIRECT_URL * * @return requestingRedirectUrl */ @@ -170,7 +169,7 @@ public UnclaimedDraftResponse expiresAt(@javax.annotation.Nullable Integer expir } /** - * When the link expires. + * _t__UnclaimedDraft::EXPIRES_AT * * @return expiresAt */ @@ -192,7 +191,7 @@ public UnclaimedDraftResponse testMode(@javax.annotation.Nullable Boolean testMo } /** - * Whether this is a test draft. Signature requests made from test drafts have no legal value. + * _t__UnclaimedDraft::TEST_MODE * * @return testMode */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/WarningResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/WarningResponse.java index df3fc0502..98855dc32 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/WarningResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/WarningResponse.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.Objects; -/** A list of warnings. */ +/** _t__WarningResponse::LIST_DESCRIPTION */ @JsonPropertyOrder({ WarningResponse.JSON_PROPERTY_WARNING_MSG, WarningResponse.JSON_PROPERTY_WARNING_NAME @@ -61,7 +61,7 @@ public WarningResponse warningMsg(@javax.annotation.Nonnull String warningMsg) { } /** - * Warning message + * _t__WarningResponse::WARNING_MSG * * @return warningMsg */ @@ -84,7 +84,7 @@ public WarningResponse warningName(@javax.annotation.Nonnull String warningName) } /** - * Warning name + * _t__WarningResponse::WARNING_NAME * * @return warningName */ diff --git a/sdks/java-v2/docs/AccountCreateResponse.md b/sdks/java-v2/docs/AccountCreateResponse.md index 7e09def2b..5cec28ba0 100644 --- a/sdks/java-v2/docs/AccountCreateResponse.md +++ b/sdks/java-v2/docs/AccountCreateResponse.md @@ -10,7 +10,7 @@ |------------ | ------------- | ------------- | -------------| | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | | `oauthData` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/AccountGetResponse.md b/sdks/java-v2/docs/AccountGetResponse.md index f5ed78b06..63d6404b9 100644 --- a/sdks/java-v2/docs/AccountGetResponse.md +++ b/sdks/java-v2/docs/AccountGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/AccountResponse.md b/sdks/java-v2/docs/AccountResponse.md index 5b73aa02d..db3336c8c 100644 --- a/sdks/java-v2/docs/AccountResponse.md +++ b/sdks/java-v2/docs/AccountResponse.md @@ -8,16 +8,16 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The ID of the Account | | -| `emailAddress` | ```String``` | The email address associated with the Account. | | -| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `accountId` | ```String``` | _t__Account::ACCOUNT_ID | | +| `emailAddress` | ```String``` | _t__Account::EMAIL_ADDRESS | | +| `isLocked` | ```Boolean``` | _t__Account::IS_LOCKED | | +| `isPaidHs` | ```Boolean``` | _t__Account::IS_PAID_HS | | +| `isPaidHf` | ```Boolean``` | _t__Account::IS_PAID_HF | | | `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | -| `callbackUrl` | ```String``` | The URL that Dropbox Sign events will `POST` to. | | -| `roleCode` | ```String``` | The membership role for the team. | | -| `teamId` | ```String``` | The id of the team account belongs to. | | -| `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. | | +| `callbackUrl` | ```String``` | _t__Account::CALLBACK_URL | | +| `roleCode` | ```String``` | _t__Account::ROLE_CODE | | +| `teamId` | ```String``` | _t__Account::TEAM_ID | | +| `locale` | ```String``` | _t__Account::LOCALE | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | diff --git a/sdks/java-v2/docs/AccountResponseQuotas.md b/sdks/java-v2/docs/AccountResponseQuotas.md index e7510a8d7..d742a9e83 100644 --- a/sdks/java-v2/docs/AccountResponseQuotas.md +++ b/sdks/java-v2/docs/AccountResponseQuotas.md @@ -2,18 +2,18 @@ # AccountResponseQuotas -Details concerning remaining monthly quotas. +_t__Account::QUOTA ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `templatesTotal` | ```Integer``` | Total API templates allowed. | | -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```Integer``` | Number of fax pages left | | +| `apiSignatureRequestsLeft` | ```Integer``` | _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documentsLeft` | ```Integer``` | _t__AccountQuota::DOCUMENTS_LEFT | | +| `templatesTotal` | ```Integer``` | _t__AccountQuota::TEMPLATES_TOTAL | | +| `templatesLeft` | ```Integer``` | _t__AccountQuota::TEMPLATES_LEFT | | +| `smsVerificationsLeft` | ```Integer``` | _t__AccountQuota::SMS_VERIFICATIONS_LEFT | | +| `numFaxPagesLeft` | ```Integer``` | _t__AccountQuota::NUM_FAX_PAGES_LEFT | | diff --git a/sdks/java-v2/docs/AccountResponseUsage.md b/sdks/java-v2/docs/AccountResponseUsage.md index 1cdb76629..782ab6465 100644 --- a/sdks/java-v2/docs/AccountResponseUsage.md +++ b/sdks/java-v2/docs/AccountResponseUsage.md @@ -2,13 +2,13 @@ # AccountResponseUsage -Details concerning monthly usage +_t__Account::USAGE ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `faxPagesSent` | ```Integer``` | Number of fax pages sent | | +| `faxPagesSent` | ```Integer``` | _t__AccountUsage::FAX_PAGES_SENT | | diff --git a/sdks/java-v2/docs/AccountVerifyResponse.md b/sdks/java-v2/docs/AccountVerifyResponse.md index 8868f15b2..c5d2054cc 100644 --- a/sdks/java-v2/docs/AccountVerifyResponse.md +++ b/sdks/java-v2/docs/AccountVerifyResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `account` | [```AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/AccountVerifyResponseAccount.md b/sdks/java-v2/docs/AccountVerifyResponseAccount.md index f83f9f0eb..5aa3c1b0f 100644 --- a/sdks/java-v2/docs/AccountVerifyResponseAccount.md +++ b/sdks/java-v2/docs/AccountVerifyResponseAccount.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `emailAddress` | ```String``` | The email address associated with the Account. | | +| `emailAddress` | ```String``` | _t__Account::EMAIL_ADDRESS | | diff --git a/sdks/java-v2/docs/ApiAppGetResponse.md b/sdks/java-v2/docs/ApiAppGetResponse.md index 98e2f98d6..d0e1efaef 100644 --- a/sdks/java-v2/docs/ApiAppGetResponse.md +++ b/sdks/java-v2/docs/ApiAppGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `apiApp`*_required_ | [```ApiAppResponse```](ApiAppResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/ApiAppListResponse.md b/sdks/java-v2/docs/ApiAppListResponse.md index 14c287f97..5e8621ee5 100644 --- a/sdks/java-v2/docs/ApiAppListResponse.md +++ b/sdks/java-v2/docs/ApiAppListResponse.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiApps`*_required_ | [```List```](ApiAppResponse.md) | Contains information about API Apps. | | +| `apiApps`*_required_ | [```List```](ApiAppResponse.md) | _t__ApiAppListResponse::DESCRIPTION | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/ApiAppResponse.md b/sdks/java-v2/docs/ApiAppResponse.md index afe95c850..d140acb51 100644 --- a/sdks/java-v2/docs/ApiAppResponse.md +++ b/sdks/java-v2/docs/ApiAppResponse.md @@ -2,18 +2,18 @@ # ApiAppResponse -Contains information about an API App. +_t__ApiAppResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl` | ```String``` | The app's callback URL (for events) | | -| `clientId` | ```String``` | The app's client id | | -| `createdAt` | ```Integer``` | The time that the app was created | | -| `domains` | ```List``` | The domain name(s) associated with the app | | -| `name` | ```String``` | The name of the app | | -| `isApproved` | ```Boolean``` | Boolean to indicate if the app has been approved | | +| `callbackUrl` | ```String``` | _t__ApiAppResponse::CALLBACK_URL | | +| `clientId` | ```String``` | _t__ApiAppResponse::CLIENT_ID | | +| `createdAt` | ```Integer``` | _t__ApiAppResponse::CREATED_AT | | +| `domains` | ```List``` | _t__ApiAppResponse::DOMAINS | | +| `name` | ```String``` | _t__ApiAppResponse::NAME | | +| `isApproved` | ```Boolean``` | _t__ApiAppResponse::IS_APPROVED | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | | `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | | `ownerAccount` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | diff --git a/sdks/java-v2/docs/ApiAppResponseOAuth.md b/sdks/java-v2/docs/ApiAppResponseOAuth.md index c2f705c7a..b74028732 100644 --- a/sdks/java-v2/docs/ApiAppResponseOAuth.md +++ b/sdks/java-v2/docs/ApiAppResponseOAuth.md @@ -2,16 +2,16 @@ # ApiAppResponseOAuth -An object describing the app's OAuth properties, or null if OAuth is not configured for the app. +_t__ApiAppResponseOAuth::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl` | ```String``` | The app's OAuth callback URL. | | -| `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```List``` | Array of OAuth scopes used by the app. | | -| `chargesUsers` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callbackUrl` | ```String``` | _t__ApiAppResponseOAuth::CALLBACK_URL | | +| `secret` | ```String``` | _t__ApiAppResponseOAuth::SECRET | | +| `scopes` | ```List``` | _t__ApiAppResponseOAuth::SCOPES | | +| `chargesUsers` | ```Boolean``` | _t__ApiAppResponseOAuth::CHARGES_USERS | | diff --git a/sdks/java-v2/docs/ApiAppResponseOptions.md b/sdks/java-v2/docs/ApiAppResponseOptions.md index 07979f387..1f56da408 100644 --- a/sdks/java-v2/docs/ApiAppResponseOptions.md +++ b/sdks/java-v2/docs/ApiAppResponseOptions.md @@ -2,13 +2,13 @@ # ApiAppResponseOptions -An object with options that override account settings. +_t__ApiAppResponseOptions::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `canInsertEverywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `canInsertEverywhere` | ```Boolean``` | _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE | | diff --git a/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md b/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md index b4d6d4249..6acc14f4e 100644 --- a/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/java-v2/docs/ApiAppResponseOwnerAccount.md @@ -2,14 +2,14 @@ # ApiAppResponseOwnerAccount -An object describing the app's owner +_t__ApiAppResponseOwnerAccount::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The owner account's ID | | -| `emailAddress` | ```String``` | The owner account's email address | | +| `accountId` | ```String``` | _t__ApiAppResponseOwnerAccount::ACCOUNT_ID | | +| `emailAddress` | ```String``` | _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS | | diff --git a/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md index be6d022fd..2d7dbfaa2 100644 --- a/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/java-v2/docs/ApiAppResponseWhiteLabelingOptions.md @@ -2,7 +2,7 @@ # ApiAppResponseWhiteLabelingOptions -An object with options to customize the app's signer page +_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION ## Properties diff --git a/sdks/java-v2/docs/BulkSendJobGetResponse.md b/sdks/java-v2/docs/BulkSendJobGetResponse.md index 93395ee2d..7a63dc95d 100644 --- a/sdks/java-v2/docs/BulkSendJobGetResponse.md +++ b/sdks/java-v2/docs/BulkSendJobGetResponse.md @@ -10,8 +10,8 @@ |------------ | ------------- | ------------- | -------------| | `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `signatureRequests`*_required_ | [```List```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `signatureRequests`*_required_ | [```List```](BulkSendJobGetResponseSignatureRequests.md) | _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/java-v2/docs/BulkSendJobGetResponseSignatureRequests.md index 09809ea86..fd76f9157 100644 --- a/sdks/java-v2/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/java-v2/docs/BulkSendJobGetResponseSignatureRequests.md @@ -8,31 +8,31 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `testMode` | ```Boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | | -| `signatureRequestId` | ```String``` | The id of the SignatureRequest. | | -| `requesterEmailAddress` | ```String``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```String``` | The title the specified Account uses for the SignatureRequest. | | -| `originalTitle` | ```String``` | Default Label for account. | | -| `subject` | ```String``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```String``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```Map``` | The metadata attached to the signature request. | | -| `createdAt` | ```Integer``` | Time the signature request was created. | | -| `expiresAt` | ```Integer``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `isComplete` | ```Boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `isDeclined` | ```Boolean``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `hasError` | ```Boolean``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `filesUrl` | ```String``` | The URL where a copy of the request's documents can be downloaded. | | -| `signingUrl` | ```String``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `detailsUrl` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `ccEmailAddresses` | ```List``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signingRedirectUrl` | ```String``` | The URL you want the signer redirected to after they successfully sign. | | -| `finalCopyUri` | ```String``` | The path where the completed document can be downloaded | | -| `templateIds` | ```List``` | Templates IDs used in this SignatureRequest (if any). | | -| `customFields` | [```List```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `responseData` | [```List```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```List```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | +| `testMode` | ```Boolean``` | _t__SignatureRequestResponse::TEST_MODE | | +| `signatureRequestId` | ```String``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requesterEmailAddress` | ```String``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```String``` | _t__SignatureRequestResponse::TITLE | | +| `originalTitle` | ```String``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```String``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```String``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```Map``` | _t__SignatureRequestResponse::METADATA | | +| `createdAt` | ```Integer``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expiresAt` | ```Integer``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `isComplete` | ```Boolean``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `isDeclined` | ```Boolean``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `hasError` | ```Boolean``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `filesUrl` | ```String``` | _t__SignatureRequestResponse::FILES_URL | | +| `signingUrl` | ```String``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `detailsUrl` | ```String``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `ccEmailAddresses` | ```List``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signingRedirectUrl` | ```String``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `finalCopyUri` | ```String``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `templateIds` | ```List``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `customFields` | [```List```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `responseData` | [```List```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```List```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulkSendJobId` | ```String``` | _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID | | diff --git a/sdks/java-v2/docs/BulkSendJobListResponse.md b/sdks/java-v2/docs/BulkSendJobListResponse.md index e5eb2315d..18ca67a32 100644 --- a/sdks/java-v2/docs/BulkSendJobListResponse.md +++ b/sdks/java-v2/docs/BulkSendJobListResponse.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `bulkSendJobs`*_required_ | [```List```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | +| `bulkSendJobs`*_required_ | [```List```](BulkSendJobResponse.md) | _t__BulkSendJobListResponse::BULK_SEND_JOBS | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/BulkSendJobResponse.md b/sdks/java-v2/docs/BulkSendJobResponse.md index eb2278a34..3eb55ac91 100644 --- a/sdks/java-v2/docs/BulkSendJobResponse.md +++ b/sdks/java-v2/docs/BulkSendJobResponse.md @@ -2,16 +2,16 @@ # BulkSendJobResponse -Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. +_t__BulkSendJobResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | -| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | | -| `isCreator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `createdAt` | ```Integer``` | Time that the BulkSendJob was created. | | +| `bulkSendJobId` | ```String``` | _t__BulkSendJobResponse::BULK_SEND_JOB_ID | | +| `total` | ```Integer``` | _t__BulkSendJobResponse::TOTAL | | +| `isCreator` | ```Boolean``` | _t__BulkSendJobResponse::IS_CREATOR | | +| `createdAt` | ```Integer``` | _t__BulkSendJobResponse::CREATED_AT | | diff --git a/sdks/java-v2/docs/BulkSendJobSendResponse.md b/sdks/java-v2/docs/BulkSendJobSendResponse.md index 532b64b5b..e53db9f2c 100644 --- a/sdks/java-v2/docs/BulkSendJobSendResponse.md +++ b/sdks/java-v2/docs/BulkSendJobSendResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/EmbeddedEditUrlRequest.md b/sdks/java-v2/docs/EmbeddedEditUrlRequest.md index 4e2d8c2e9..a6b29059c 100644 --- a/sdks/java-v2/docs/EmbeddedEditUrlRequest.md +++ b/sdks/java-v2/docs/EmbeddedEditUrlRequest.md @@ -9,6 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `allowEditCcs` | ```Boolean``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `forceSignerRoles` | ```Boolean``` | Provide users the ability to review/edit the template signer roles. | | diff --git a/sdks/java-v2/docs/EmbeddedEditUrlResponse.md b/sdks/java-v2/docs/EmbeddedEditUrlResponse.md index 959e0c75f..cb92376ac 100644 --- a/sdks/java-v2/docs/EmbeddedEditUrlResponse.md +++ b/sdks/java-v2/docs/EmbeddedEditUrlResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `embedded`*_required_ | [```EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/EmbeddedEditUrlResponseEmbedded.md b/sdks/java-v2/docs/EmbeddedEditUrlResponseEmbedded.md index 78ad7026c..f1a83bd9a 100644 --- a/sdks/java-v2/docs/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/java-v2/docs/EmbeddedEditUrlResponseEmbedded.md @@ -2,14 +2,14 @@ # EmbeddedEditUrlResponseEmbedded -An embedded template object. +_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `editUrl` | ```String``` | A template url that can be opened in an iFrame. | | -| `expiresAt` | ```Integer``` | The specific time that the the `edit_url` link expires, in epoch. | | +| `editUrl` | ```String``` | _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL | | +| `expiresAt` | ```Integer``` | _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT | | diff --git a/sdks/java-v2/docs/EmbeddedSignUrlResponse.md b/sdks/java-v2/docs/EmbeddedSignUrlResponse.md index 6f39b97fe..8740aa776 100644 --- a/sdks/java-v2/docs/EmbeddedSignUrlResponse.md +++ b/sdks/java-v2/docs/EmbeddedSignUrlResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `embedded`*_required_ | [```EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/EmbeddedSignUrlResponseEmbedded.md b/sdks/java-v2/docs/EmbeddedSignUrlResponseEmbedded.md index b2fd6c9df..b98682a9e 100644 --- a/sdks/java-v2/docs/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/java-v2/docs/EmbeddedSignUrlResponseEmbedded.md @@ -2,14 +2,14 @@ # EmbeddedSignUrlResponseEmbedded -An object that contains necessary information to set up embedded signing. +_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `signUrl` | ```String``` | A signature url that can be opened in an iFrame. | | -| `expiresAt` | ```Integer``` | The specific time that the the `sign_url` link expires, in epoch. | | +| `signUrl` | ```String``` | _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL | | +| `expiresAt` | ```Integer``` | _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT | | diff --git a/sdks/java-v2/docs/ErrorResponseError.md b/sdks/java-v2/docs/ErrorResponseError.md index 656aa5c7f..6c9122d64 100644 --- a/sdks/java-v2/docs/ErrorResponseError.md +++ b/sdks/java-v2/docs/ErrorResponseError.md @@ -2,15 +2,15 @@ # ErrorResponseError -Contains information about an error that occurred. +_t__ErrorResponseError::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `errorMsg`*_required_ | ```String``` | Message describing an error. | | -| `errorName`*_required_ | ```String``` | Name of the error. | | -| `errorPath` | ```String``` | Path at which an error occurred. | | +| `errorMsg`*_required_ | ```String``` | _t__ErrorResponseError::ERROR_MSG | | +| `errorName`*_required_ | ```String``` | _t__ErrorResponseError::ERROR_NAME | | +| `errorPath` | ```String``` | _t__ErrorResponseError::ERROR_PATH | | diff --git a/sdks/java-v2/docs/EventCallbackRequestEvent.md b/sdks/java-v2/docs/EventCallbackRequestEvent.md index 19ab491c2..a0eeedb82 100644 --- a/sdks/java-v2/docs/EventCallbackRequestEvent.md +++ b/sdks/java-v2/docs/EventCallbackRequestEvent.md @@ -2,15 +2,15 @@ # EventCallbackRequestEvent -Basic information about the event that occurred. +_t__EventCallbackRequestEvent::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `eventTime`*_required_ | ```String``` | Time the event was created (using Unix time). | | -| `eventType`*_required_ | [```EventTypeEnum```](#EventTypeEnum) | Type of callback event that was triggered. | | -| `eventHash`*_required_ | ```String``` | Generated hash used to verify source of event data. | | +| `eventTime`*_required_ | ```String``` | _t__EventCallbackRequestEvent::EVENT_TIME | | +| `eventType`*_required_ | [```EventTypeEnum```](#EventTypeEnum) | _t__EventCallbackRequestEvent::EVENT_TYPE | | +| `eventHash`*_required_ | ```String``` | _t__EventCallbackRequestEvent::EVENT_HASH | | | `eventMetadata` | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | | diff --git a/sdks/java-v2/docs/EventCallbackRequestEventMetadata.md b/sdks/java-v2/docs/EventCallbackRequestEventMetadata.md index 13208c2d1..634a78637 100644 --- a/sdks/java-v2/docs/EventCallbackRequestEventMetadata.md +++ b/sdks/java-v2/docs/EventCallbackRequestEventMetadata.md @@ -2,16 +2,16 @@ # EventCallbackRequestEventMetadata -Specific metadata about the event. +_t__EventCallbackRequestEventMetadata::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `relatedSignatureId` | ```String``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | -| `reportedForAccountId` | ```String``` | Account ID the event was reported for. | | -| `reportedForAppId` | ```String``` | App ID the event was reported for. | | -| `eventMessage` | ```String``` | Message about a declined or failed (due to error) signature flow. | | +| `relatedSignatureId` | ```String``` | _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID | | +| `reportedForAccountId` | ```String``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID | | +| `reportedForAppId` | ```String``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID | | +| `eventMessage` | ```String``` | _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE | | diff --git a/sdks/java-v2/docs/FaxGetResponse.md b/sdks/java-v2/docs/FaxGetResponse.md index cc9dc6e57..99f950ac2 100644 --- a/sdks/java-v2/docs/FaxGetResponse.md +++ b/sdks/java-v2/docs/FaxGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/FileResponse.md b/sdks/java-v2/docs/FileResponse.md index 058a80ed5..d2eb324ff 100644 --- a/sdks/java-v2/docs/FileResponse.md +++ b/sdks/java-v2/docs/FileResponse.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `fileUrl`*_required_ | ```String``` | URL to the file. | | -| `expiresAt`*_required_ | ```Integer``` | When the link expires. | | +| `fileUrl`*_required_ | ```String``` | _t__FileResponse::FILE_URL | | +| `expiresAt`*_required_ | ```Integer``` | _t__FileResponse::EXPIRES_AT | | diff --git a/sdks/java-v2/docs/FileResponseDataUri.md b/sdks/java-v2/docs/FileResponseDataUri.md index 65c0b7dbc..97490ae00 100644 --- a/sdks/java-v2/docs/FileResponseDataUri.md +++ b/sdks/java-v2/docs/FileResponseDataUri.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `dataUri`*_required_ | ```String``` | File as base64 encoded string. | | +| `dataUri`*_required_ | ```String``` | _t__FileResponse::DATA_URI | | diff --git a/sdks/java-v2/docs/ListInfoResponse.md b/sdks/java-v2/docs/ListInfoResponse.md index b9d464ec7..e37eca0ac 100644 --- a/sdks/java-v2/docs/ListInfoResponse.md +++ b/sdks/java-v2/docs/ListInfoResponse.md @@ -2,16 +2,16 @@ # ListInfoResponse -Contains pagination information about the data returned. +_t__ListInfoResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numPages` | ```Integer``` | Total number of pages available. | | -| `numResults` | ```Integer``` | Total number of objects available. | | -| `page` | ```Integer``` | Number of the page being returned. | | -| `pageSize` | ```Integer``` | Objects returned per page. | | +| `numPages` | ```Integer``` | _t__ListInfoResponse::NUM_PAGES | | +| `numResults` | ```Integer``` | _t__ListInfoResponse::NUM_RESULTS | | +| `page` | ```Integer``` | _t__ListInfoResponse::PAGE | | +| `pageSize` | ```Integer``` | _t__ListInfoResponse::PAGE_SIZE | | diff --git a/sdks/java-v2/docs/OAuthTokenResponse.md b/sdks/java-v2/docs/OAuthTokenResponse.md index 86824ccb0..cb7b96bea 100644 --- a/sdks/java-v2/docs/OAuthTokenResponse.md +++ b/sdks/java-v2/docs/OAuthTokenResponse.md @@ -11,7 +11,7 @@ | `accessToken` | ```String``` | | | | `tokenType` | ```String``` | | | | `refreshToken` | ```String``` | | | -| `expiresIn` | ```Integer``` | Number of seconds until the `access_token` expires. Uses epoch time. | | +| `expiresIn` | ```Integer``` | _t__OAuthTokenResponse::EXPIRES_IN | | | `state` | ```String``` | | | diff --git a/sdks/java-v2/docs/ReportCreateRequest.md b/sdks/java-v2/docs/ReportCreateRequest.md index d2f4b67e2..78390304c 100644 --- a/sdks/java-v2/docs/ReportCreateRequest.md +++ b/sdks/java-v2/docs/ReportCreateRequest.md @@ -20,6 +20,7 @@ ---- | ----- | USER_ACTIVITY | "user_activity" | | DOCUMENT_STATUS | "document_status" | +| SMS_ACTIVITY | "sms_activity" | diff --git a/sdks/java-v2/docs/ReportCreateResponse.md b/sdks/java-v2/docs/ReportCreateResponse.md index 9fc8565de..a82a15904 100644 --- a/sdks/java-v2/docs/ReportCreateResponse.md +++ b/sdks/java-v2/docs/ReportCreateResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `report`*_required_ | [```ReportResponse```](ReportResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/ReportResponse.md b/sdks/java-v2/docs/ReportResponse.md index b48dde6f4..174c02b67 100644 --- a/sdks/java-v2/docs/ReportResponse.md +++ b/sdks/java-v2/docs/ReportResponse.md @@ -2,16 +2,16 @@ # ReportResponse -Contains information about the report request. +_t__ReportResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `success` | ```String``` | A message indicating the requested operation's success | | -| `startDate` | ```String``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | | -| `endDate` | ```String``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | | -| `reportType` | [```List<ReportTypeEnum>```](#List<ReportTypeEnum>) | 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). | | +| `success` | ```String``` | _t__ReportResponse::SUCCESS | | +| `startDate` | ```String``` | _t__ReportResponse::START_DATE | | +| `endDate` | ```String``` | _t__ReportResponse::END_DATE | | +| `reportType` | [```List<ReportTypeEnum>```](#List<ReportTypeEnum>) | _t__ReportResponse::REPORT_TYPE | | @@ -21,6 +21,7 @@ Contains information about the report request. ---- | ----- | USER_ACTIVITY | "user_activity" | | DOCUMENT_STATUS | "document_status" | +| SMS_ACTIVITY | "sms_activity" | diff --git a/sdks/java-v2/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index 4243ead1c..116960466 100644 --- a/sdks/java-v2/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -16,7 +16,7 @@ | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestBulkSendWithTemplateRequest.md index 1798f6fdc..858ce4fd0 100644 --- a/sdks/java-v2/docs/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestBulkSendWithTemplateRequest.md @@ -16,7 +16,7 @@ | `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md index 383f8a8f3..587f8487c 100644 --- a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md @@ -11,11 +11,12 @@ | `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -24,7 +25,7 @@ | `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 050a7e631..182ae7e12 100644 --- a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -10,14 +10,14 @@ |------------ | ------------- | ------------- | -------------| | `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md index dd8b06061..daa2c01f9 100644 --- a/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md @@ -11,11 +11,12 @@ | `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -24,7 +25,7 @@ | `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index 3cc3dee72..2c55580de 100644 --- a/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -10,14 +10,14 @@ |------------ | ------------- | ------------- | -------------| | `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/SignatureRequestEditRequest.md b/sdks/java-v2/docs/SignatureRequestEditRequest.md index 7fa3aca65..11ad2b410 100644 --- a/sdks/java-v2/docs/SignatureRequestEditRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditRequest.md @@ -10,11 +10,12 @@ |------------ | ------------- | ------------- | -------------| | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -25,7 +26,7 @@ | `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | | `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md index d079524b1..7e3c3193c 100644 --- a/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `clientId` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -18,7 +18,7 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v2/docs/SignatureRequestGetResponse.md b/sdks/java-v2/docs/SignatureRequestGetResponse.md index 25ce665c4..eda5746dc 100644 --- a/sdks/java-v2/docs/SignatureRequestGetResponse.md +++ b/sdks/java-v2/docs/SignatureRequestGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `signatureRequest`*_required_ | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/SignatureRequestListResponse.md b/sdks/java-v2/docs/SignatureRequestListResponse.md index 6384d2ad0..87cccab67 100644 --- a/sdks/java-v2/docs/SignatureRequestListResponse.md +++ b/sdks/java-v2/docs/SignatureRequestListResponse.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `signatureRequests`*_required_ | [```List```](SignatureRequestResponse.md) | Contains information about signature requests. | | +| `signatureRequests`*_required_ | [```List```](SignatureRequestResponse.md) | _t__SignatureRequestListResponse::DESCRIPTION | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/SignatureRequestResponse.md b/sdks/java-v2/docs/SignatureRequestResponse.md index 6e8d9645c..15b148c8e 100644 --- a/sdks/java-v2/docs/SignatureRequestResponse.md +++ b/sdks/java-v2/docs/SignatureRequestResponse.md @@ -2,37 +2,37 @@ # SignatureRequestResponse -Contains information about a signature request. +_t__SignatureRequestResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `testMode` | ```Boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | | -| `signatureRequestId` | ```String``` | The id of the SignatureRequest. | | -| `requesterEmailAddress` | ```String``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```String``` | The title the specified Account uses for the SignatureRequest. | | -| `originalTitle` | ```String``` | Default Label for account. | | -| `subject` | ```String``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```String``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```Map``` | The metadata attached to the signature request. | | -| `createdAt` | ```Integer``` | Time the signature request was created. | | -| `expiresAt` | ```Integer``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `isComplete` | ```Boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `isDeclined` | ```Boolean``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `hasError` | ```Boolean``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `filesUrl` | ```String``` | The URL where a copy of the request's documents can be downloaded. | | -| `signingUrl` | ```String``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `detailsUrl` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `ccEmailAddresses` | ```List``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signingRedirectUrl` | ```String``` | The URL you want the signer redirected to after they successfully sign. | | -| `finalCopyUri` | ```String``` | The path where the completed document can be downloaded | | -| `templateIds` | ```List``` | Templates IDs used in this SignatureRequest (if any). | | -| `customFields` | [```List```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `responseData` | [```List```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```List```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulkSendJobId` | ```String``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `testMode` | ```Boolean``` | _t__SignatureRequestResponse::TEST_MODE | | +| `signatureRequestId` | ```String``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requesterEmailAddress` | ```String``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```String``` | _t__SignatureRequestResponse::TITLE | | +| `originalTitle` | ```String``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```String``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```String``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```Map``` | _t__SignatureRequestResponse::METADATA | | +| `createdAt` | ```Integer``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expiresAt` | ```Integer``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `isComplete` | ```Boolean``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `isDeclined` | ```Boolean``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `hasError` | ```Boolean``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `filesUrl` | ```String``` | _t__SignatureRequestResponse::FILES_URL | | +| `signingUrl` | ```String``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `detailsUrl` | ```String``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `ccEmailAddresses` | ```List``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signingRedirectUrl` | ```String``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `finalCopyUri` | ```String``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `templateIds` | ```List``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `customFields` | [```List```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `responseData` | [```List```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```List```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulkSendJobId` | ```String``` | _t__SignatureRequestResponse::BULK_SEND_JOB_ID | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseAttachment.md b/sdks/java-v2/docs/SignatureRequestResponseAttachment.md index 1ef3a209b..9c336fb99 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseAttachment.md +++ b/sdks/java-v2/docs/SignatureRequestResponseAttachment.md @@ -2,18 +2,18 @@ # SignatureRequestResponseAttachment -Signer attachments. +_t__SignatureRequestResponseAttachment::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `id`*_required_ | ```String``` | The unique ID for this attachment. | | -| `signer`*_required_ | ```String``` | The Signer this attachment is assigned to. | | -| `name`*_required_ | ```String``` | The name of this attachment. | | -| `required`*_required_ | ```Boolean``` | A boolean value denoting if this attachment is required. | | -| `instructions` | ```String``` | Instructions for Signer. | | -| `uploadedAt` | ```Integer``` | Timestamp when attachment was uploaded by Signer. | | +| `id`*_required_ | ```String``` | _t__SignatureRequestResponseAttachment::ID | | +| `signer`*_required_ | ```String``` | _t__SignatureRequestResponseAttachment::SIGNER | | +| `name`*_required_ | ```String``` | _t__SignatureRequestResponseAttachment::NAME | | +| `required`*_required_ | ```Boolean``` | _t__SignatureRequestResponseAttachment::REQUIRED | | +| `instructions` | ```String``` | _t__SignatureRequestResponseAttachment::INSTRUCTIONS | | +| `uploadedAt` | ```Integer``` | _t__SignatureRequestResponseAttachment::UPLOADED_AT | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseCustomFieldBase.md b/sdks/java-v2/docs/SignatureRequestResponseCustomFieldBase.md index 7b5f104c4..9e70c2c04 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/java-v2/docs/SignatureRequestResponseCustomFieldBase.md @@ -2,20 +2,17 @@ # SignatureRequestResponseCustomFieldBase -An array of Custom Field objects containing the name and type of each custom field. - -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` +_t__SignatureRequestResponseCustomField::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `name`*_required_ | ```String``` | The name of the Custom Field. | | -| `required` | ```Boolean``` | A boolean value denoting if this field is required. | | -| `apiId` | ```String``` | The unique ID for this field. | | -| `editor` | ```String``` | The name of the Role that is able to edit this field. | | +| `type`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `name`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::NAME | | +| `required` | ```Boolean``` | _t__SignatureRequestResponseCustomField::REQUIRED | | +| `apiId` | ```String``` | _t__SignatureRequestResponseCustomField::API_ID | | +| `editor` | ```String``` | _t__SignatureRequestResponseCustomField::EDITOR | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/java-v2/docs/SignatureRequestResponseCustomFieldCheckbox.md index c2cb8414b..4456feab9 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/java-v2/docs/SignatureRequestResponseCustomFieldCheckbox.md @@ -2,14 +2,14 @@ # SignatureRequestResponseCustomFieldCheckbox -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `value` | ```Boolean``` | A true/false for checkbox fields | | +| `type`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `value` | ```Boolean``` | _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseCustomFieldText.md b/sdks/java-v2/docs/SignatureRequestResponseCustomFieldText.md index 23ceb565c..aebc7c3a7 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseCustomFieldText.md +++ b/sdks/java-v2/docs/SignatureRequestResponseCustomFieldText.md @@ -2,14 +2,14 @@ # SignatureRequestResponseCustomFieldText -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `value` | ```String``` | A text string for text fields | | +| `type`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseCustomField::VALUE_TEXT | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataBase.md b/sdks/java-v2/docs/SignatureRequestResponseDataBase.md index a9605a44a..98fc540af 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataBase.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataBase.md @@ -2,16 +2,16 @@ # SignatureRequestResponseDataBase -An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. +_t__SignatureRequestResponseData::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `apiId` | ```String``` | The unique ID for this field. | | -| `signatureId` | ```String``` | The ID of the signature to which this response is linked. | | -| `name` | ```String``` | The name of the form field. | | -| `required` | ```Boolean``` | A boolean value denoting if this field is required. | | +| `apiId` | ```String``` | _t__SignatureRequestResponseData::API_ID | | +| `signatureId` | ```String``` | _t__SignatureRequestResponseData::SIGNATURE_ID | | +| `name` | ```String``` | _t__SignatureRequestResponseData::NAME | | +| `required` | ```Boolean``` | _t__SignatureRequestResponseData::REQUIRED | | | `type` | ```String``` | | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataValueCheckbox.md b/sdks/java-v2/docs/SignatureRequestResponseDataValueCheckbox.md index fda57045a..8223ce4d3 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataValueCheckbox.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A yes/no checkbox | | -| `value` | ```Boolean``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE | | +| `value` | ```Boolean``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/java-v2/docs/SignatureRequestResponseDataValueCheckboxMerge.md index 96af5ebaf..e74347dad 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataValueCheckboxMerge.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A checkbox field that has default value set by the api | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataValueDateSigned.md b/sdks/java-v2/docs/SignatureRequestResponseDataValueDateSigned.md index 308bd8bf2..c81ef7e9f 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataValueDateSigned.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A date | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataValueDropdown.md b/sdks/java-v2/docs/SignatureRequestResponseDataValueDropdown.md index 599cb3cef..a149d835f 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataValueDropdown.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | An input field for dropdowns | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataValueInitials.md b/sdks/java-v2/docs/SignatureRequestResponseDataValueInitials.md index 760618b49..3b23a11b0 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataValueInitials.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataValueInitials.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | An input field for initials | | -| `value` | ```String``` | The value of the form field. | | -| `isSigned` | ```Boolean``` | This field contains the boolean true if the field is signed. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::INITIAL_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `isSigned` | ```Boolean``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataValueRadio.md b/sdks/java-v2/docs/SignatureRequestResponseDataValueRadio.md index b8e073f1f..a883030e9 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataValueRadio.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataValueRadio.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | An input field for radios | | -| `value` | ```Boolean``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::RADIO_TYPE | | +| `value` | ```Boolean``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataValueSignature.md b/sdks/java-v2/docs/SignatureRequestResponseDataValueSignature.md index 8cea5ac2e..77ddcedd4 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataValueSignature.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataValueSignature.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A signature input field | | -| `value` | ```String``` | The value of the form field. | | -| `isSigned` | ```Boolean``` | This field contains the boolean true if the field is signed. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `isSigned` | ```Boolean``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataValueText.md b/sdks/java-v2/docs/SignatureRequestResponseDataValueText.md index e08ec8ff8..51cce03c0 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataValueText.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataValueText.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A text input field | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::TEXT_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseDataValueTextMerge.md b/sdks/java-v2/docs/SignatureRequestResponseDataValueTextMerge.md index 2b5e0d3fe..ff149de94 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/java-v2/docs/SignatureRequestResponseDataValueTextMerge.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type` | ```String``` | A text field that has default text set by the api | | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE | | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/java-v2/docs/SignatureRequestResponseSignatures.md b/sdks/java-v2/docs/SignatureRequestResponseSignatures.md index 2f0e16dc0..51530b745 100644 --- a/sdks/java-v2/docs/SignatureRequestResponseSignatures.md +++ b/sdks/java-v2/docs/SignatureRequestResponseSignatures.md @@ -2,31 +2,31 @@ # SignatureRequestResponseSignatures -An array of signature objects, 1 for each signer. +_t__SignatureRequestResponseSignatures::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `signatureId` | ```String``` | Signature identifier. | | -| `signerGroupGuid` | ```String``` | Signer Group GUID | | -| `signerEmailAddress` | ```String``` | The email address of the signer. | | -| `signerName` | ```String``` | The name of the signer. | | -| `signerRole` | ```String``` | The role of the signer. | | -| `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this signer. | | -| `statusCode` | ```String``` | The current status of the signature. eg: awaiting_signature, signed, declined. | | -| `declineReason` | ```String``` | The reason provided by the signer for declining the request. | | -| `signedAt` | ```Integer``` | Time that the document was signed or null. | | -| `lastViewedAt` | ```Integer``` | The time that the document was last viewed by this signer or null. | | -| `lastRemindedAt` | ```Integer``` | The time the last reminder email was sent to the signer or null. | | -| `hasPin` | ```Boolean``` | Boolean to indicate whether this signature requires a PIN to access. | | -| `hasSmsAuth` | ```Boolean``` | Boolean to indicate whether this signature has SMS authentication enabled. | | -| `hasSmsDelivery` | ```Boolean``` | Boolean to indicate whether this signature has SMS delivery enabled. | | -| `smsPhoneNumber` | ```String``` | The SMS phone number used for authentication or signature request delivery. | | -| `reassignedBy` | ```String``` | Email address of original signer who reassigned to this signer. | | -| `reassignmentReason` | ```String``` | Reason provided by original signer who reassigned to this signer. | | -| `reassignedFrom` | ```String``` | Previous signature identifier. | | -| `error` | ```String``` | Error message pertaining to this signer, or null. | | +| `signatureId` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNATURE_ID | | +| `signerGroupGuid` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID | | +| `signerEmailAddress` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS | | +| `signerName` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_NAME | | +| `signerRole` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_ROLE | | +| `order` | ```Integer``` | _t__SignatureRequestResponseSignatures::ORDER | | +| `statusCode` | ```String``` | _t__SignatureRequestResponseSignatures::STATUS_CODE | | +| `declineReason` | ```String``` | _t__SignatureRequestResponseSignatures::DECLINE_REASON | | +| `signedAt` | ```Integer``` | _t__SignatureRequestResponseSignatures::SIGNED_AT | | +| `lastViewedAt` | ```Integer``` | _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT | | +| `lastRemindedAt` | ```Integer``` | _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT | | +| `hasPin` | ```Boolean``` | _t__SignatureRequestResponseSignatures::HAS_PIN | | +| `hasSmsAuth` | ```Boolean``` | _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH | | +| `hasSmsDelivery` | ```Boolean``` | _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY | | +| `smsPhoneNumber` | ```String``` | _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER | | +| `reassignedBy` | ```String``` | _t__SignatureRequestResponseSignatures::REASSIGNED_BY | | +| `reassignmentReason` | ```String``` | _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON | | +| `reassignedFrom` | ```String``` | _t__SignatureRequestResponseSignatures::REASSIGNED_FROM | | +| `error` | ```String``` | _t__SignatureRequestResponseSignatures::ERROR | | diff --git a/sdks/java-v2/docs/SignatureRequestSendRequest.md b/sdks/java-v2/docs/SignatureRequestSendRequest.md index 914303935..d0d039382 100644 --- a/sdks/java-v2/docs/SignatureRequestSendRequest.md +++ b/sdks/java-v2/docs/SignatureRequestSendRequest.md @@ -10,11 +10,12 @@ |------------ | ------------- | ------------- | -------------| | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -26,7 +27,7 @@ | `isQualifiedSignature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v2/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestSendWithTemplateRequest.md index 7a8d8c88a..4f648c089 100644 --- a/sdks/java-v2/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestSendWithTemplateRequest.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `clientId` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -19,7 +19,7 @@ | `isQualifiedSignature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v2/docs/SubFormFieldsPerDocumentBase.md b/sdks/java-v2/docs/SubFormFieldsPerDocumentBase.md index a44994a32..6ee822a91 100644 --- a/sdks/java-v2/docs/SubFormFieldsPerDocumentBase.md +++ b/sdks/java-v2/docs/SubFormFieldsPerDocumentBase.md @@ -27,9 +27,9 @@ The fields that should appear on the document, expressed as an array of objects. | `required`*_required_ | ```Boolean``` | Whether this field is required. | | | `signer`*_required_ | ```String``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | | | `type`*_required_ | ```String``` | | | -| `width`*_required_ | ```Integer``` | Size of the field in pixels. | | -| `x`*_required_ | ```Integer``` | Location coordinates of the field in pixels. | | -| `y`*_required_ | ```Integer``` | Location coordinates of the field in pixels. | | +| `width`*_required_ | ```Integer``` | _t__Sub::FormFieldsPerDocument::WIDTH | | +| `x`*_required_ | ```Integer``` | _t__Sub::FormFieldsPerDocument::X | | +| `y`*_required_ | ```Integer``` | _t__Sub::FormFieldsPerDocument::Y | | | `name` | ```String``` | Display name for the field. | | | `page` | ```Integer``` | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | | diff --git a/sdks/java-v2/docs/SubFormFieldsPerDocumentText.md b/sdks/java-v2/docs/SubFormFieldsPerDocumentText.md index d431f5422..2c02080a3 100644 --- a/sdks/java-v2/docs/SubFormFieldsPerDocumentText.md +++ b/sdks/java-v2/docs/SubFormFieldsPerDocumentText.md @@ -13,7 +13,7 @@ This class extends `SubFormFieldsPerDocumentBase`. | `autoFillType` | ```String``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | | | `linkId` | ```String``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | | | `masked` | ```Boolean``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | | -| `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.

**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | | +| `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE | | | `validationCustomRegex` | ```String``` | | | | `validationCustomRegexFormatLabel` | ```String``` | | | | `content` | ```String``` | Content of a `me_now` text field | | diff --git a/sdks/java-v2/docs/SubFormFieldsPerDocumentTextMerge.md b/sdks/java-v2/docs/SubFormFieldsPerDocumentTextMerge.md index e1876cce1..aabd1ff23 100644 --- a/sdks/java-v2/docs/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/java-v2/docs/SubFormFieldsPerDocumentTextMerge.md @@ -8,7 +8,7 @@ This class extends `SubFormFieldsPerDocumentBase`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | | +| `type`*_required_ | ```String``` | _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE | | | `fontFamily` | [```FontFamilyEnum```](#FontFamilyEnum) | Font family for the field. | | | `fontSize` | ```Integer``` | 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. | | diff --git a/sdks/java-v2/docs/SubMergeField.md b/sdks/java-v2/docs/SubMergeField.md index 66582350e..42b68e7f2 100644 --- a/sdks/java-v2/docs/SubMergeField.md +++ b/sdks/java-v2/docs/SubMergeField.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the merge field. Must be unique. | | -| `type`*_required_ | [```TypeEnum```](#TypeEnum) | The type of merge field. | | +| `name`*_required_ | ```String``` | _t__Sub::MergeField::NAME | | +| `type`*_required_ | [```TypeEnum```](#TypeEnum) | _t__Sub::MergeField::TYPE | | diff --git a/sdks/java-v2/docs/SubOAuth.md b/sdks/java-v2/docs/SubOAuth.md index 527d0be78..14b5533be 100644 --- a/sdks/java-v2/docs/SubOAuth.md +++ b/sdks/java-v2/docs/SubOAuth.md @@ -2,14 +2,14 @@ # SubOAuth -OAuth related parameters. +_t__Sub::OAuth::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `callbackUrl` | ```String``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | -| `scopes` | [```List<ScopesEnum>```](#List<ScopesEnum>) | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | +| `callbackUrl` | ```String``` | _t__Sub::OAuth::CALLBACK_URL | | +| `scopes` | [```List<ScopesEnum>```](#List<ScopesEnum>) | _t__Sub::OAuth::SCOPES | | diff --git a/sdks/java-v2/docs/SubOptions.md b/sdks/java-v2/docs/SubOptions.md index c36523a02..c71bcab56 100644 --- a/sdks/java-v2/docs/SubOptions.md +++ b/sdks/java-v2/docs/SubOptions.md @@ -2,13 +2,13 @@ # SubOptions -Additional options supported by API App. +_t__Sub::Options::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `canInsertEverywhere` | ```Boolean``` | Determines if signers can use "Insert Everywhere" when signing a document. | | +| `canInsertEverywhere` | ```Boolean``` | _t__Sub::Options::CAN_INSERT_EVERYWHERE | | diff --git a/sdks/java-v2/docs/SubSignatureRequestGroupedSigners.md b/sdks/java-v2/docs/SubSignatureRequestGroupedSigners.md index 80ace3400..92c98a2d3 100644 --- a/sdks/java-v2/docs/SubSignatureRequestGroupedSigners.md +++ b/sdks/java-v2/docs/SubSignatureRequestGroupedSigners.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `group`*_required_ | ```String``` | The name of the group. | | -| `signers`*_required_ | [```List```](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. | | -| `order` | ```Integer``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | +| `group`*_required_ | ```String``` | _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME | | +| `signers`*_required_ | [```List```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestGroupedSigners::SIGNERS | | +| `order` | ```Integer``` | _t__Sub::SignatureRequestGroupedSigners::ORDER | | diff --git a/sdks/java-v2/docs/SubSignatureRequestSigner.md b/sdks/java-v2/docs/SubSignatureRequestSigner.md index 109c422bc..77fac86d8 100644 --- a/sdks/java-v2/docs/SubSignatureRequestSigner.md +++ b/sdks/java-v2/docs/SubSignatureRequestSigner.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name`*_required_ | ```String``` | The name of the signer. | | -| `emailAddress`*_required_ | ```String``` | The email address of the signer. | | -| `order` | ```Integer``` | The order the signer is required to sign in. | | -| `pin` | ```String``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `smsPhoneNumber` | ```String``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `smsPhoneNumberType` | [```SmsPhoneNumberTypeEnum```](#SmsPhoneNumberTypeEnum) | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `name`*_required_ | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_NAME | | +| `emailAddress`*_required_ | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS | | +| `order` | ```Integer``` | _t__Sub::SignatureRequestSigner::SIGNER_ORDER | | +| `pin` | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_PIN | | +| `smsPhoneNumber` | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER | | +| `smsPhoneNumberType` | [```SmsPhoneNumberTypeEnum```](#SmsPhoneNumberTypeEnum) | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | diff --git a/sdks/java-v2/docs/SubSignatureRequestTemplateSigner.md b/sdks/java-v2/docs/SubSignatureRequestTemplateSigner.md index 866b37355..493ff7554 100644 --- a/sdks/java-v2/docs/SubSignatureRequestTemplateSigner.md +++ b/sdks/java-v2/docs/SubSignatureRequestTemplateSigner.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `role`*_required_ | ```String``` | Must match an existing role in chosen Template(s). It's case-sensitive. | | -| `name`*_required_ | ```String``` | The name of the signer. | | -| `emailAddress`*_required_ | ```String``` | The email address of the signer. | | -| `pin` | ```String``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `smsPhoneNumber` | ```String``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `smsPhoneNumberType` | [```SmsPhoneNumberTypeEnum```](#SmsPhoneNumberTypeEnum) | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `role`*_required_ | ```String``` | _t__Sub::SignatureRequestTemplateSigner::ROLE | | +| `name`*_required_ | ```String``` | _t__Sub::SignatureRequestTemplateSigner::NAME | | +| `emailAddress`*_required_ | ```String``` | _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS | | +| `pin` | ```String``` | _t__Sub::SignatureRequestTemplateSigner::PIN | | +| `smsPhoneNumber` | ```String``` | _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER | | +| `smsPhoneNumberType` | [```SmsPhoneNumberTypeEnum```](#SmsPhoneNumberTypeEnum) | _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | diff --git a/sdks/java-v2/docs/SubSigningOptions.md b/sdks/java-v2/docs/SubSigningOptions.md index bca116053..d56c23080 100644 --- a/sdks/java-v2/docs/SubSigningOptions.md +++ b/sdks/java-v2/docs/SubSigningOptions.md @@ -2,19 +2,17 @@ # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. - -**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +_t__Sub::SigningOptions::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `defaultType`*_required_ | [```DefaultTypeEnum```](#DefaultTypeEnum) | The default type shown (limited to the listed types) | | -| `draw` | ```Boolean``` | Allows drawing the signature | | -| `phone` | ```Boolean``` | Allows using a smartphone to email the signature | | -| `type` | ```Boolean``` | Allows typing the signature | | -| `upload` | ```Boolean``` | Allows uploading the signature | | +| `defaultType`*_required_ | [```DefaultTypeEnum```](#DefaultTypeEnum) | _t__Sub::SigningOptions::DEFAULT | | +| `draw` | ```Boolean``` | _t__Sub::SigningOptions::DRAW | | +| `phone` | ```Boolean``` | _t__Sub::SigningOptions::PHONE | | +| `type` | ```Boolean``` | _t__Sub::SigningOptions::TYPE | | +| `upload` | ```Boolean``` | _t__Sub::SigningOptions::UPLOAD | | diff --git a/sdks/java-v2/docs/SubTeamResponse.md b/sdks/java-v2/docs/SubTeamResponse.md index df784d080..d7c49781d 100644 --- a/sdks/java-v2/docs/SubTeamResponse.md +++ b/sdks/java-v2/docs/SubTeamResponse.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `teamId` | ```String``` | The id of a team | | -| `name` | ```String``` | The name of a team | | +| `teamId` | ```String``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```String``` | _t__TeamGeneral::NAME | | diff --git a/sdks/java-v2/docs/SubTemplateRole.md b/sdks/java-v2/docs/SubTemplateRole.md index a1ee8e0ea..b044c491e 100644 --- a/sdks/java-v2/docs/SubTemplateRole.md +++ b/sdks/java-v2/docs/SubTemplateRole.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | -| `order` | ```Integer``` | The order in which this signer role is required to sign. | | +| `name` | ```String``` | _t__Sub::SignerRole::NAME | | +| `order` | ```Integer``` | _t__Sub::SignerRole::ORDER | | diff --git a/sdks/java-v2/docs/SubUnclaimedDraftSigner.md b/sdks/java-v2/docs/SubUnclaimedDraftSigner.md index fec680ac2..9c8d742e4 100644 --- a/sdks/java-v2/docs/SubUnclaimedDraftSigner.md +++ b/sdks/java-v2/docs/SubUnclaimedDraftSigner.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `emailAddress`*_required_ | ```String``` | The email address of the signer. | | -| `name`*_required_ | ```String``` | The name of the signer. | | -| `order` | ```Integer``` | The order the signer is required to sign in. | | +| `emailAddress`*_required_ | ```String``` | _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS | | +| `name`*_required_ | ```String``` | _t__Sub::UnclaimedDraftSigner::NAME | | +| `order` | ```Integer``` | _t__Sub::UnclaimedDraftSigner::ORDER | | diff --git a/sdks/java-v2/docs/SubUnclaimedDraftTemplateSigner.md b/sdks/java-v2/docs/SubUnclaimedDraftTemplateSigner.md index 1c6547670..8dcf716f0 100644 --- a/sdks/java-v2/docs/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/java-v2/docs/SubUnclaimedDraftTemplateSigner.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `role`*_required_ | ```String``` | Must match an existing role in chosen Template(s). | | -| `name`*_required_ | ```String``` | The name of the signer filling the role of `role`. | | -| `emailAddress`*_required_ | ```String``` | The email address of the signer filling the role of `role`. | | +| `role`*_required_ | ```String``` | _t__Sub::UnclaimedDraftTemplateSigner::ROLE | | +| `name`*_required_ | ```String``` | _t__Sub::UnclaimedDraftTemplateSigner::NAME | | +| `emailAddress`*_required_ | ```String``` | _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS | | diff --git a/sdks/java-v2/docs/SubWhiteLabelingOptions.md b/sdks/java-v2/docs/SubWhiteLabelingOptions.md index 0a5880da3..fb9827b53 100644 --- a/sdks/java-v2/docs/SubWhiteLabelingOptions.md +++ b/sdks/java-v2/docs/SubWhiteLabelingOptions.md @@ -2,9 +2,7 @@ # SubWhiteLabelingOptions -An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) - -Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. +_t__Sub::WhiteLabelingOptions::DESCRIPTION ## Properties @@ -24,7 +22,7 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r | `secondaryButtonTextColorHover` | ```String``` | | | | `textColor1` | ```String``` | | | | `textColor2` | ```String``` | | | -| `resetToDefault` | ```Boolean``` | Resets white labeling options to defaults. Only useful when updating an API App. | | +| `resetToDefault` | ```Boolean``` | _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT | | diff --git a/sdks/java-v2/docs/TeamGetInfoResponse.md b/sdks/java-v2/docs/TeamGetInfoResponse.md index 1d2bc62a7..e660412f6 100644 --- a/sdks/java-v2/docs/TeamGetInfoResponse.md +++ b/sdks/java-v2/docs/TeamGetInfoResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `team`*_required_ | [```TeamInfoResponse```](TeamInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/TeamGetResponse.md b/sdks/java-v2/docs/TeamGetResponse.md index 690796e1f..4da0b2998 100644 --- a/sdks/java-v2/docs/TeamGetResponse.md +++ b/sdks/java-v2/docs/TeamGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `team`*_required_ | [```TeamResponse```](TeamResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/TeamInfoResponse.md b/sdks/java-v2/docs/TeamInfoResponse.md index a776d4e09..180fac535 100644 --- a/sdks/java-v2/docs/TeamInfoResponse.md +++ b/sdks/java-v2/docs/TeamInfoResponse.md @@ -8,11 +8,11 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `teamId` | ```String``` | The id of a team | | +| `teamId` | ```String``` | _t__TeamGeneral::TEAM_ID | | | `teamParent` | [```TeamParentResponse```](TeamParentResponse.md) | | | -| `name` | ```String``` | The name of a team | | -| `numMembers` | ```Integer``` | Number of members within a team | | -| `numSubTeams` | ```Integer``` | Number of sub teams within a team | | +| `name` | ```String``` | _t__TeamGeneral::NAME | | +| `numMembers` | ```Integer``` | _t__TeamGeneral::NUM_MEMBERS | | +| `numSubTeams` | ```Integer``` | _t__TeamGeneral::NUM_SUB_TEAMS | | diff --git a/sdks/java-v2/docs/TeamParentResponse.md b/sdks/java-v2/docs/TeamParentResponse.md index c6ba18a98..b07d49809 100644 --- a/sdks/java-v2/docs/TeamParentResponse.md +++ b/sdks/java-v2/docs/TeamParentResponse.md @@ -8,8 +8,8 @@ Information about the parent team if a team has one, set to `null` otherwise. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `teamId` | ```String``` | The id of a team | | -| `name` | ```String``` | The name of a team | | +| `teamId` | ```String``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```String``` | _t__TeamGeneral::NAME | | diff --git a/sdks/java-v2/docs/TeamResponse.md b/sdks/java-v2/docs/TeamResponse.md index ca6344cfc..705bf01a8 100644 --- a/sdks/java-v2/docs/TeamResponse.md +++ b/sdks/java-v2/docs/TeamResponse.md @@ -2,16 +2,16 @@ # TeamResponse -Contains information about your team and its members +_t__TeamResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of your Team | | +| `name` | ```String``` | _t__Team::NAME | | | `accounts` | [```List```](AccountResponse.md) | | | -| `invitedAccounts` | [```List```](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`. | | -| `invitedEmails` | ```List``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `invitedAccounts` | [```List```](AccountResponse.md) | _t__Team::INVITED_ACCOUNTS | | +| `invitedEmails` | ```List``` | _t__Team::INVITED_EMAILS | | diff --git a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md index 05f2497fc..5d858ca9c 100644 --- a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md @@ -13,7 +13,8 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -24,7 +25,7 @@ | `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `mergeFields` | [```List```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```String``` | The default template email message. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `showPreview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | | `signerRoles` | [```List```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | diff --git a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponse.md b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponse.md index f25b48d33..c5d3e8c08 100644 --- a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `template`*_required_ | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 770cce434..2ad1028bb 100644 --- a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -2,16 +2,16 @@ # TemplateCreateEmbeddedDraftResponseTemplate -Template object with parameters: `template_id`, `edit_url`, `expires_at`. +_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `editUrl` | ```String``` | Link to edit the template. | | -| `expiresAt` | ```Integer``` | When the link expires. | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `templateId` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | +| `editUrl` | ```String``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL | | +| `expiresAt` | ```Integer``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/TemplateCreateRequest.md b/sdks/java-v2/docs/TemplateCreateRequest.md index 5f99510d9..c3d23ba82 100644 --- a/sdks/java-v2/docs/TemplateCreateRequest.md +++ b/sdks/java-v2/docs/TemplateCreateRequest.md @@ -13,7 +13,8 @@ | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `clientId` | ```String``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -21,7 +22,7 @@ | `formFieldRules` | [```List```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | | `mergeFields` | [```List```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```String``` | The default template email message. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `subject` | ```String``` | The template title (alias). | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | diff --git a/sdks/java-v2/docs/TemplateCreateResponse.md b/sdks/java-v2/docs/TemplateCreateResponse.md index 3c7389668..aa00f2dd0 100644 --- a/sdks/java-v2/docs/TemplateCreateResponse.md +++ b/sdks/java-v2/docs/TemplateCreateResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `template`*_required_ | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/TemplateCreateResponseTemplate.md b/sdks/java-v2/docs/TemplateCreateResponseTemplate.md index 1dcd4bd79..e250fdad4 100644 --- a/sdks/java-v2/docs/TemplateCreateResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateCreateResponseTemplate.md @@ -2,13 +2,13 @@ # TemplateCreateResponseTemplate -Template object with parameters: `template_id`. +_t__TemplateCreateResponseTemplate::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | diff --git a/sdks/java-v2/docs/TemplateEditResponse.md b/sdks/java-v2/docs/TemplateEditResponse.md index 88d225e68..78ec32e72 100644 --- a/sdks/java-v2/docs/TemplateEditResponse.md +++ b/sdks/java-v2/docs/TemplateEditResponse.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | diff --git a/sdks/java-v2/docs/TemplateGetResponse.md b/sdks/java-v2/docs/TemplateGetResponse.md index 2ee4867f0..ba33f5dd3 100644 --- a/sdks/java-v2/docs/TemplateGetResponse.md +++ b/sdks/java-v2/docs/TemplateGetResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `template`*_required_ | [```TemplateResponse```](TemplateResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/TemplateListResponse.md b/sdks/java-v2/docs/TemplateListResponse.md index 92b720c58..46d8c5a8b 100644 --- a/sdks/java-v2/docs/TemplateListResponse.md +++ b/sdks/java-v2/docs/TemplateListResponse.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templates`*_required_ | [```List```](TemplateResponse.md) | List of templates that the API caller has access to. | | +| `templates`*_required_ | [```List```](TemplateResponse.md) | _t__TemplateListResponse::DESCRIPTION | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/TemplateResponse.md b/sdks/java-v2/docs/TemplateResponse.md index 40de0fdc8..d39e3205d 100644 --- a/sdks/java-v2/docs/TemplateResponse.md +++ b/sdks/java-v2/docs/TemplateResponse.md @@ -2,28 +2,28 @@ # TemplateResponse -Contains information about the templates you and your team have created. +_t__TemplateResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `updatedAt` | ```Integer``` | Time the template was last updated. | | -| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | -| `isCreator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```Map``` | The metadata attached to the template. | | -| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `templateId` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | +| `title` | ```String``` | _t__TemplateResponse::TITLE | | +| `message` | ```String``` | _t__TemplateResponse::MESSAGE | | +| `updatedAt` | ```Integer``` | _t__TemplateResponse::UPDATED_AT | | +| `isEmbedded` | ```Boolean``` | _t__TemplateResponse::IS_EMBEDDED | | +| `isCreator` | ```Boolean``` | _t__TemplateResponse::IS_CREATOR | | +| `canEdit` | ```Boolean``` | _t__TemplateResponse::CAN_EDIT | | +| `isLocked` | ```Boolean``` | _t__TemplateResponse::IS_LOCKED | | +| `metadata` | ```Map``` | _t__TemplateResponse::METADATA | | +| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | _t__TemplateResponse::SIGNER_ROLES | | +| `ccRoles` | [```List```](TemplateResponseCCRole.md) | _t__TemplateResponse::CC_ROLES | | +| `documents` | [```List```](TemplateResponseDocument.md) | _t__TemplateResponse::DOCUMENTS | | +| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseCustomField::DESCRIPTION | | +| `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseNamedFormField::DESCRIPTION | | +| `accounts` | [```List```](TemplateResponseAccount.md) | _t__TemplateResponse::ACCOUNTS | | +| `attachments` | [```List```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | diff --git a/sdks/java-v2/docs/TemplateResponseAccount.md b/sdks/java-v2/docs/TemplateResponseAccount.md index 10c996408..d0902baf0 100644 --- a/sdks/java-v2/docs/TemplateResponseAccount.md +++ b/sdks/java-v2/docs/TemplateResponseAccount.md @@ -8,11 +8,11 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The id of the Account. | | -| `emailAddress` | ```String``` | The email address associated with the Account. | | -| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `accountId` | ```String``` | _t__TemplateResponseAccount::ACCOUNT_ID | | +| `emailAddress` | ```String``` | _t__TemplateResponseAccount::EMAIL_ADDRESS | | +| `isLocked` | ```Boolean``` | _t__TemplateResponseAccount::IS_LOCKED | | +| `isPaidHs` | ```Boolean``` | _t__TemplateResponseAccount::IS_PAID_HS | | +| `isPaidHf` | ```Boolean``` | _t__TemplateResponseAccount::IS_PAID_HF | | | `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/java-v2/docs/TemplateResponseAccountQuota.md b/sdks/java-v2/docs/TemplateResponseAccountQuota.md index ad94c2493..004f4d445 100644 --- a/sdks/java-v2/docs/TemplateResponseAccountQuota.md +++ b/sdks/java-v2/docs/TemplateResponseAccountQuota.md @@ -2,16 +2,16 @@ # TemplateResponseAccountQuota -An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. +_t__TemplateResponseAccountQuota::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `templatesLeft` | ```Integer``` | _t__TemplateResponseAccountQuota::TEMPLATES_LEFT | | +| `apiSignatureRequestsLeft` | ```Integer``` | _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documentsLeft` | ```Integer``` | _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT | | +| `smsVerificationsLeft` | ```Integer``` | _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT | | diff --git a/sdks/java-v2/docs/TemplateResponseCCRole.md b/sdks/java-v2/docs/TemplateResponseCCRole.md index 64069b826..b6877bd2f 100644 --- a/sdks/java-v2/docs/TemplateResponseCCRole.md +++ b/sdks/java-v2/docs/TemplateResponseCCRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name` | ```String``` | _t__TemplateResponseCCRole::NAME | | diff --git a/sdks/java-v2/docs/TemplateResponseDocument.md b/sdks/java-v2/docs/TemplateResponseDocument.md index 65da85d42..aaba331c1 100644 --- a/sdks/java-v2/docs/TemplateResponseDocument.md +++ b/sdks/java-v2/docs/TemplateResponseDocument.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | Name of the associated file. | | -| `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```String``` | _t__TemplateResponseDocument::NAME | | +| `index` | ```Integer``` | _t__TemplateResponseDocument::INDEX | | +| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | _t__TemplateResponseDocument::FIELD_GROUPS | | +| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseDocumentFormField::DESCRIPTION | | +| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseDocumentCustomField::DESCRIPTION | | +| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | _t__TemplateResponseDocumentStaticField::DESCRIPTION | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md index edd461727..a1223c732 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md @@ -2,22 +2,22 @@ # TemplateResponseDocumentCustomFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentCustomField::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | The unique ID for this field. | | -| `name` | ```String``` | The name of the Custom Field. | | -| `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `apiId` | ```String``` | _t__TemplateResponseDocumentCustomField::API_ID | | +| `name` | ```String``` | _t__TemplateResponseDocumentCustomField::NAME | | +| `signer` | ```String``` | _t__TemplateResponseDocumentCustomField::SIGNER | | +| `x` | ```Integer``` | _t__TemplateResponseDocumentCustomField::X | | +| `y` | ```Integer``` | _t__TemplateResponseDocumentCustomField::Y | | +| `width` | ```Integer``` | _t__TemplateResponseDocumentCustomField::WIDTH | | +| `height` | ```Integer``` | _t__TemplateResponseDocumentCustomField::HEIGHT | | +| `required` | ```Boolean``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```String``` | _t__TemplateResponseDocumentCustomField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldCheckbox.md index dbde79072..bcfc582dc 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentCustomFieldCheckbox -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentCustomField::TYPE | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md index ccaf19394..d2b739477 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md @@ -2,17 +2,17 @@ # TemplateResponseDocumentCustomFieldText -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentCustomField::TYPE | | | `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `isMultiline` | ```Boolean``` | _t__TemplateResponseDocumentCustomField::IS_MULTILINE | | +| `originalFontSize` | ```Integer``` | _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE | | +| `fontFamily` | ```String``` | _t__TemplateResponseDocumentCustomField::FONT_FAMILY | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md index 03b5ffbb8..89d747b56 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the form field group. | | +| `name` | ```String``` | _t__TemplateResponseDocumentFieldGroup::NAME | | | `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md index e0f4dcc8a..35b004a51 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFieldGroupRule -The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). +_t__TemplateResponseDocumentFieldGroup::RULE ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `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. | | -| `groupLabel` | ```String``` | Name of the group | | +| `requirement` | ```String``` | _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT | | +| `groupLabel` | ```String``` | _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md index 6ff896074..f60b27372 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md @@ -2,21 +2,21 @@ # TemplateResponseDocumentFormFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentFormField::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the form field. | | -| `name` | ```String``` | The name of the form field. | | -| `signer` | ```String``` | The signer of the Form Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```String``` | _t__TemplateResponseDocumentFormField::API_ID | | +| `name` | ```String``` | _t__TemplateResponseDocumentFormField::NAME | | +| `signer` | ```String``` | _t__TemplateResponseDocumentFormField::SIGNER | | +| `x` | ```Integer``` | _t__TemplateResponseDocumentFormField::X | | +| `y` | ```Integer``` | _t__TemplateResponseDocumentFormField::Y | | +| `width` | ```Integer``` | _t__TemplateResponseDocumentFormField::WIDTH | | +| `height` | ```Integer``` | _t__TemplateResponseDocumentFormField::HEIGHT | | +| `required` | ```Boolean``` | _t__TemplateResponseDocumentFormField::REQUIRED | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md index a7f2cadeb..9fb0dd73c 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldCheckbox -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md index 09b45eec7..b01fca7b3 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldDateSigned -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md index 70e5da455..a8f21ddce 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldDropdown -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md index e8efcf2d7..dab6cd795 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -2,18 +2,18 @@ # TemplateResponseDocumentFormFieldHyperlink -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | | `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `isMultiline` | ```Boolean``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `originalFontSize` | ```Integer``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `fontFamily` | ```String``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md index f1fe1f5b5..2fe0bed3a 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldInitials -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md index 877b842a2..0d829e2d1 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldRadio -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group`*_required_ | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md index 366aaa9b4..a147b1b1b 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md @@ -2,14 +2,14 @@ # TemplateResponseDocumentFormFieldSignature -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md index 1b8d78c02..ec7ead57c 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md @@ -2,21 +2,21 @@ # TemplateResponseDocumentFormFieldText -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | | | `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | -| `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | -| `validationCustomRegex` | ```String``` | When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. | | -| `validationCustomRegexFormatLabel` | ```String``` | When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `isMultiline` | ```Boolean``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `originalFontSize` | ```Integer``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `fontFamily` | ```String``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | _t__TemplateResponseDocumentFormField::VALIDATION_TYPE | | +| `validationCustomRegex` | ```String``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX | | +| `validationCustomRegexFormatLabel` | ```String``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md index 4be3cf070..997cd89df 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md @@ -2,22 +2,22 @@ # TemplateResponseDocumentStaticFieldBase -An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. +_t__TemplateResponseDocumentStaticField::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the static field. | | -| `name` | ```String``` | The name of the static field. | | -| `signer` | ```String``` | The signer of the Static Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width` | ```Integer``` | The width in pixels of this static field. | | -| `height` | ```Integer``` | The height in pixels of this static field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `apiId` | ```String``` | _t__TemplateResponseDocumentStaticField::API_ID | | +| `name` | ```String``` | _t__TemplateResponseDocumentStaticField::NAME | | +| `signer` | ```String``` | _t__TemplateResponseDocumentStaticField::SIGNER | | +| `x` | ```Integer``` | _t__TemplateResponseDocumentStaticField::X | | +| `y` | ```Integer``` | _t__TemplateResponseDocumentStaticField::Y | | +| `width` | ```Integer``` | _t__TemplateResponseDocumentStaticField::WIDTH | | +| `height` | ```Integer``` | _t__TemplateResponseDocumentStaticField::HEIGHT | | +| `required` | ```Boolean``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```String``` | _t__TemplateResponseDocumentStaticField::GROUP | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldCheckbox.md index 6cd94853c..f785f8900 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldCheckbox -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldDateSigned.md index d5c530d8b..5d9892ab9 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldDateSigned -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldDropdown.md index 53505315e..5ca87bec6 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldDropdown -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldHyperlink.md index 930658b69..96ff48da6 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldHyperlink -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldInitials.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldInitials.md index 67d755703..eef06958a 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldInitials -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldRadio.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldRadio.md index ed32ccca6..448311ded 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldRadio -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldSignature.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldSignature.md index 61f8902f8..4f236bb2e 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldSignature -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldText.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldText.md index 3dced017f..f8bf833e2 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldText.md @@ -2,13 +2,13 @@ # TemplateResponseDocumentStaticFieldText -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | | diff --git a/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md b/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md index bb66f3057..e635f1f80 100644 --- a/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md @@ -2,14 +2,14 @@ # TemplateResponseFieldAvgTextLength -Average text length in this field. +_t__TemplateResponseFieldAvgTextLength::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numLines` | ```Integer``` | Number of lines. | | -| `numCharsPerLine` | ```Integer``` | Number of characters per line. | | +| `numLines` | ```Integer``` | _t__TemplateResponseFieldAvgTextLength::NUM_LINES | | +| `numCharsPerLine` | ```Integer``` | _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE | | diff --git a/sdks/java-v2/docs/TemplateResponseSignerRole.md b/sdks/java-v2/docs/TemplateResponseSignerRole.md index 15b48cf17..0d4511692 100644 --- a/sdks/java-v2/docs/TemplateResponseSignerRole.md +++ b/sdks/java-v2/docs/TemplateResponseSignerRole.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | -| `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | +| `name` | ```String``` | _t__TemplateResponseSignerRole::NAME | | +| `order` | ```Integer``` | _t__TemplateResponseSignerRole::ORDER | | diff --git a/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md index 6289a9953..f0ce385d0 100644 --- a/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md @@ -2,14 +2,14 @@ # TemplateUpdateFilesResponseTemplate -Contains template id +_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `templateId` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md index aab362d77..94cce4729 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -14,8 +14,9 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -29,11 +30,11 @@ | `holdRequest` | ```Boolean``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | | | `isForEmbeddedSigning` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `requestingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully request a signature. | | | `showPreview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | -| `signers` | [```List```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```List```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `skipMeNow` | ```Boolean``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index 03ad8b9e5..151ff8c52 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -24,12 +24,12 @@ | `holdRequest` | ```Boolean``` | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | | | `isForEmbeddedSigning` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `previewOnly` | ```Boolean``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | | | `requestingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully request a signature. | | | `showPreview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | -| `signers` | [```List```](SubUnclaimedDraftTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers` | [```List```](SubUnclaimedDraftTemplateSigner.md) | _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `skipMeNow` | ```Boolean``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md b/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md index f23c6f4ba..9f1249ca4 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md @@ -12,7 +12,8 @@ | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `attachments` | [```List```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -22,9 +23,9 @@ | `formFieldsPerDocument` | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hideTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Map``` | _t__Sub::Metadata::DESCRIPTION | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | -| `signers` | [```List```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```List```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateResponse.md b/sdks/java-v2/docs/UnclaimedDraftCreateResponse.md index d2d3a7c4a..b27b2529d 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateResponse.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateResponse.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `unclaimedDraft`*_required_ | [```UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | -| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/java-v2/docs/UnclaimedDraftResponse.md b/sdks/java-v2/docs/UnclaimedDraftResponse.md index ab470a27d..15d49b3c2 100644 --- a/sdks/java-v2/docs/UnclaimedDraftResponse.md +++ b/sdks/java-v2/docs/UnclaimedDraftResponse.md @@ -2,18 +2,18 @@ # UnclaimedDraftResponse -A group of documents that a user can take ownership of via the claim URL. +_t__UnclaimedDraftResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `signatureRequestId` | ```String``` | The ID of the signature request that is represented by this UnclaimedDraft. | | -| `claimUrl` | ```String``` | The URL to be used to claim this UnclaimedDraft. | | -| `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | -| `requestingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). | | -| `expiresAt` | ```Integer``` | When the link expires. | | -| `testMode` | ```Boolean``` | Whether this is a test draft. Signature requests made from test drafts have no legal value. | | +| `signatureRequestId` | ```String``` | _t__UnclaimedDraft::SIGNATURE_REQUEST_ID | | +| `claimUrl` | ```String``` | _t__UnclaimedDraft::CLAIM_URL | | +| `signingRedirectUrl` | ```String``` | _t__UnclaimedDraft::SIGNING_REDIRECT_URL | | +| `requestingRedirectUrl` | ```String``` | _t__UnclaimedDraft::REQUESTING_REDIRECT_URL | | +| `expiresAt` | ```Integer``` | _t__UnclaimedDraft::EXPIRES_AT | | +| `testMode` | ```Boolean``` | _t__UnclaimedDraft::TEST_MODE | | diff --git a/sdks/java-v2/docs/WarningResponse.md b/sdks/java-v2/docs/WarningResponse.md index 50cad9b58..88ab0c964 100644 --- a/sdks/java-v2/docs/WarningResponse.md +++ b/sdks/java-v2/docs/WarningResponse.md @@ -2,14 +2,14 @@ # WarningResponse -A list of warnings. +_t__WarningResponse::LIST_DESCRIPTION ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `warningMsg`*_required_ | ```String``` | Warning message | | -| `warningName`*_required_ | ```String``` | Warning name | | +| `warningMsg`*_required_ | ```String``` | _t__WarningResponse::WARNING_MSG | | +| `warningName`*_required_ | ```String``` | _t__WarningResponse::WARNING_NAME | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java index 00240b91d..a16e07d4f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java @@ -139,7 +139,7 @@ public AccountCreateResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountGetResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountGetResponse.java index a37a29e3e..02e195dd1 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountGetResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountGetResponse.java @@ -108,7 +108,7 @@ public AccountGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java index e7140787d..2b1846e2c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponse.java @@ -118,7 +118,7 @@ public AccountResponse accountId(@jakarta.annotation.Nullable String accountId) } /** - * The ID of the Account + * _t__Account::ACCOUNT_ID * @return accountId */ @jakarta.annotation.Nullable @@ -143,7 +143,7 @@ public AccountResponse emailAddress(@jakarta.annotation.Nullable String emailAdd } /** - * The email address associated with the Account. + * _t__Account::EMAIL_ADDRESS * @return emailAddress */ @jakarta.annotation.Nullable @@ -168,7 +168,7 @@ public AccountResponse isLocked(@jakarta.annotation.Nullable Boolean isLocked) { } /** - * Returns `true` if the user has been locked out of their account by a team admin. + * _t__Account::IS_LOCKED * @return isLocked */ @jakarta.annotation.Nullable @@ -193,7 +193,7 @@ public AccountResponse isPaidHs(@jakarta.annotation.Nullable Boolean isPaidHs) { } /** - * Returns `true` if the user has a paid Dropbox Sign account. + * _t__Account::IS_PAID_HS * @return isPaidHs */ @jakarta.annotation.Nullable @@ -218,7 +218,7 @@ public AccountResponse isPaidHf(@jakarta.annotation.Nullable Boolean isPaidHf) { } /** - * Returns `true` if the user has a paid HelloFax account. + * _t__Account::IS_PAID_HF * @return isPaidHf */ @jakarta.annotation.Nullable @@ -268,7 +268,7 @@ public AccountResponse callbackUrl(@jakarta.annotation.Nullable String callbackU } /** - * The URL that Dropbox Sign events will `POST` to. + * _t__Account::CALLBACK_URL * @return callbackUrl */ @jakarta.annotation.Nullable @@ -293,7 +293,7 @@ public AccountResponse roleCode(@jakarta.annotation.Nullable String roleCode) { } /** - * The membership role for the team. + * _t__Account::ROLE_CODE * @return roleCode */ @jakarta.annotation.Nullable @@ -318,7 +318,7 @@ public AccountResponse teamId(@jakarta.annotation.Nullable String teamId) { } /** - * The id of the team account belongs to. + * _t__Account::TEAM_ID * @return teamId */ @jakarta.annotation.Nullable @@ -343,7 +343,7 @@ public AccountResponse locale(@jakarta.annotation.Nullable String locale) { } /** - * 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. + * _t__Account::LOCALE * @return locale */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java index e1bf4a87e..7bb24393d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Details concerning remaining monthly quotas. + * _t__Account::QUOTA */ @JsonPropertyOrder({ AccountResponseQuotas.JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT, @@ -91,7 +91,7 @@ public AccountResponseQuotas apiSignatureRequestsLeft(@jakarta.annotation.Nullab } /** - * API signature requests remaining. + * _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT * @return apiSignatureRequestsLeft */ @jakarta.annotation.Nullable @@ -116,7 +116,7 @@ public AccountResponseQuotas documentsLeft(@jakarta.annotation.Nullable Integer } /** - * Signature requests remaining. + * _t__AccountQuota::DOCUMENTS_LEFT * @return documentsLeft */ @jakarta.annotation.Nullable @@ -141,7 +141,7 @@ public AccountResponseQuotas templatesTotal(@jakarta.annotation.Nullable Integer } /** - * Total API templates allowed. + * _t__AccountQuota::TEMPLATES_TOTAL * @return templatesTotal */ @jakarta.annotation.Nullable @@ -166,7 +166,7 @@ public AccountResponseQuotas templatesLeft(@jakarta.annotation.Nullable Integer } /** - * API templates remaining. + * _t__AccountQuota::TEMPLATES_LEFT * @return templatesLeft */ @jakarta.annotation.Nullable @@ -191,7 +191,7 @@ public AccountResponseQuotas smsVerificationsLeft(@jakarta.annotation.Nullable I } /** - * SMS verifications remaining. + * _t__AccountQuota::SMS_VERIFICATIONS_LEFT * @return smsVerificationsLeft */ @jakarta.annotation.Nullable @@ -216,7 +216,7 @@ public AccountResponseQuotas numFaxPagesLeft(@jakarta.annotation.Nullable Intege } /** - * Number of fax pages left + * _t__AccountQuota::NUM_FAX_PAGES_LEFT * @return numFaxPagesLeft */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java index 32ba98cf1..bf3cd6c15 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Details concerning monthly usage + * _t__Account::USAGE */ @JsonPropertyOrder({ AccountResponseUsage.JSON_PROPERTY_FAX_PAGES_SENT @@ -66,7 +66,7 @@ public AccountResponseUsage faxPagesSent(@jakarta.annotation.Nullable Integer fa } /** - * Number of fax pages sent + * _t__AccountUsage::FAX_PAGES_SENT * @return faxPagesSent */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java index 971d4f67e..1ffb6894a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java @@ -108,7 +108,7 @@ public AccountVerifyResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java index 932c5be5b..cb2f6d230 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java @@ -66,7 +66,7 @@ public AccountVerifyResponseAccount emailAddress(@jakarta.annotation.Nullable St } /** - * The email address associated with the Account. + * _t__Account::EMAIL_ADDRESS * @return emailAddress */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java index 887067a0e..1bf1dea81 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java @@ -108,7 +108,7 @@ public ApiAppGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java index eca7bbdc7..67ba47f6a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java @@ -89,7 +89,7 @@ public ApiAppListResponse addApiAppsItem(ApiAppResponse apiAppsItem) { } /** - * Contains information about API Apps. + * _t__ApiAppListResponse::DESCRIPTION * @return apiApps */ @jakarta.annotation.Nonnull @@ -147,7 +147,7 @@ public ApiAppListResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java index 6bd39a59c..a1d61843c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponse.java @@ -36,7 +36,7 @@ import com.dropbox.sign.ApiException; /** - * Contains information about an API App. + * _t__ApiAppResponse::DESCRIPTION */ @JsonPropertyOrder({ ApiAppResponse.JSON_PROPERTY_CALLBACK_URL, @@ -117,7 +117,7 @@ public ApiAppResponse callbackUrl(@jakarta.annotation.Nullable String callbackUr } /** - * The app's callback URL (for events) + * _t__ApiAppResponse::CALLBACK_URL * @return callbackUrl */ @jakarta.annotation.Nullable @@ -142,7 +142,7 @@ public ApiAppResponse clientId(@jakarta.annotation.Nullable String clientId) { } /** - * The app's client id + * _t__ApiAppResponse::CLIENT_ID * @return clientId */ @jakarta.annotation.Nullable @@ -167,7 +167,7 @@ public ApiAppResponse createdAt(@jakarta.annotation.Nullable Integer createdAt) } /** - * The time that the app was created + * _t__ApiAppResponse::CREATED_AT * @return createdAt */ @jakarta.annotation.Nullable @@ -200,7 +200,7 @@ public ApiAppResponse addDomainsItem(String domainsItem) { } /** - * The domain name(s) associated with the app + * _t__ApiAppResponse::DOMAINS * @return domains */ @jakarta.annotation.Nullable @@ -225,7 +225,7 @@ public ApiAppResponse name(@jakarta.annotation.Nullable String name) { } /** - * The name of the app + * _t__ApiAppResponse::NAME * @return name */ @jakarta.annotation.Nullable @@ -250,7 +250,7 @@ public ApiAppResponse isApproved(@jakarta.annotation.Nullable Boolean isApproved } /** - * Boolean to indicate if the app has been approved + * _t__ApiAppResponse::IS_APPROVED * @return isApproved */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java index 6ae38fc51..b2d5e480c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java @@ -32,7 +32,7 @@ import com.dropbox.sign.ApiException; /** - * An object describing the app's OAuth properties, or null if OAuth is not configured for the app. + * _t__ApiAppResponseOAuth::DESCRIPTION */ @JsonPropertyOrder({ ApiAppResponseOAuth.JSON_PROPERTY_CALLBACK_URL, @@ -83,7 +83,7 @@ public ApiAppResponseOAuth callbackUrl(@jakarta.annotation.Nullable String callb } /** - * The app's OAuth callback URL. + * _t__ApiAppResponseOAuth::CALLBACK_URL * @return callbackUrl */ @jakarta.annotation.Nullable @@ -108,7 +108,7 @@ public ApiAppResponseOAuth secret(@jakarta.annotation.Nullable String secret) { } /** - * The app's OAuth secret, or null if the app does not belong to user. + * _t__ApiAppResponseOAuth::SECRET * @return secret */ @jakarta.annotation.Nullable @@ -141,7 +141,7 @@ public ApiAppResponseOAuth addScopesItem(String scopesItem) { } /** - * Array of OAuth scopes used by the app. + * _t__ApiAppResponseOAuth::SCOPES * @return scopes */ @jakarta.annotation.Nullable @@ -166,7 +166,7 @@ public ApiAppResponseOAuth chargesUsers(@jakarta.annotation.Nullable Boolean cha } /** - * Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. + * _t__ApiAppResponseOAuth::CHARGES_USERS * @return chargesUsers */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java index 1a9c91d76..7aa02f30d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * An object with options that override account settings. + * _t__ApiAppResponseOptions::DESCRIPTION */ @JsonPropertyOrder({ ApiAppResponseOptions.JSON_PROPERTY_CAN_INSERT_EVERYWHERE @@ -66,7 +66,7 @@ public ApiAppResponseOptions canInsertEverywhere(@jakarta.annotation.Nullable Bo } /** - * Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document + * _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE * @return canInsertEverywhere */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java index 7149d8edd..1059db702 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * An object describing the app's owner + * _t__ApiAppResponseOwnerAccount::DESCRIPTION */ @JsonPropertyOrder({ ApiAppResponseOwnerAccount.JSON_PROPERTY_ACCOUNT_ID, @@ -71,7 +71,7 @@ public ApiAppResponseOwnerAccount accountId(@jakarta.annotation.Nullable String } /** - * The owner account's ID + * _t__ApiAppResponseOwnerAccount::ACCOUNT_ID * @return accountId */ @jakarta.annotation.Nullable @@ -96,7 +96,7 @@ public ApiAppResponseOwnerAccount emailAddress(@jakarta.annotation.Nullable Stri } /** - * The owner account's email address + * _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS * @return emailAddress */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java index 2dd9a0018..56304beee 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * An object with options to customize the app's signer page + * _t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION */ @JsonPropertyOrder({ ApiAppResponseWhiteLabelingOptions.JSON_PROPERTY_HEADER_BACKGROUND_COLOR, diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java index 944191a53..6241a4cf1 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java @@ -145,7 +145,7 @@ public BulkSendJobGetResponse addSignatureRequestsItem(BulkSendJobGetResponseSig } /** - * Contains information about the Signature Requests sent in bulk. + * _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS * @return signatureRequests */ @jakarta.annotation.Nonnull @@ -178,7 +178,7 @@ public BulkSendJobGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java index 2e360bc7f..c55835464 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java @@ -194,7 +194,7 @@ public BulkSendJobGetResponseSignatureRequests testMode(@jakarta.annotation.Null } /** - * Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + * _t__SignatureRequestResponse::TEST_MODE * @return testMode */ @jakarta.annotation.Nullable @@ -219,7 +219,7 @@ public BulkSendJobGetResponseSignatureRequests signatureRequestId(@jakarta.annot } /** - * The id of the SignatureRequest. + * _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID * @return signatureRequestId */ @jakarta.annotation.Nullable @@ -244,7 +244,7 @@ public BulkSendJobGetResponseSignatureRequests requesterEmailAddress(@jakarta.an } /** - * The email address of the initiator of the SignatureRequest. + * _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS * @return requesterEmailAddress */ @jakarta.annotation.Nullable @@ -269,7 +269,7 @@ public BulkSendJobGetResponseSignatureRequests title(@jakarta.annotation.Nullabl } /** - * The title the specified Account uses for the SignatureRequest. + * _t__SignatureRequestResponse::TITLE * @return title */ @jakarta.annotation.Nullable @@ -294,7 +294,7 @@ public BulkSendJobGetResponseSignatureRequests originalTitle(@jakarta.annotation } /** - * Default Label for account. + * _t__SignatureRequestResponse::ORIGINAL_TITLE * @return originalTitle */ @jakarta.annotation.Nullable @@ -319,7 +319,7 @@ public BulkSendJobGetResponseSignatureRequests subject(@jakarta.annotation.Nulla } /** - * The subject in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::SUBJECT * @return subject */ @jakarta.annotation.Nullable @@ -344,7 +344,7 @@ public BulkSendJobGetResponseSignatureRequests message(@jakarta.annotation.Nulla } /** - * The custom message in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::MESSAGE * @return message */ @jakarta.annotation.Nullable @@ -377,7 +377,7 @@ public BulkSendJobGetResponseSignatureRequests putMetadataItem(String key, Objec } /** - * The metadata attached to the signature request. + * _t__SignatureRequestResponse::METADATA * @return metadata */ @jakarta.annotation.Nullable @@ -402,7 +402,7 @@ public BulkSendJobGetResponseSignatureRequests createdAt(@jakarta.annotation.Nul } /** - * Time the signature request was created. + * _t__SignatureRequestResponse::CREATED_AT * @return createdAt */ @jakarta.annotation.Nullable @@ -427,7 +427,7 @@ public BulkSendJobGetResponseSignatureRequests expiresAt(@jakarta.annotation.Nul } /** - * The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * _t__SignatureRequestResponse::EXPIRES_AT * @return expiresAt */ @jakarta.annotation.Nullable @@ -452,7 +452,7 @@ public BulkSendJobGetResponseSignatureRequests isComplete(@jakarta.annotation.Nu } /** - * Whether or not the SignatureRequest has been fully executed by all signers. + * _t__SignatureRequestResponse::IS_COMPLETE * @return isComplete */ @jakarta.annotation.Nullable @@ -477,7 +477,7 @@ public BulkSendJobGetResponseSignatureRequests isDeclined(@jakarta.annotation.Nu } /** - * Whether or not the SignatureRequest has been declined by a signer. + * _t__SignatureRequestResponse::IS_DECLINED * @return isDeclined */ @jakarta.annotation.Nullable @@ -502,7 +502,7 @@ public BulkSendJobGetResponseSignatureRequests hasError(@jakarta.annotation.Null } /** - * Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + * _t__SignatureRequestResponse::HAS_ERROR * @return hasError */ @jakarta.annotation.Nullable @@ -527,7 +527,7 @@ public BulkSendJobGetResponseSignatureRequests filesUrl(@jakarta.annotation.Null } /** - * The URL where a copy of the request's documents can be downloaded. + * _t__SignatureRequestResponse::FILES_URL * @return filesUrl */ @jakarta.annotation.Nullable @@ -552,7 +552,7 @@ public BulkSendJobGetResponseSignatureRequests signingUrl(@jakarta.annotation.Nu } /** - * The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + * _t__SignatureRequestResponse::SIGNING_URL * @return signingUrl */ @jakarta.annotation.Nullable @@ -577,7 +577,7 @@ public BulkSendJobGetResponseSignatureRequests detailsUrl(@jakarta.annotation.Nu } /** - * The URL where the requester and the signers can view the current status of the SignatureRequest. + * _t__SignatureRequestResponse::DETAILS_URL * @return detailsUrl */ @jakarta.annotation.Nullable @@ -610,7 +610,7 @@ public BulkSendJobGetResponseSignatureRequests addCcEmailAddressesItem(String cc } /** - * A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + * _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES * @return ccEmailAddresses */ @jakarta.annotation.Nullable @@ -635,7 +635,7 @@ public BulkSendJobGetResponseSignatureRequests signingRedirectUrl(@jakarta.annot } /** - * The URL you want the signer redirected to after they successfully sign. + * _t__SignatureRequestResponse::SIGNING_REDIRECT_URL * @return signingRedirectUrl */ @jakarta.annotation.Nullable @@ -660,7 +660,7 @@ public BulkSendJobGetResponseSignatureRequests finalCopyUri(@jakarta.annotation. } /** - * The path where the completed document can be downloaded + * _t__SignatureRequestResponse::FINAL_COPY_URI * @return finalCopyUri */ @jakarta.annotation.Nullable @@ -693,7 +693,7 @@ public BulkSendJobGetResponseSignatureRequests addTemplateIdsItem(String templat } /** - * Templates IDs used in this SignatureRequest (if any). + * _t__SignatureRequestResponse::TEMPLATE_IDS * @return templateIds */ @jakarta.annotation.Nullable @@ -726,7 +726,7 @@ public BulkSendJobGetResponseSignatureRequests addCustomFieldsItem(SignatureRequ } /** - * An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * _t__SignatureRequestResponseCustomField::DESCRIPTION * @return customFields */ @jakarta.annotation.Nullable @@ -759,7 +759,7 @@ public BulkSendJobGetResponseSignatureRequests addAttachmentsItem(SignatureReque } /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -792,7 +792,7 @@ public BulkSendJobGetResponseSignatureRequests addResponseDataItem(SignatureRequ } /** - * An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + * _t__SignatureRequestResponseData::DESCRIPTION * @return responseData */ @jakarta.annotation.Nullable @@ -825,7 +825,7 @@ public BulkSendJobGetResponseSignatureRequests addSignaturesItem(SignatureReques } /** - * An array of signature objects, 1 for each signer. + * _t__SignatureRequestResponseSignatures::DESCRIPTION * @return signatures */ @jakarta.annotation.Nullable @@ -850,7 +850,7 @@ public BulkSendJobGetResponseSignatureRequests bulkSendJobId(@jakarta.annotation } /** - * The id of the BulkSendJob. + * _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID * @return bulkSendJobId */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java index 93fd456cd..740452010 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java @@ -89,7 +89,7 @@ public BulkSendJobListResponse addBulkSendJobsItem(BulkSendJobResponse bulkSendJ } /** - * Contains a list of BulkSendJobs that the API caller has access to. + * _t__BulkSendJobListResponse::BULK_SEND_JOBS * @return bulkSendJobs */ @jakarta.annotation.Nonnull @@ -147,7 +147,7 @@ public BulkSendJobListResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java index f025c4f8f..095cd2c61 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. + * _t__BulkSendJobResponse::DESCRIPTION */ @JsonPropertyOrder({ BulkSendJobResponse.JSON_PROPERTY_BULK_SEND_JOB_ID, @@ -81,7 +81,7 @@ public BulkSendJobResponse bulkSendJobId(@jakarta.annotation.Nullable String bul } /** - * The id of the BulkSendJob. + * _t__BulkSendJobResponse::BULK_SEND_JOB_ID * @return bulkSendJobId */ @jakarta.annotation.Nullable @@ -106,7 +106,7 @@ public BulkSendJobResponse total(@jakarta.annotation.Nullable Integer total) { } /** - * The total amount of Signature Requests queued for sending. + * _t__BulkSendJobResponse::TOTAL * @return total */ @jakarta.annotation.Nullable @@ -131,7 +131,7 @@ public BulkSendJobResponse isCreator(@jakarta.annotation.Nullable Boolean isCrea } /** - * True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. + * _t__BulkSendJobResponse::IS_CREATOR * @return isCreator */ @jakarta.annotation.Nullable @@ -156,7 +156,7 @@ public BulkSendJobResponse createdAt(@jakarta.annotation.Nullable Integer create } /** - * Time that the BulkSendJob was created. + * _t__BulkSendJobResponse::CREATED_AT * @return createdAt */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java index 9f7095f39..a0c87432f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java @@ -108,7 +108,7 @@ public BulkSendJobSendResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java index 4ae9bf2ce..f5d961b6e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java @@ -38,6 +38,7 @@ */ @JsonPropertyOrder({ EmbeddedEditUrlRequest.JSON_PROPERTY_ALLOW_EDIT_CCS, + EmbeddedEditUrlRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, EmbeddedEditUrlRequest.JSON_PROPERTY_CC_ROLES, EmbeddedEditUrlRequest.JSON_PROPERTY_EDITOR_OPTIONS, EmbeddedEditUrlRequest.JSON_PROPERTY_FORCE_SIGNER_ROLES, @@ -55,6 +56,10 @@ public class EmbeddedEditUrlRequest { @jakarta.annotation.Nullable private Boolean allowEditCcs = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @jakarta.annotation.Nullable + private Boolean allowFormView = false; + public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; @jakarta.annotation.Nullable private List ccRoles = null; @@ -134,6 +139,31 @@ public void setAllowEditCcs(@jakarta.annotation.Nullable Boolean allowEditCcs) { } + public EmbeddedEditUrlRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @return allowFormView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowFormView() { + return allowFormView; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + + public EmbeddedEditUrlRequest ccRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; return this; @@ -388,6 +418,7 @@ public boolean equals(Object o) { } EmbeddedEditUrlRequest embeddedEditUrlRequest = (EmbeddedEditUrlRequest) o; return Objects.equals(this.allowEditCcs, embeddedEditUrlRequest.allowEditCcs) && + Objects.equals(this.allowFormView, embeddedEditUrlRequest.allowFormView) && Objects.equals(this.ccRoles, embeddedEditUrlRequest.ccRoles) && Objects.equals(this.editorOptions, embeddedEditUrlRequest.editorOptions) && Objects.equals(this.forceSignerRoles, embeddedEditUrlRequest.forceSignerRoles) && @@ -401,7 +432,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(allowEditCcs, ccRoles, editorOptions, forceSignerRoles, forceSubjectMessage, mergeFields, previewOnly, showPreview, showProgressStepper, testMode); + return Objects.hash(allowEditCcs, allowFormView, ccRoles, editorOptions, forceSignerRoles, forceSubjectMessage, mergeFields, previewOnly, showPreview, showProgressStepper, testMode); } @Override @@ -409,6 +440,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class EmbeddedEditUrlRequest {\n"); sb.append(" allowEditCcs: ").append(toIndentedString(allowEditCcs)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" editorOptions: ").append(toIndentedString(editorOptions)).append("\n"); sb.append(" forceSignerRoles: ").append(toIndentedString(forceSignerRoles)).append("\n"); @@ -445,6 +477,25 @@ public Map createFormData() throws ApiException { map.put("allow_edit_ccs", JSON.getDefault().getMapper().writeValueAsString(allowEditCcs)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) || + allowFormView.getClass().equals(Integer.class) || + allowFormView.getClass().equals(String.class) || + allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for(int i = 0; i< getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } + else { + map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (ccRoles != null) { if (isFileTypeOrListOfFiles(ccRoles)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java index 11c566adc..8f0fe5e6c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java @@ -108,7 +108,7 @@ public EmbeddedEditUrlResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java index 0518d5ee4..55a336cb3 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * An embedded template object. + * _t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION */ @JsonPropertyOrder({ EmbeddedEditUrlResponseEmbedded.JSON_PROPERTY_EDIT_URL, @@ -71,7 +71,7 @@ public EmbeddedEditUrlResponseEmbedded editUrl(@jakarta.annotation.Nullable Stri } /** - * A template url that can be opened in an iFrame. + * _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL * @return editUrl */ @jakarta.annotation.Nullable @@ -96,7 +96,7 @@ public EmbeddedEditUrlResponseEmbedded expiresAt(@jakarta.annotation.Nullable In } /** - * The specific time that the the `edit_url` link expires, in epoch. + * _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT * @return expiresAt */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java index 0ac9ccda5..384670547 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java @@ -108,7 +108,7 @@ public EmbeddedSignUrlResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java index c06bd3832..23d53003b 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * An object that contains necessary information to set up embedded signing. + * _t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION */ @JsonPropertyOrder({ EmbeddedSignUrlResponseEmbedded.JSON_PROPERTY_SIGN_URL, @@ -71,7 +71,7 @@ public EmbeddedSignUrlResponseEmbedded signUrl(@jakarta.annotation.Nullable Stri } /** - * A signature url that can be opened in an iFrame. + * _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL * @return signUrl */ @jakarta.annotation.Nullable @@ -96,7 +96,7 @@ public EmbeddedSignUrlResponseEmbedded expiresAt(@jakarta.annotation.Nullable In } /** - * The specific time that the the `sign_url` link expires, in epoch. + * _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT * @return expiresAt */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ErrorResponseError.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ErrorResponseError.java index af87ec4aa..ac702e43f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ErrorResponseError.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ErrorResponseError.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Contains information about an error that occurred. + * _t__ErrorResponseError::DESCRIPTION */ @JsonPropertyOrder({ ErrorResponseError.JSON_PROPERTY_ERROR_MSG, @@ -76,7 +76,7 @@ public ErrorResponseError errorMsg(@jakarta.annotation.Nonnull String errorMsg) } /** - * Message describing an error. + * _t__ErrorResponseError::ERROR_MSG * @return errorMsg */ @jakarta.annotation.Nonnull @@ -101,7 +101,7 @@ public ErrorResponseError errorName(@jakarta.annotation.Nonnull String errorName } /** - * Name of the error. + * _t__ErrorResponseError::ERROR_NAME * @return errorName */ @jakarta.annotation.Nonnull @@ -126,7 +126,7 @@ public ErrorResponseError errorPath(@jakarta.annotation.Nullable String errorPat } /** - * Path at which an error occurred. + * _t__ErrorResponseError::ERROR_PATH * @return errorPath */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java index 600430445..c8f8af6d0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java @@ -31,7 +31,7 @@ import com.dropbox.sign.ApiException; /** - * Basic information about the event that occurred. + * _t__EventCallbackRequestEvent::DESCRIPTION */ @JsonPropertyOrder({ EventCallbackRequestEvent.JSON_PROPERTY_EVENT_TIME, @@ -47,7 +47,7 @@ public class EventCallbackRequestEvent { private String eventTime; /** - * Type of callback event that was triggered. + * _t__EventCallbackRequestEvent::EVENT_TYPE */ public enum EventTypeEnum { ACCOUNT_CONFIRMED(String.valueOf("account_confirmed")), @@ -159,7 +159,7 @@ public EventCallbackRequestEvent eventTime(@jakarta.annotation.Nonnull String ev } /** - * Time the event was created (using Unix time). + * _t__EventCallbackRequestEvent::EVENT_TIME * @return eventTime */ @jakarta.annotation.Nonnull @@ -184,7 +184,7 @@ public EventCallbackRequestEvent eventType(@jakarta.annotation.Nonnull EventType } /** - * Type of callback event that was triggered. + * _t__EventCallbackRequestEvent::EVENT_TYPE * @return eventType */ @jakarta.annotation.Nonnull @@ -209,7 +209,7 @@ public EventCallbackRequestEvent eventHash(@jakarta.annotation.Nonnull String ev } /** - * Generated hash used to verify source of event data. + * _t__EventCallbackRequestEvent::EVENT_HASH * @return eventHash */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java index 70d002e3f..ca28a1472 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Specific metadata about the event. + * _t__EventCallbackRequestEventMetadata::DESCRIPTION */ @JsonPropertyOrder({ EventCallbackRequestEventMetadata.JSON_PROPERTY_RELATED_SIGNATURE_ID, @@ -81,7 +81,7 @@ public EventCallbackRequestEventMetadata relatedSignatureId(@jakarta.annotation. } /** - * Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. + * _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID * @return relatedSignatureId */ @jakarta.annotation.Nullable @@ -106,7 +106,7 @@ public EventCallbackRequestEventMetadata reportedForAccountId(@jakarta.annotatio } /** - * Account ID the event was reported for. + * _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID * @return reportedForAccountId */ @jakarta.annotation.Nullable @@ -131,7 +131,7 @@ public EventCallbackRequestEventMetadata reportedForAppId(@jakarta.annotation.Nu } /** - * App ID the event was reported for. + * _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID * @return reportedForAppId */ @jakarta.annotation.Nullable @@ -156,7 +156,7 @@ public EventCallbackRequestEventMetadata eventMessage(@jakarta.annotation.Nullab } /** - * Message about a declined or failed (due to error) signature flow. + * _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE * @return eventMessage */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxGetResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxGetResponse.java index 958f0880e..c17c7cec3 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxGetResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxGetResponse.java @@ -108,7 +108,7 @@ public FaxGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FileResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FileResponse.java index aa5f04e75..4969d0d4a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FileResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FileResponse.java @@ -71,7 +71,7 @@ public FileResponse fileUrl(@jakarta.annotation.Nonnull String fileUrl) { } /** - * URL to the file. + * _t__FileResponse::FILE_URL * @return fileUrl */ @jakarta.annotation.Nonnull @@ -96,7 +96,7 @@ public FileResponse expiresAt(@jakarta.annotation.Nonnull Integer expiresAt) { } /** - * When the link expires. + * _t__FileResponse::EXPIRES_AT * @return expiresAt */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java index fcabc19c9..c3e79865a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java @@ -66,7 +66,7 @@ public FileResponseDataUri dataUri(@jakarta.annotation.Nonnull String dataUri) { } /** - * File as base64 encoded string. + * _t__FileResponse::DATA_URI * @return dataUri */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ListInfoResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ListInfoResponse.java index c0709757a..a6e33ce7a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ListInfoResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ListInfoResponse.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Contains pagination information about the data returned. + * _t__ListInfoResponse::DESCRIPTION */ @JsonPropertyOrder({ ListInfoResponse.JSON_PROPERTY_NUM_PAGES, @@ -81,7 +81,7 @@ public ListInfoResponse numPages(@jakarta.annotation.Nullable Integer numPages) } /** - * Total number of pages available. + * _t__ListInfoResponse::NUM_PAGES * @return numPages */ @jakarta.annotation.Nullable @@ -106,7 +106,7 @@ public ListInfoResponse numResults(@jakarta.annotation.Nullable Integer numResul } /** - * Total number of objects available. + * _t__ListInfoResponse::NUM_RESULTS * @return numResults */ @jakarta.annotation.Nullable @@ -131,7 +131,7 @@ public ListInfoResponse page(@jakarta.annotation.Nullable Integer page) { } /** - * Number of the page being returned. + * _t__ListInfoResponse::PAGE * @return page */ @jakarta.annotation.Nullable @@ -156,7 +156,7 @@ public ListInfoResponse pageSize(@jakarta.annotation.Nullable Integer pageSize) } /** - * Objects returned per page. + * _t__ListInfoResponse::PAGE_SIZE * @return pageSize */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java index 844693917..0987df72f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java @@ -161,7 +161,7 @@ public OAuthTokenResponse expiresIn(@jakarta.annotation.Nullable Integer expires } /** - * Number of seconds until the `access_token` expires. Uses epoch time. + * _t__OAuthTokenResponse::EXPIRES_IN * @return expiresIn */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java index e88dbb0e2..020326d82 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java @@ -52,7 +52,9 @@ public class ReportCreateRequest { public enum ReportTypeEnum { USER_ACTIVITY(String.valueOf("user_activity")), - DOCUMENT_STATUS(String.valueOf("document_status")); + DOCUMENT_STATUS(String.valueOf("document_status")), + + SMS_ACTIVITY(String.valueOf("sms_activity")); private String value; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java index 0ca150bf4..fce39bba7 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java @@ -108,7 +108,7 @@ public ReportCreateResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportResponse.java index 35770fa6c..1345c2a9d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/ReportResponse.java @@ -32,7 +32,7 @@ import com.dropbox.sign.ApiException; /** - * Contains information about the report request. + * _t__ReportResponse::DESCRIPTION */ @JsonPropertyOrder({ ReportResponse.JSON_PROPERTY_SUCCESS, @@ -61,7 +61,9 @@ public class ReportResponse { public enum ReportTypeEnum { USER_ACTIVITY(String.valueOf("user_activity")), - DOCUMENT_STATUS(String.valueOf("document_status")); + DOCUMENT_STATUS(String.valueOf("document_status")), + + SMS_ACTIVITY(String.valueOf("sms_activity")); private String value; @@ -118,7 +120,7 @@ public ReportResponse success(@jakarta.annotation.Nullable String success) { } /** - * A message indicating the requested operation's success + * _t__ReportResponse::SUCCESS * @return success */ @jakarta.annotation.Nullable @@ -143,7 +145,7 @@ public ReportResponse startDate(@jakarta.annotation.Nullable String startDate) { } /** - * The (inclusive) start date for the report data in MM/DD/YYYY format. + * _t__ReportResponse::START_DATE * @return startDate */ @jakarta.annotation.Nullable @@ -168,7 +170,7 @@ public ReportResponse endDate(@jakarta.annotation.Nullable String endDate) { } /** - * The (inclusive) end date for the report data in MM/DD/YYYY format. + * _t__ReportResponse::END_DATE * @return endDate */ @jakarta.annotation.Nullable @@ -201,7 +203,7 @@ public ReportResponse addReportTypeItem(ReportTypeEnum reportTypeItem) { } /** - * 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). + * _t__ReportResponse::REPORT_TYPE * @return reportType */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java index 949ddb44b..a25fb3687 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java @@ -374,7 +374,7 @@ public SignatureRequestBulkCreateEmbeddedWithTemplateRequest putMetadataItem(Str } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java index 1efde34d5..c4e918f06 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java @@ -374,7 +374,7 @@ public SignatureRequestBulkSendWithTemplateRequest putMetadataItem(String key, O } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java index 3002deccd..50cd4b2ca 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java @@ -53,6 +53,7 @@ SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_SIGNERS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -99,6 +100,10 @@ public class SignatureRequestCreateEmbeddedRequest { @jakarta.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @jakarta.annotation.Nullable + private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @jakarta.annotation.Nullable private Boolean allowReassign = false; @@ -294,7 +299,7 @@ public SignatureRequestCreateEmbeddedRequest addSignersItem(SubSignatureRequestS } /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nullable @@ -327,7 +332,7 @@ public SignatureRequestCreateEmbeddedRequest addGroupedSignersItem(SubSignatureR } /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * @return groupedSigners */ @jakarta.annotation.Nullable @@ -371,6 +376,31 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } + public SignatureRequestCreateEmbeddedRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @return allowFormView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowFormView() { + return allowFormView; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + + public SignatureRequestCreateEmbeddedRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; @@ -410,7 +440,7 @@ public SignatureRequestCreateEmbeddedRequest addAttachmentsItem(SubAttachment at } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -683,7 +713,7 @@ public SignatureRequestCreateEmbeddedRequest putMetadataItem(String key, Object } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable @@ -895,6 +925,7 @@ public boolean equals(Object o) { Objects.equals(this.signers, signatureRequestCreateEmbeddedRequest.signers) && Objects.equals(this.groupedSigners, signatureRequestCreateEmbeddedRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestCreateEmbeddedRequest.allowDecline) && + Objects.equals(this.allowFormView, signatureRequestCreateEmbeddedRequest.allowFormView) && Objects.equals(this.allowReassign, signatureRequestCreateEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestCreateEmbeddedRequest.attachments) && Objects.equals(this.ccEmailAddresses, signatureRequestCreateEmbeddedRequest.ccEmailAddresses) && @@ -917,7 +948,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); + return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowFormView, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); } @Override @@ -930,6 +961,7 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1070,6 +1102,25 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) || + allowFormView.getClass().equals(Integer.class) || + allowFormView.getClass().equals(String.class) || + allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for(int i = 0; i< getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } + else { + map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java index 6dc29fb8e..3bdeab1a6 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java @@ -211,7 +211,7 @@ public SignatureRequestCreateEmbeddedWithTemplateRequest addSignersItem(SubSigna } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nonnull @@ -426,7 +426,7 @@ public SignatureRequestCreateEmbeddedWithTemplateRequest putMetadataItem(String } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java index 9a40b64a2..d89f13251 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java @@ -53,6 +53,7 @@ SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNERS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -99,6 +100,10 @@ public class SignatureRequestEditEmbeddedRequest { @jakarta.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @jakarta.annotation.Nullable + private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @jakarta.annotation.Nullable private Boolean allowReassign = false; @@ -294,7 +299,7 @@ public SignatureRequestEditEmbeddedRequest addSignersItem(SubSignatureRequestSig } /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nullable @@ -327,7 +332,7 @@ public SignatureRequestEditEmbeddedRequest addGroupedSignersItem(SubSignatureReq } /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * @return groupedSigners */ @jakarta.annotation.Nullable @@ -371,6 +376,31 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } + public SignatureRequestEditEmbeddedRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @return allowFormView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowFormView() { + return allowFormView; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + + public SignatureRequestEditEmbeddedRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; @@ -410,7 +440,7 @@ public SignatureRequestEditEmbeddedRequest addAttachmentsItem(SubAttachment atta } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -683,7 +713,7 @@ public SignatureRequestEditEmbeddedRequest putMetadataItem(String key, Object me } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable @@ -895,6 +925,7 @@ public boolean equals(Object o) { Objects.equals(this.signers, signatureRequestEditEmbeddedRequest.signers) && Objects.equals(this.groupedSigners, signatureRequestEditEmbeddedRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestEditEmbeddedRequest.allowDecline) && + Objects.equals(this.allowFormView, signatureRequestEditEmbeddedRequest.allowFormView) && Objects.equals(this.allowReassign, signatureRequestEditEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestEditEmbeddedRequest.attachments) && Objects.equals(this.ccEmailAddresses, signatureRequestEditEmbeddedRequest.ccEmailAddresses) && @@ -917,7 +948,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); + return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowFormView, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); } @Override @@ -930,6 +961,7 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1070,6 +1102,25 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) || + allowFormView.getClass().equals(Integer.class) || + allowFormView.getClass().equals(String.class) || + allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for(int i = 0; i< getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } + else { + map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java index af702922f..14bc608fe 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java @@ -211,7 +211,7 @@ public SignatureRequestEditEmbeddedWithTemplateRequest addSignersItem(SubSignatu } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nonnull @@ -426,7 +426,7 @@ public SignatureRequestEditEmbeddedWithTemplateRequest putMetadataItem(String ke } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java index 719a6b457..5b0dbc1da 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java @@ -52,6 +52,7 @@ SignatureRequestEditRequest.JSON_PROPERTY_SIGNERS, SignatureRequestEditRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestEditRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestEditRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -96,6 +97,10 @@ public class SignatureRequestEditRequest { @jakarta.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @jakarta.annotation.Nullable + private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @jakarta.annotation.Nullable private Boolean allowReassign = false; @@ -274,7 +279,7 @@ public SignatureRequestEditRequest addSignersItem(SubSignatureRequestSigner sign } /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nullable @@ -307,7 +312,7 @@ public SignatureRequestEditRequest addGroupedSignersItem(SubSignatureRequestGrou } /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * @return groupedSigners */ @jakarta.annotation.Nullable @@ -351,6 +356,31 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } + public SignatureRequestEditRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @return allowFormView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowFormView() { + return allowFormView; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + + public SignatureRequestEditRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; @@ -390,7 +420,7 @@ public SignatureRequestEditRequest addAttachmentsItem(SubAttachment attachmentsI } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -713,7 +743,7 @@ public SignatureRequestEditRequest putMetadataItem(String key, Object metadataIt } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable @@ -924,6 +954,7 @@ public boolean equals(Object o) { Objects.equals(this.signers, signatureRequestEditRequest.signers) && Objects.equals(this.groupedSigners, signatureRequestEditRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestEditRequest.allowDecline) && + Objects.equals(this.allowFormView, signatureRequestEditRequest.allowFormView) && Objects.equals(this.allowReassign, signatureRequestEditRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestEditRequest.attachments) && Objects.equals(this.ccEmailAddresses, signatureRequestEditRequest.ccEmailAddresses) && @@ -948,7 +979,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); + return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowFormView, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); } @Override @@ -960,6 +991,7 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1083,6 +1115,25 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) || + allowFormView.getClass().equals(Integer.class) || + allowFormView.getClass().equals(String.class) || + allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for(int i = 0; i< getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } + else { + map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java index 02f2a4d2f..03a384652 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java @@ -191,7 +191,7 @@ public SignatureRequestEditWithTemplateRequest addSignersItem(SubSignatureReques } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nonnull @@ -456,7 +456,7 @@ public SignatureRequestEditWithTemplateRequest putMetadataItem(String key, Objec } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java index 489a922dc..664b3dbf0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java @@ -108,7 +108,7 @@ public SignatureRequestGetResponse addWarningsItem(WarningResponse warningsItem) } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java index 5c8169269..05d5245fa 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java @@ -89,7 +89,7 @@ public SignatureRequestListResponse addSignatureRequestsItem(SignatureRequestRes } /** - * Contains information about signature requests. + * _t__SignatureRequestListResponse::DESCRIPTION * @return signatureRequests */ @jakarta.annotation.Nonnull @@ -147,7 +147,7 @@ public SignatureRequestListResponse addWarningsItem(WarningResponse warningsItem } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java index 481b8bd6b..d87c8c39b 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java @@ -38,7 +38,7 @@ import com.dropbox.sign.ApiException; /** - * Contains information about a signature request. + * _t__SignatureRequestResponse::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponse.JSON_PROPERTY_TEST_MODE, @@ -194,7 +194,7 @@ public SignatureRequestResponse testMode(@jakarta.annotation.Nullable Boolean te } /** - * Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + * _t__SignatureRequestResponse::TEST_MODE * @return testMode */ @jakarta.annotation.Nullable @@ -219,7 +219,7 @@ public SignatureRequestResponse signatureRequestId(@jakarta.annotation.Nullable } /** - * The id of the SignatureRequest. + * _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID * @return signatureRequestId */ @jakarta.annotation.Nullable @@ -244,7 +244,7 @@ public SignatureRequestResponse requesterEmailAddress(@jakarta.annotation.Nullab } /** - * The email address of the initiator of the SignatureRequest. + * _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS * @return requesterEmailAddress */ @jakarta.annotation.Nullable @@ -269,7 +269,7 @@ public SignatureRequestResponse title(@jakarta.annotation.Nullable String title) } /** - * The title the specified Account uses for the SignatureRequest. + * _t__SignatureRequestResponse::TITLE * @return title */ @jakarta.annotation.Nullable @@ -294,7 +294,7 @@ public SignatureRequestResponse originalTitle(@jakarta.annotation.Nullable Strin } /** - * Default Label for account. + * _t__SignatureRequestResponse::ORIGINAL_TITLE * @return originalTitle */ @jakarta.annotation.Nullable @@ -319,7 +319,7 @@ public SignatureRequestResponse subject(@jakarta.annotation.Nullable String subj } /** - * The subject in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::SUBJECT * @return subject */ @jakarta.annotation.Nullable @@ -344,7 +344,7 @@ public SignatureRequestResponse message(@jakarta.annotation.Nullable String mess } /** - * The custom message in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::MESSAGE * @return message */ @jakarta.annotation.Nullable @@ -377,7 +377,7 @@ public SignatureRequestResponse putMetadataItem(String key, Object metadataItem) } /** - * The metadata attached to the signature request. + * _t__SignatureRequestResponse::METADATA * @return metadata */ @jakarta.annotation.Nullable @@ -402,7 +402,7 @@ public SignatureRequestResponse createdAt(@jakarta.annotation.Nullable Integer c } /** - * Time the signature request was created. + * _t__SignatureRequestResponse::CREATED_AT * @return createdAt */ @jakarta.annotation.Nullable @@ -427,7 +427,7 @@ public SignatureRequestResponse expiresAt(@jakarta.annotation.Nullable Integer e } /** - * The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * _t__SignatureRequestResponse::EXPIRES_AT * @return expiresAt */ @jakarta.annotation.Nullable @@ -452,7 +452,7 @@ public SignatureRequestResponse isComplete(@jakarta.annotation.Nullable Boolean } /** - * Whether or not the SignatureRequest has been fully executed by all signers. + * _t__SignatureRequestResponse::IS_COMPLETE * @return isComplete */ @jakarta.annotation.Nullable @@ -477,7 +477,7 @@ public SignatureRequestResponse isDeclined(@jakarta.annotation.Nullable Boolean } /** - * Whether or not the SignatureRequest has been declined by a signer. + * _t__SignatureRequestResponse::IS_DECLINED * @return isDeclined */ @jakarta.annotation.Nullable @@ -502,7 +502,7 @@ public SignatureRequestResponse hasError(@jakarta.annotation.Nullable Boolean ha } /** - * Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + * _t__SignatureRequestResponse::HAS_ERROR * @return hasError */ @jakarta.annotation.Nullable @@ -527,7 +527,7 @@ public SignatureRequestResponse filesUrl(@jakarta.annotation.Nullable String fil } /** - * The URL where a copy of the request's documents can be downloaded. + * _t__SignatureRequestResponse::FILES_URL * @return filesUrl */ @jakarta.annotation.Nullable @@ -552,7 +552,7 @@ public SignatureRequestResponse signingUrl(@jakarta.annotation.Nullable String s } /** - * The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + * _t__SignatureRequestResponse::SIGNING_URL * @return signingUrl */ @jakarta.annotation.Nullable @@ -577,7 +577,7 @@ public SignatureRequestResponse detailsUrl(@jakarta.annotation.Nullable String d } /** - * The URL where the requester and the signers can view the current status of the SignatureRequest. + * _t__SignatureRequestResponse::DETAILS_URL * @return detailsUrl */ @jakarta.annotation.Nullable @@ -610,7 +610,7 @@ public SignatureRequestResponse addCcEmailAddressesItem(String ccEmailAddressesI } /** - * A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + * _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES * @return ccEmailAddresses */ @jakarta.annotation.Nullable @@ -635,7 +635,7 @@ public SignatureRequestResponse signingRedirectUrl(@jakarta.annotation.Nullable } /** - * The URL you want the signer redirected to after they successfully sign. + * _t__SignatureRequestResponse::SIGNING_REDIRECT_URL * @return signingRedirectUrl */ @jakarta.annotation.Nullable @@ -660,7 +660,7 @@ public SignatureRequestResponse finalCopyUri(@jakarta.annotation.Nullable String } /** - * The path where the completed document can be downloaded + * _t__SignatureRequestResponse::FINAL_COPY_URI * @return finalCopyUri */ @jakarta.annotation.Nullable @@ -693,7 +693,7 @@ public SignatureRequestResponse addTemplateIdsItem(String templateIdsItem) { } /** - * Templates IDs used in this SignatureRequest (if any). + * _t__SignatureRequestResponse::TEMPLATE_IDS * @return templateIds */ @jakarta.annotation.Nullable @@ -726,7 +726,7 @@ public SignatureRequestResponse addCustomFieldsItem(SignatureRequestResponseCust } /** - * An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * _t__SignatureRequestResponseCustomField::DESCRIPTION * @return customFields */ @jakarta.annotation.Nullable @@ -759,7 +759,7 @@ public SignatureRequestResponse addAttachmentsItem(SignatureRequestResponseAttac } /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -792,7 +792,7 @@ public SignatureRequestResponse addResponseDataItem(SignatureRequestResponseData } /** - * An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + * _t__SignatureRequestResponseData::DESCRIPTION * @return responseData */ @jakarta.annotation.Nullable @@ -825,7 +825,7 @@ public SignatureRequestResponse addSignaturesItem(SignatureRequestResponseSignat } /** - * An array of signature objects, 1 for each signer. + * _t__SignatureRequestResponseSignatures::DESCRIPTION * @return signatures */ @jakarta.annotation.Nullable @@ -850,7 +850,7 @@ public SignatureRequestResponse bulkSendJobId(@jakarta.annotation.Nullable Strin } /** - * The ID of the Bulk Send job which sent the signature request, if applicable. + * _t__SignatureRequestResponse::BULK_SEND_JOB_ID * @return bulkSendJobId */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java index 388774fd2..745969d5c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponseAttachment.JSON_PROPERTY_ID, @@ -91,7 +91,7 @@ public SignatureRequestResponseAttachment id(@jakarta.annotation.Nonnull String } /** - * The unique ID for this attachment. + * _t__SignatureRequestResponseAttachment::ID * @return id */ @jakarta.annotation.Nonnull @@ -120,7 +120,7 @@ public SignatureRequestResponseAttachment signer(Integer signer) { } /** - * The Signer this attachment is assigned to. + * _t__SignatureRequestResponseAttachment::SIGNER * @return signer */ @jakarta.annotation.Nonnull @@ -149,7 +149,7 @@ public SignatureRequestResponseAttachment name(@jakarta.annotation.Nonnull Strin } /** - * The name of this attachment. + * _t__SignatureRequestResponseAttachment::NAME * @return name */ @jakarta.annotation.Nonnull @@ -174,7 +174,7 @@ public SignatureRequestResponseAttachment required(@jakarta.annotation.Nonnull B } /** - * A boolean value denoting if this attachment is required. + * _t__SignatureRequestResponseAttachment::REQUIRED * @return required */ @jakarta.annotation.Nonnull @@ -199,7 +199,7 @@ public SignatureRequestResponseAttachment instructions(@jakarta.annotation.Nulla } /** - * Instructions for Signer. + * _t__SignatureRequestResponseAttachment::INSTRUCTIONS * @return instructions */ @jakarta.annotation.Nullable @@ -224,7 +224,7 @@ public SignatureRequestResponseAttachment uploadedAt(@jakarta.annotation.Nullabl } /** - * Timestamp when attachment was uploaded by Signer. + * _t__SignatureRequestResponseAttachment::UPLOADED_AT * @return uploadedAt */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java index 0901f46c4..419c4401e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java @@ -33,7 +33,7 @@ import com.dropbox.sign.ApiException; /** - * An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * _t__SignatureRequestResponseCustomField::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponseCustomFieldBase.JSON_PROPERTY_TYPE, @@ -98,7 +98,7 @@ public SignatureRequestResponseCustomFieldBase type(@jakarta.annotation.Nonnull } /** - * The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + * _t__SignatureRequestResponseCustomField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -123,7 +123,7 @@ public SignatureRequestResponseCustomFieldBase name(@jakarta.annotation.Nonnull } /** - * The name of the Custom Field. + * _t__SignatureRequestResponseCustomField::NAME * @return name */ @jakarta.annotation.Nonnull @@ -148,7 +148,7 @@ public SignatureRequestResponseCustomFieldBase required(@jakarta.annotation.Null } /** - * A boolean value denoting if this field is required. + * _t__SignatureRequestResponseCustomField::REQUIRED * @return required */ @jakarta.annotation.Nullable @@ -173,7 +173,7 @@ public SignatureRequestResponseCustomFieldBase apiId(@jakarta.annotation.Nullabl } /** - * The unique ID for this field. + * _t__SignatureRequestResponseCustomField::API_ID * @return apiId */ @jakarta.annotation.Nullable @@ -198,7 +198,7 @@ public SignatureRequestResponseCustomFieldBase editor(@jakarta.annotation.Nullab } /** - * The name of the Role that is able to edit this field. + * _t__SignatureRequestResponseCustomField::EDITOR * @return editor */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java index 7ab1636dc..c5225fe76 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `SignatureRequestResponseCustomFieldBase`. + * _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ SignatureRequestResponseCustomFieldCheckbox.JSON_PROPERTY_TYPE, @@ -80,7 +80,7 @@ public SignatureRequestResponseCustomFieldCheckbox type(@jakarta.annotation.Nonn } /** - * The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + * _t__SignatureRequestResponseCustomField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -105,7 +105,7 @@ public SignatureRequestResponseCustomFieldCheckbox value(@jakarta.annotation.Nul } /** - * A true/false for checkbox fields + * _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX * @return value */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java index 7157610f4..ce2a8c435 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `SignatureRequestResponseCustomFieldBase`. + * _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ SignatureRequestResponseCustomFieldText.JSON_PROPERTY_TYPE, @@ -80,7 +80,7 @@ public SignatureRequestResponseCustomFieldText type(@jakarta.annotation.Nonnull } /** - * The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + * _t__SignatureRequestResponseCustomField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -105,7 +105,7 @@ public SignatureRequestResponseCustomFieldText value(@jakarta.annotation.Nullabl } /** - * A text string for text fields + * _t__SignatureRequestResponseCustomField::VALUE_TEXT * @return value */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java index d572079a4..116d0c5b8 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java @@ -33,7 +33,7 @@ import com.dropbox.sign.ApiException; /** - * An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + * _t__SignatureRequestResponseData::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponseDataBase.JSON_PROPERTY_API_ID, @@ -105,7 +105,7 @@ public SignatureRequestResponseDataBase apiId(@jakarta.annotation.Nullable Strin } /** - * The unique ID for this field. + * _t__SignatureRequestResponseData::API_ID * @return apiId */ @jakarta.annotation.Nullable @@ -130,7 +130,7 @@ public SignatureRequestResponseDataBase signatureId(@jakarta.annotation.Nullable } /** - * The ID of the signature to which this response is linked. + * _t__SignatureRequestResponseData::SIGNATURE_ID * @return signatureId */ @jakarta.annotation.Nullable @@ -155,7 +155,7 @@ public SignatureRequestResponseDataBase name(@jakarta.annotation.Nullable String } /** - * The name of the form field. + * _t__SignatureRequestResponseData::NAME * @return name */ @jakarta.annotation.Nullable @@ -180,7 +180,7 @@ public SignatureRequestResponseDataBase required(@jakarta.annotation.Nullable Bo } /** - * A boolean value denoting if this field is required. + * _t__SignatureRequestResponseData::REQUIRED * @return required */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java index ea881f7d9..3a9203cc7 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java @@ -80,7 +80,7 @@ public SignatureRequestResponseDataValueCheckbox type(@jakarta.annotation.Nullab } /** - * A yes/no checkbox + * _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE * @return type */ @jakarta.annotation.Nullable @@ -105,7 +105,7 @@ public SignatureRequestResponseDataValueCheckbox value(@jakarta.annotation.Nulla } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * @return value */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java index b36555469..0d442f8a3 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java @@ -80,7 +80,7 @@ public SignatureRequestResponseDataValueCheckboxMerge type(@jakarta.annotation.N } /** - * A checkbox field that has default value set by the api + * _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE * @return type */ @jakarta.annotation.Nullable @@ -105,7 +105,7 @@ public SignatureRequestResponseDataValueCheckboxMerge value(@jakarta.annotation. } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * @return value */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java index 6c8c35134..b098927f2 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java @@ -80,7 +80,7 @@ public SignatureRequestResponseDataValueDateSigned type(@jakarta.annotation.Null } /** - * A date + * _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE * @return type */ @jakarta.annotation.Nullable @@ -105,7 +105,7 @@ public SignatureRequestResponseDataValueDateSigned value(@jakarta.annotation.Nul } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * @return value */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java index 8d7a8425c..e7f3f6e7f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java @@ -80,7 +80,7 @@ public SignatureRequestResponseDataValueDropdown type(@jakarta.annotation.Nullab } /** - * An input field for dropdowns + * _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE * @return type */ @jakarta.annotation.Nullable @@ -105,7 +105,7 @@ public SignatureRequestResponseDataValueDropdown value(@jakarta.annotation.Nulla } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * @return value */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java index 1a68d9a22..0378624f4 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java @@ -85,7 +85,7 @@ public SignatureRequestResponseDataValueInitials type(@jakarta.annotation.Nullab } /** - * An input field for initials + * _t__SignatureRequestResponseDataValue::INITIAL_TYPE * @return type */ @jakarta.annotation.Nullable @@ -110,7 +110,7 @@ public SignatureRequestResponseDataValueInitials value(@jakarta.annotation.Nulla } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * @return value */ @jakarta.annotation.Nullable @@ -135,7 +135,7 @@ public SignatureRequestResponseDataValueInitials isSigned(@jakarta.annotation.Nu } /** - * This field contains the boolean true if the field is signed. + * _t__SignatureRequestResponseDataValue::IS_SIGNED * @return isSigned */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java index 027c4d911..b4c0bb320 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java @@ -80,7 +80,7 @@ public SignatureRequestResponseDataValueRadio type(@jakarta.annotation.Nullable } /** - * An input field for radios + * _t__SignatureRequestResponseDataValue::RADIO_TYPE * @return type */ @jakarta.annotation.Nullable @@ -105,7 +105,7 @@ public SignatureRequestResponseDataValueRadio value(@jakarta.annotation.Nullable } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * @return value */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java index 95953be9e..611a8bd1f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java @@ -85,7 +85,7 @@ public SignatureRequestResponseDataValueSignature type(@jakarta.annotation.Nulla } /** - * A signature input field + * _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE * @return type */ @jakarta.annotation.Nullable @@ -110,7 +110,7 @@ public SignatureRequestResponseDataValueSignature value(@jakarta.annotation.Null } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * @return value */ @jakarta.annotation.Nullable @@ -135,7 +135,7 @@ public SignatureRequestResponseDataValueSignature isSigned(@jakarta.annotation.N } /** - * This field contains the boolean true if the field is signed. + * _t__SignatureRequestResponseDataValue::IS_SIGNED * @return isSigned */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java index 63225480d..fb6ce2ab6 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java @@ -80,7 +80,7 @@ public SignatureRequestResponseDataValueText type(@jakarta.annotation.Nullable S } /** - * A text input field + * _t__SignatureRequestResponseDataValue::TEXT_TYPE * @return type */ @jakarta.annotation.Nullable @@ -105,7 +105,7 @@ public SignatureRequestResponseDataValueText value(@jakarta.annotation.Nullable } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * @return value */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java index b420f7552..269b65080 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java @@ -80,7 +80,7 @@ public SignatureRequestResponseDataValueTextMerge type(@jakarta.annotation.Nulla } /** - * A text field that has default text set by the api + * _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE * @return type */ @jakarta.annotation.Nullable @@ -105,7 +105,7 @@ public SignatureRequestResponseDataValueTextMerge value(@jakarta.annotation.Null } /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE * @return value */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java index 59472ad36..42cd5f20d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * An array of signature objects, 1 for each signer. + * _t__SignatureRequestResponseSignatures::DESCRIPTION */ @JsonPropertyOrder({ SignatureRequestResponseSignatures.JSON_PROPERTY_SIGNATURE_ID, @@ -156,7 +156,7 @@ public SignatureRequestResponseSignatures signatureId(@jakarta.annotation.Nullab } /** - * Signature identifier. + * _t__SignatureRequestResponseSignatures::SIGNATURE_ID * @return signatureId */ @jakarta.annotation.Nullable @@ -181,7 +181,7 @@ public SignatureRequestResponseSignatures signerGroupGuid(@jakarta.annotation.Nu } /** - * Signer Group GUID + * _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID * @return signerGroupGuid */ @jakarta.annotation.Nullable @@ -206,7 +206,7 @@ public SignatureRequestResponseSignatures signerEmailAddress(@jakarta.annotation } /** - * The email address of the signer. + * _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS * @return signerEmailAddress */ @jakarta.annotation.Nullable @@ -231,7 +231,7 @@ public SignatureRequestResponseSignatures signerName(@jakarta.annotation.Nullabl } /** - * The name of the signer. + * _t__SignatureRequestResponseSignatures::SIGNER_NAME * @return signerName */ @jakarta.annotation.Nullable @@ -256,7 +256,7 @@ public SignatureRequestResponseSignatures signerRole(@jakarta.annotation.Nullabl } /** - * The role of the signer. + * _t__SignatureRequestResponseSignatures::SIGNER_ROLE * @return signerRole */ @jakarta.annotation.Nullable @@ -281,7 +281,7 @@ public SignatureRequestResponseSignatures order(@jakarta.annotation.Nullable Int } /** - * If signer order is assigned this is the 0-based index for this signer. + * _t__SignatureRequestResponseSignatures::ORDER * @return order */ @jakarta.annotation.Nullable @@ -306,7 +306,7 @@ public SignatureRequestResponseSignatures statusCode(@jakarta.annotation.Nullabl } /** - * The current status of the signature. eg: awaiting_signature, signed, declined. + * _t__SignatureRequestResponseSignatures::STATUS_CODE * @return statusCode */ @jakarta.annotation.Nullable @@ -331,7 +331,7 @@ public SignatureRequestResponseSignatures declineReason(@jakarta.annotation.Null } /** - * The reason provided by the signer for declining the request. + * _t__SignatureRequestResponseSignatures::DECLINE_REASON * @return declineReason */ @jakarta.annotation.Nullable @@ -356,7 +356,7 @@ public SignatureRequestResponseSignatures signedAt(@jakarta.annotation.Nullable } /** - * Time that the document was signed or null. + * _t__SignatureRequestResponseSignatures::SIGNED_AT * @return signedAt */ @jakarta.annotation.Nullable @@ -381,7 +381,7 @@ public SignatureRequestResponseSignatures lastViewedAt(@jakarta.annotation.Nulla } /** - * The time that the document was last viewed by this signer or null. + * _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT * @return lastViewedAt */ @jakarta.annotation.Nullable @@ -406,7 +406,7 @@ public SignatureRequestResponseSignatures lastRemindedAt(@jakarta.annotation.Nul } /** - * The time the last reminder email was sent to the signer or null. + * _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT * @return lastRemindedAt */ @jakarta.annotation.Nullable @@ -431,7 +431,7 @@ public SignatureRequestResponseSignatures hasPin(@jakarta.annotation.Nullable Bo } /** - * Boolean to indicate whether this signature requires a PIN to access. + * _t__SignatureRequestResponseSignatures::HAS_PIN * @return hasPin */ @jakarta.annotation.Nullable @@ -456,7 +456,7 @@ public SignatureRequestResponseSignatures hasSmsAuth(@jakarta.annotation.Nullabl } /** - * Boolean to indicate whether this signature has SMS authentication enabled. + * _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH * @return hasSmsAuth */ @jakarta.annotation.Nullable @@ -481,7 +481,7 @@ public SignatureRequestResponseSignatures hasSmsDelivery(@jakarta.annotation.Nul } /** - * Boolean to indicate whether this signature has SMS delivery enabled. + * _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY * @return hasSmsDelivery */ @jakarta.annotation.Nullable @@ -506,7 +506,7 @@ public SignatureRequestResponseSignatures smsPhoneNumber(@jakarta.annotation.Nul } /** - * The SMS phone number used for authentication or signature request delivery. + * _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER * @return smsPhoneNumber */ @jakarta.annotation.Nullable @@ -531,7 +531,7 @@ public SignatureRequestResponseSignatures reassignedBy(@jakarta.annotation.Nulla } /** - * Email address of original signer who reassigned to this signer. + * _t__SignatureRequestResponseSignatures::REASSIGNED_BY * @return reassignedBy */ @jakarta.annotation.Nullable @@ -556,7 +556,7 @@ public SignatureRequestResponseSignatures reassignmentReason(@jakarta.annotation } /** - * Reason provided by original signer who reassigned to this signer. + * _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON * @return reassignmentReason */ @jakarta.annotation.Nullable @@ -581,7 +581,7 @@ public SignatureRequestResponseSignatures reassignedFrom(@jakarta.annotation.Nul } /** - * Previous signature identifier. + * _t__SignatureRequestResponseSignatures::REASSIGNED_FROM * @return reassignedFrom */ @jakarta.annotation.Nullable @@ -606,7 +606,7 @@ public SignatureRequestResponseSignatures error(@jakarta.annotation.Nullable Str } /** - * Error message pertaining to this signer, or null. + * _t__SignatureRequestResponseSignatures::ERROR * @return error */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index a76ab911f..c7550c654 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java @@ -53,6 +53,7 @@ SignatureRequestSendRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_DECLINE, SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_REASSIGN, + SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestSendRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestSendRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, SignatureRequestSendRequest.JSON_PROPERTY_CLIENT_ID, @@ -101,6 +102,10 @@ public class SignatureRequestSendRequest { @jakarta.annotation.Nullable private Boolean allowReassign = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @jakarta.annotation.Nullable + private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @jakarta.annotation.Nullable private List attachments = null; @@ -280,7 +285,7 @@ public SignatureRequestSendRequest addSignersItem(SubSignatureRequestSigner sign } /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nullable @@ -313,7 +318,7 @@ public SignatureRequestSendRequest addGroupedSignersItem(SubSignatureRequestGrou } /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * @return groupedSigners */ @jakarta.annotation.Nullable @@ -382,6 +387,31 @@ public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) } + public SignatureRequestSendRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @return allowFormView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowFormView() { + return allowFormView; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + + public SignatureRequestSendRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; @@ -396,7 +426,7 @@ public SignatureRequestSendRequest addAttachmentsItem(SubAttachment attachmentsI } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -748,7 +778,7 @@ public SignatureRequestSendRequest putMetadataItem(String key, Object metadataIt } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable @@ -960,6 +990,7 @@ public boolean equals(Object o) { Objects.equals(this.groupedSigners, signatureRequestSendRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestSendRequest.allowDecline) && Objects.equals(this.allowReassign, signatureRequestSendRequest.allowReassign) && + Objects.equals(this.allowFormView, signatureRequestSendRequest.allowFormView) && Objects.equals(this.attachments, signatureRequestSendRequest.attachments) && Objects.equals(this.ccEmailAddresses, signatureRequestSendRequest.ccEmailAddresses) && Objects.equals(this.clientId, signatureRequestSendRequest.clientId) && @@ -984,7 +1015,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); + return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, allowFormView, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); } @Override @@ -997,6 +1028,7 @@ public String toString() { sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -1139,6 +1171,25 @@ public Map createFormData() throws ApiException { map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) || + allowFormView.getClass().equals(Integer.class) || + allowFormView.getClass().equals(String.class) || + allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for(int i = 0; i< getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } + else { + map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java index 861f52e96..f4e79cb79 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java @@ -197,7 +197,7 @@ public SignatureRequestSendWithTemplateRequest addSignersItem(SubSignatureReques } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nonnull @@ -491,7 +491,7 @@ public SignatureRequestSendWithTemplateRequest putMetadataItem(String key, Objec } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java index 2a37ad187..8c38c16d9 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java @@ -294,7 +294,7 @@ public SubFormFieldsPerDocumentBase width(@jakarta.annotation.Nonnull Integer wi } /** - * Size of the field in pixels. + * _t__Sub::FormFieldsPerDocument::WIDTH * @return width */ @jakarta.annotation.Nonnull @@ -319,7 +319,7 @@ public SubFormFieldsPerDocumentBase x(@jakarta.annotation.Nonnull Integer x) { } /** - * Location coordinates of the field in pixels. + * _t__Sub::FormFieldsPerDocument::X * @return x */ @jakarta.annotation.Nonnull @@ -344,7 +344,7 @@ public SubFormFieldsPerDocumentBase y(@jakarta.annotation.Nonnull Integer y) { } /** - * Location coordinates of the field in pixels. + * _t__Sub::FormFieldsPerDocument::Y * @return y */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java index 396c85dbe..97b4f95ec 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java @@ -78,7 +78,7 @@ public class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase { private Boolean masked; /** - * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + * _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE */ public enum ValidationTypeEnum { NUMBERS_ONLY(String.valueOf("numbers_only")), @@ -364,7 +364,7 @@ public SubFormFieldsPerDocumentText validationType(@jakarta.annotation.Nullable } /** - * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + * _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE * @return validationType */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java index 1024f05cc..354eaa623 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java @@ -148,7 +148,7 @@ public SubFormFieldsPerDocumentTextMerge type(@jakarta.annotation.Nonnull String } /** - * A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. + * _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubMergeField.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubMergeField.java index 9b039b46f..fbb3c3950 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubMergeField.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubMergeField.java @@ -44,7 +44,7 @@ public class SubMergeField { private String name; /** - * The type of merge field. + * _t__Sub::MergeField::TYPE */ public enum TypeEnum { TEXT(String.valueOf("text")), @@ -106,7 +106,7 @@ public SubMergeField name(@jakarta.annotation.Nonnull String name) { } /** - * The name of the merge field. Must be unique. + * _t__Sub::MergeField::NAME * @return name */ @jakarta.annotation.Nonnull @@ -131,7 +131,7 @@ public SubMergeField type(@jakarta.annotation.Nonnull TypeEnum type) { } /** - * The type of merge field. + * _t__Sub::MergeField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubOAuth.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubOAuth.java index c5a779573..b5ec212f0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubOAuth.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubOAuth.java @@ -32,7 +32,7 @@ import com.dropbox.sign.ApiException; /** - * OAuth related parameters. + * _t__Sub::OAuth::DESCRIPTION */ @JsonPropertyOrder({ SubOAuth.JSON_PROPERTY_CALLBACK_URL, @@ -120,7 +120,7 @@ public SubOAuth callbackUrl(@jakarta.annotation.Nullable String callbackUrl) { } /** - * The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) + * _t__Sub::OAuth::CALLBACK_URL * @return callbackUrl */ @jakarta.annotation.Nullable @@ -153,7 +153,7 @@ public SubOAuth addScopesItem(ScopesEnum scopesItem) { } /** - * A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). + * _t__Sub::OAuth::SCOPES * @return scopes */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubOptions.java index 2ff1672a9..6a3547627 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubOptions.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Additional options supported by API App. + * _t__Sub::Options::DESCRIPTION */ @JsonPropertyOrder({ SubOptions.JSON_PROPERTY_CAN_INSERT_EVERYWHERE @@ -66,7 +66,7 @@ public SubOptions canInsertEverywhere(@jakarta.annotation.Nullable Boolean canIn } /** - * Determines if signers can use \"Insert Everywhere\" when signing a document. + * _t__Sub::Options::CAN_INSERT_EVERYWHERE * @return canInsertEverywhere */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java index e3906ba3f..5d755c29c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java @@ -79,7 +79,7 @@ public SubSignatureRequestGroupedSigners group(@jakarta.annotation.Nonnull Strin } /** - * The name of the group. + * _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME * @return group */ @jakarta.annotation.Nonnull @@ -112,7 +112,7 @@ public SubSignatureRequestGroupedSigners addSignersItem(SubSignatureRequestSigne } /** - * 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. + * _t__Sub::SignatureRequestGroupedSigners::SIGNERS * @return signers */ @jakarta.annotation.Nonnull @@ -137,7 +137,7 @@ public SubSignatureRequestGroupedSigners order(@jakarta.annotation.Nullable Inte } /** - * The order the group is required to sign in. Use this instead of Signer-level `order`. + * _t__Sub::SignatureRequestGroupedSigners::ORDER * @return order */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java index c0d16fef9..cc197a8e6 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java @@ -64,7 +64,7 @@ public class SubSignatureRequestSigner { private String smsPhoneNumber; /** - * Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + * _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE */ public enum SmsPhoneNumberTypeEnum { AUTHENTICATION(String.valueOf("authentication")), @@ -126,7 +126,7 @@ public SubSignatureRequestSigner name(@jakarta.annotation.Nonnull String name) { } /** - * The name of the signer. + * _t__Sub::SignatureRequestSigner::SIGNER_NAME * @return name */ @jakarta.annotation.Nonnull @@ -151,7 +151,7 @@ public SubSignatureRequestSigner emailAddress(@jakarta.annotation.Nonnull String } /** - * The email address of the signer. + * _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS * @return emailAddress */ @jakarta.annotation.Nonnull @@ -176,7 +176,7 @@ public SubSignatureRequestSigner order(@jakarta.annotation.Nullable Integer orde } /** - * The order the signer is required to sign in. + * _t__Sub::SignatureRequestSigner::SIGNER_ORDER * @return order */ @jakarta.annotation.Nullable @@ -201,7 +201,7 @@ public SubSignatureRequestSigner pin(@jakarta.annotation.Nullable String pin) { } /** - * The 4- to 12-character access code that will secure this signer's signature page. + * _t__Sub::SignatureRequestSigner::SIGNER_PIN * @return pin */ @jakarta.annotation.Nullable @@ -226,7 +226,7 @@ public SubSignatureRequestSigner smsPhoneNumber(@jakarta.annotation.Nullable Str } /** - * An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + * _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER * @return smsPhoneNumber */ @jakarta.annotation.Nullable @@ -251,7 +251,7 @@ public SubSignatureRequestSigner smsPhoneNumberType(@jakarta.annotation.Nullable } /** - * Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + * _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE * @return smsPhoneNumberType */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java index c5c34786f..8d3e8a0d8 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java @@ -64,7 +64,7 @@ public class SubSignatureRequestTemplateSigner { private String smsPhoneNumber; /** - * Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + * _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE */ public enum SmsPhoneNumberTypeEnum { AUTHENTICATION(String.valueOf("authentication")), @@ -126,7 +126,7 @@ public SubSignatureRequestTemplateSigner role(@jakarta.annotation.Nonnull String } /** - * Must match an existing role in chosen Template(s). It's case-sensitive. + * _t__Sub::SignatureRequestTemplateSigner::ROLE * @return role */ @jakarta.annotation.Nonnull @@ -151,7 +151,7 @@ public SubSignatureRequestTemplateSigner name(@jakarta.annotation.Nonnull String } /** - * The name of the signer. + * _t__Sub::SignatureRequestTemplateSigner::NAME * @return name */ @jakarta.annotation.Nonnull @@ -176,7 +176,7 @@ public SubSignatureRequestTemplateSigner emailAddress(@jakarta.annotation.Nonnul } /** - * The email address of the signer. + * _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS * @return emailAddress */ @jakarta.annotation.Nonnull @@ -201,7 +201,7 @@ public SubSignatureRequestTemplateSigner pin(@jakarta.annotation.Nullable String } /** - * The 4- to 12-character access code that will secure this signer's signature page. + * _t__Sub::SignatureRequestTemplateSigner::PIN * @return pin */ @jakarta.annotation.Nullable @@ -226,7 +226,7 @@ public SubSignatureRequestTemplateSigner smsPhoneNumber(@jakarta.annotation.Null } /** - * An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + * _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER * @return smsPhoneNumber */ @jakarta.annotation.Nullable @@ -251,7 +251,7 @@ public SubSignatureRequestTemplateSigner smsPhoneNumberType(@jakarta.annotation. } /** - * Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + * _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE * @return smsPhoneNumberType */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSigningOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSigningOptions.java index 8a194e4bf..6adb9d125 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSigningOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSigningOptions.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + * _t__Sub::SigningOptions::DESCRIPTION */ @JsonPropertyOrder({ SubSigningOptions.JSON_PROPERTY_DEFAULT_TYPE, @@ -43,7 +43,7 @@ @JsonIgnoreProperties(ignoreUnknown=true) public class SubSigningOptions { /** - * The default type shown (limited to the listed types) + * _t__Sub::SigningOptions::DEFAULT */ public enum DefaultTypeEnum { DRAW(String.valueOf("draw")), @@ -125,7 +125,7 @@ public SubSigningOptions defaultType(@jakarta.annotation.Nonnull DefaultTypeEnum } /** - * The default type shown (limited to the listed types) + * _t__Sub::SigningOptions::DEFAULT * @return defaultType */ @jakarta.annotation.Nonnull @@ -150,7 +150,7 @@ public SubSigningOptions draw(@jakarta.annotation.Nullable Boolean draw) { } /** - * Allows drawing the signature + * _t__Sub::SigningOptions::DRAW * @return draw */ @jakarta.annotation.Nullable @@ -175,7 +175,7 @@ public SubSigningOptions phone(@jakarta.annotation.Nullable Boolean phone) { } /** - * Allows using a smartphone to email the signature + * _t__Sub::SigningOptions::PHONE * @return phone */ @jakarta.annotation.Nullable @@ -200,7 +200,7 @@ public SubSigningOptions type(@jakarta.annotation.Nullable Boolean type) { } /** - * Allows typing the signature + * _t__Sub::SigningOptions::TYPE * @return type */ @jakarta.annotation.Nullable @@ -225,7 +225,7 @@ public SubSigningOptions upload(@jakarta.annotation.Nullable Boolean upload) { } /** - * Allows uploading the signature + * _t__Sub::SigningOptions::UPLOAD * @return upload */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubTeamResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubTeamResponse.java index 5ff941e7f..a81333b91 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubTeamResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubTeamResponse.java @@ -71,7 +71,7 @@ public SubTeamResponse teamId(@jakarta.annotation.Nullable String teamId) { } /** - * The id of a team + * _t__TeamGeneral::TEAM_ID * @return teamId */ @jakarta.annotation.Nullable @@ -96,7 +96,7 @@ public SubTeamResponse name(@jakarta.annotation.Nullable String name) { } /** - * The name of a team + * _t__TeamGeneral::NAME * @return name */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubTemplateRole.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubTemplateRole.java index 36ebe7ad3..10b82a00e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubTemplateRole.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubTemplateRole.java @@ -71,7 +71,7 @@ public SubTemplateRole name(@jakarta.annotation.Nullable String name) { } /** - * The role name of the signer that will be displayed when the template is used to create a signature request. + * _t__Sub::SignerRole::NAME * @return name */ @jakarta.annotation.Nullable @@ -96,7 +96,7 @@ public SubTemplateRole order(@jakarta.annotation.Nullable Integer order) { } /** - * The order in which this signer role is required to sign. + * _t__Sub::SignerRole::ORDER * @return order */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java index 0e08dbdb8..eb865786e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java @@ -76,7 +76,7 @@ public SubUnclaimedDraftSigner emailAddress(@jakarta.annotation.Nonnull String e } /** - * The email address of the signer. + * _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS * @return emailAddress */ @jakarta.annotation.Nonnull @@ -101,7 +101,7 @@ public SubUnclaimedDraftSigner name(@jakarta.annotation.Nonnull String name) { } /** - * The name of the signer. + * _t__Sub::UnclaimedDraftSigner::NAME * @return name */ @jakarta.annotation.Nonnull @@ -126,7 +126,7 @@ public SubUnclaimedDraftSigner order(@jakarta.annotation.Nullable Integer order) } /** - * The order the signer is required to sign in. + * _t__Sub::UnclaimedDraftSigner::ORDER * @return order */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java index 7cb716183..6fd13adc0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java @@ -76,7 +76,7 @@ public SubUnclaimedDraftTemplateSigner role(@jakarta.annotation.Nonnull String r } /** - * Must match an existing role in chosen Template(s). + * _t__Sub::UnclaimedDraftTemplateSigner::ROLE * @return role */ @jakarta.annotation.Nonnull @@ -101,7 +101,7 @@ public SubUnclaimedDraftTemplateSigner name(@jakarta.annotation.Nonnull String n } /** - * The name of the signer filling the role of `role`. + * _t__Sub::UnclaimedDraftTemplateSigner::NAME * @return name */ @jakarta.annotation.Nonnull @@ -126,7 +126,7 @@ public SubUnclaimedDraftTemplateSigner emailAddress(@jakarta.annotation.Nonnull } /** - * The email address of the signer filling the role of `role`. + * _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS * @return emailAddress */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java index 0b98b9da3..503f03abf 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. + * _t__Sub::WhiteLabelingOptions::DESCRIPTION */ @JsonPropertyOrder({ SubWhiteLabelingOptions.JSON_PROPERTY_HEADER_BACKGROUND_COLOR, @@ -521,7 +521,7 @@ public SubWhiteLabelingOptions resetToDefault(@jakarta.annotation.Nullable Boole } /** - * Resets white labeling options to defaults. Only useful when updating an API App. + * _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT * @return resetToDefault */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java index 8d2bf7896..973ec4f66 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java @@ -108,7 +108,7 @@ public TeamGetInfoResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamGetResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamGetResponse.java index 957c890db..ed2fa7a65 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamGetResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamGetResponse.java @@ -108,7 +108,7 @@ public TeamGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java index 39282f5f5..b8bfb46a5 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java @@ -87,7 +87,7 @@ public TeamInfoResponse teamId(@jakarta.annotation.Nullable String teamId) { } /** - * The id of a team + * _t__TeamGeneral::TEAM_ID * @return teamId */ @jakarta.annotation.Nullable @@ -137,7 +137,7 @@ public TeamInfoResponse name(@jakarta.annotation.Nullable String name) { } /** - * The name of a team + * _t__TeamGeneral::NAME * @return name */ @jakarta.annotation.Nullable @@ -162,7 +162,7 @@ public TeamInfoResponse numMembers(@jakarta.annotation.Nullable Integer numMembe } /** - * Number of members within a team + * _t__TeamGeneral::NUM_MEMBERS * @return numMembers */ @jakarta.annotation.Nullable @@ -187,7 +187,7 @@ public TeamInfoResponse numSubTeams(@jakarta.annotation.Nullable Integer numSubT } /** - * Number of sub teams within a team + * _t__TeamGeneral::NUM_SUB_TEAMS * @return numSubTeams */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamParentResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamParentResponse.java index 5928538d6..0001361a4 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamParentResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamParentResponse.java @@ -71,7 +71,7 @@ public TeamParentResponse teamId(@jakarta.annotation.Nullable String teamId) { } /** - * The id of a team + * _t__TeamGeneral::TEAM_ID * @return teamId */ @jakarta.annotation.Nullable @@ -96,7 +96,7 @@ public TeamParentResponse name(@jakarta.annotation.Nullable String name) { } /** - * The name of a team + * _t__TeamGeneral::NAME * @return name */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java index 37128c92a..7d23bc083 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TeamResponse.java @@ -33,7 +33,7 @@ import com.dropbox.sign.ApiException; /** - * Contains information about your team and its members + * _t__TeamResponse::DESCRIPTION */ @JsonPropertyOrder({ TeamResponse.JSON_PROPERTY_NAME, @@ -84,7 +84,7 @@ public TeamResponse name(@jakarta.annotation.Nullable String name) { } /** - * The name of your Team + * _t__Team::NAME * @return name */ @jakarta.annotation.Nullable @@ -150,7 +150,7 @@ public TeamResponse addInvitedAccountsItem(AccountResponse invitedAccountsItem) } /** - * 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`. + * _t__Team::INVITED_ACCOUNTS * @return invitedAccounts */ @jakarta.annotation.Nullable @@ -183,7 +183,7 @@ public TeamResponse addInvitedEmailsItem(String invitedEmailsItem) { } /** - * A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. + * _t__Team::INVITED_EMAILS * @return invitedEmails */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java index d7786dade..46ce3778e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java @@ -51,6 +51,7 @@ TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_FILE_URLS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_CCS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_REASSIGN, + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ATTACHMENTS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_CC_ROLES, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_EDITOR_OPTIONS, @@ -95,6 +96,10 @@ public class TemplateCreateEmbeddedDraftRequest { @jakarta.annotation.Nullable private Boolean allowReassign = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @jakarta.annotation.Nullable + private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @jakarta.annotation.Nullable private List attachments = null; @@ -334,6 +339,31 @@ public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) } + public TemplateCreateEmbeddedDraftRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @return allowFormView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowFormView() { + return allowFormView; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + + public TemplateCreateEmbeddedDraftRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; @@ -348,7 +378,7 @@ public TemplateCreateEmbeddedDraftRequest addAttachmentsItem(SubAttachment attac } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -671,7 +701,7 @@ public TemplateCreateEmbeddedDraftRequest putMetadataItem(String key, Object met } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable @@ -915,6 +945,7 @@ public boolean equals(Object o) { Objects.equals(this.fileUrls, templateCreateEmbeddedDraftRequest.fileUrls) && Objects.equals(this.allowCcs, templateCreateEmbeddedDraftRequest.allowCcs) && Objects.equals(this.allowReassign, templateCreateEmbeddedDraftRequest.allowReassign) && + Objects.equals(this.allowFormView, templateCreateEmbeddedDraftRequest.allowFormView) && Objects.equals(this.attachments, templateCreateEmbeddedDraftRequest.attachments) && Objects.equals(this.ccRoles, templateCreateEmbeddedDraftRequest.ccRoles) && Objects.equals(this.editorOptions, templateCreateEmbeddedDraftRequest.editorOptions) && @@ -939,7 +970,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(clientId, files, fileUrls, allowCcs, allowReassign, attachments, ccRoles, editorOptions, fieldOptions, forceSignerRoles, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, mergeFields, message, metadata, showPreview, showProgressStepper, signerRoles, skipMeNow, subject, testMode, title, usePreexistingFields); + return Objects.hash(clientId, files, fileUrls, allowCcs, allowReassign, allowFormView, attachments, ccRoles, editorOptions, fieldOptions, forceSignerRoles, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, mergeFields, message, metadata, showPreview, showProgressStepper, signerRoles, skipMeNow, subject, testMode, title, usePreexistingFields); } @Override @@ -951,6 +982,7 @@ public String toString() { sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowCcs: ").append(toIndentedString(allowCcs)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" editorOptions: ").append(toIndentedString(editorOptions)).append("\n"); @@ -1074,6 +1106,25 @@ public Map createFormData() throws ApiException { map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) || + allowFormView.getClass().equals(Integer.class) || + allowFormView.getClass().equals(String.class) || + allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for(int i = 0; i< getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } + else { + map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java index 3a1c18ad4..724201be7 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java @@ -108,7 +108,7 @@ public TemplateCreateEmbeddedDraftResponse addWarningsItem(WarningResponse warni } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java index d40592de4..c7778ad14 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java @@ -33,7 +33,7 @@ import com.dropbox.sign.ApiException; /** - * Template object with parameters: `template_id`, `edit_url`, `expires_at`. + * _t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION */ @JsonPropertyOrder({ TemplateCreateEmbeddedDraftResponseTemplate.JSON_PROPERTY_TEMPLATE_ID, @@ -85,7 +85,7 @@ public TemplateCreateEmbeddedDraftResponseTemplate templateId(@jakarta.annotatio } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * @return templateId */ @jakarta.annotation.Nullable @@ -110,7 +110,7 @@ public TemplateCreateEmbeddedDraftResponseTemplate editUrl(@jakarta.annotation.N } /** - * Link to edit the template. + * _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL * @return editUrl */ @jakarta.annotation.Nullable @@ -135,7 +135,7 @@ public TemplateCreateEmbeddedDraftResponseTemplate expiresAt(@jakarta.annotation } /** - * When the link expires. + * _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT * @return expiresAt */ @jakarta.annotation.Nullable @@ -169,7 +169,7 @@ public TemplateCreateEmbeddedDraftResponseTemplate addWarningsItem(WarningRespon } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings * @deprecated */ diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java index 2a353e0ec..edc53675c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java @@ -50,6 +50,7 @@ TemplateCreateRequest.JSON_PROPERTY_FILES, TemplateCreateRequest.JSON_PROPERTY_FILE_URLS, TemplateCreateRequest.JSON_PROPERTY_ALLOW_REASSIGN, + TemplateCreateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateCreateRequest.JSON_PROPERTY_ATTACHMENTS, TemplateCreateRequest.JSON_PROPERTY_CC_ROLES, TemplateCreateRequest.JSON_PROPERTY_CLIENT_ID, @@ -87,6 +88,10 @@ public class TemplateCreateRequest { @jakarta.annotation.Nullable private Boolean allowReassign = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @jakarta.annotation.Nullable + private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @jakarta.annotation.Nullable private List attachments = null; @@ -314,6 +319,31 @@ public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) } + public TemplateCreateRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @return allowFormView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowFormView() { + return allowFormView; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + + public TemplateCreateRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; @@ -328,7 +358,7 @@ public TemplateCreateRequest addAttachmentsItem(SubAttachment attachmentsItem) { } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -568,7 +598,7 @@ public TemplateCreateRequest putMetadataItem(String key, Object metadataItem) { } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable @@ -704,6 +734,7 @@ public boolean equals(Object o) { Objects.equals(this.files, templateCreateRequest.files) && Objects.equals(this.fileUrls, templateCreateRequest.fileUrls) && Objects.equals(this.allowReassign, templateCreateRequest.allowReassign) && + Objects.equals(this.allowFormView, templateCreateRequest.allowFormView) && Objects.equals(this.attachments, templateCreateRequest.attachments) && Objects.equals(this.ccRoles, templateCreateRequest.ccRoles) && Objects.equals(this.clientId, templateCreateRequest.clientId) && @@ -721,7 +752,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(formFieldsPerDocument, signerRoles, files, fileUrls, allowReassign, attachments, ccRoles, clientId, fieldOptions, formFieldGroups, formFieldRules, mergeFields, message, metadata, subject, testMode, title, usePreexistingFields); + return Objects.hash(formFieldsPerDocument, signerRoles, files, fileUrls, allowReassign, allowFormView, attachments, ccRoles, clientId, fieldOptions, formFieldGroups, formFieldRules, mergeFields, message, metadata, subject, testMode, title, usePreexistingFields); } @Override @@ -733,6 +764,7 @@ public String toString() { sb.append(" files: ").append(toIndentedString(files)).append("\n"); sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -849,6 +881,25 @@ public Map createFormData() throws ApiException { map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) || + allowFormView.getClass().equals(Integer.class) || + allowFormView.getClass().equals(String.class) || + allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for(int i = 0; i< getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } + else { + map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java index 03910025a..abced3329 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java @@ -108,7 +108,7 @@ public TemplateCreateResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java index 2222fc73e..c9d8c2584 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Template object with parameters: `template_id`. + * _t__TemplateCreateResponseTemplate::DESCRIPTION */ @JsonPropertyOrder({ TemplateCreateResponseTemplate.JSON_PROPERTY_TEMPLATE_ID @@ -66,7 +66,7 @@ public TemplateCreateResponseTemplate templateId(@jakarta.annotation.Nullable St } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * @return templateId */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java index 866a87fa3..f2ce30c83 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java @@ -66,7 +66,7 @@ public TemplateEditResponse templateId(@jakarta.annotation.Nonnull String templa } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * @return templateId */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java index 248ae9fae..c4615d61f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java @@ -108,7 +108,7 @@ public TemplateGetResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateListResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateListResponse.java index 4569dbaf2..8ead348a1 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateListResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateListResponse.java @@ -89,7 +89,7 @@ public TemplateListResponse addTemplatesItem(TemplateResponse templatesItem) { } /** - * List of templates that the API caller has access to. + * _t__TemplateListResponse::DESCRIPTION * @return templates */ @jakarta.annotation.Nonnull @@ -147,7 +147,7 @@ public TemplateListResponse addWarningsItem(WarningResponse warningsItem) { } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 1796c999a..b1f8c7799 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -41,7 +41,7 @@ import com.dropbox.sign.ApiException; /** - * Contains information about the templates you and your team have created. + * _t__TemplateResponse::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponse.JSON_PROPERTY_TEMPLATE_ID, @@ -154,7 +154,7 @@ public TemplateResponse templateId(@jakarta.annotation.Nullable String templateI } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * @return templateId */ @jakarta.annotation.Nullable @@ -179,7 +179,7 @@ public TemplateResponse title(@jakarta.annotation.Nullable String title) { } /** - * The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * _t__TemplateResponse::TITLE * @return title */ @jakarta.annotation.Nullable @@ -204,7 +204,7 @@ public TemplateResponse message(@jakarta.annotation.Nullable String message) { } /** - * The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * _t__TemplateResponse::MESSAGE * @return message */ @jakarta.annotation.Nullable @@ -229,7 +229,7 @@ public TemplateResponse updatedAt(@jakarta.annotation.Nullable Integer updatedAt } /** - * Time the template was last updated. + * _t__TemplateResponse::UPDATED_AT * @return updatedAt */ @jakarta.annotation.Nullable @@ -254,7 +254,7 @@ public TemplateResponse isEmbedded(@jakarta.annotation.Nullable Boolean isEmbedd } /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + * _t__TemplateResponse::IS_EMBEDDED * @return isEmbedded */ @jakarta.annotation.Nullable @@ -279,7 +279,7 @@ public TemplateResponse isCreator(@jakarta.annotation.Nullable Boolean isCreator } /** - * `true` if you are the owner of this template, `false` if it's been shared with you by a team member. + * _t__TemplateResponse::IS_CREATOR * @return isCreator */ @jakarta.annotation.Nullable @@ -304,7 +304,7 @@ public TemplateResponse canEdit(@jakarta.annotation.Nullable Boolean canEdit) { } /** - * Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). + * _t__TemplateResponse::CAN_EDIT * @return canEdit */ @jakarta.annotation.Nullable @@ -329,7 +329,7 @@ public TemplateResponse isLocked(@jakarta.annotation.Nullable Boolean isLocked) } /** - * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + * _t__TemplateResponse::IS_LOCKED * @return isLocked */ @jakarta.annotation.Nullable @@ -362,7 +362,7 @@ public TemplateResponse putMetadataItem(String key, Object metadataItem) { } /** - * The metadata attached to the template. + * _t__TemplateResponse::METADATA * @return metadata */ @jakarta.annotation.Nullable @@ -395,7 +395,7 @@ public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRole } /** - * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + * _t__TemplateResponse::SIGNER_ROLES * @return signerRoles */ @jakarta.annotation.Nullable @@ -428,7 +428,7 @@ public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { } /** - * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + * _t__TemplateResponse::CC_ROLES * @return ccRoles */ @jakarta.annotation.Nullable @@ -461,7 +461,7 @@ public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) } /** - * An array describing each document associated with this Template. Includes form field data for each document. + * _t__TemplateResponse::DOCUMENTS * @return documents */ @jakarta.annotation.Nullable @@ -495,7 +495,7 @@ public TemplateResponse addCustomFieldsItem(TemplateResponseDocumentCustomFieldB } /** - * Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * _t__TemplateResponseCustomField::DESCRIPTION * @return customFields * @deprecated */ @@ -532,7 +532,7 @@ public TemplateResponse addNamedFormFieldsItem(TemplateResponseDocumentFormField } /** - * Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * _t__TemplateResponseNamedFormField::DESCRIPTION * @return namedFormFields * @deprecated */ @@ -568,7 +568,7 @@ public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { } /** - * An array of the Accounts that can use this Template. + * _t__TemplateResponse::ACCOUNTS * @return accounts */ @jakarta.annotation.Nullable @@ -601,7 +601,7 @@ public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment at } /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java index 0e9d517f0..f025c1a7e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java @@ -92,7 +92,7 @@ public TemplateResponseAccount accountId(@jakarta.annotation.Nullable String acc } /** - * The id of the Account. + * _t__TemplateResponseAccount::ACCOUNT_ID * @return accountId */ @jakarta.annotation.Nullable @@ -117,7 +117,7 @@ public TemplateResponseAccount emailAddress(@jakarta.annotation.Nullable String } /** - * The email address associated with the Account. + * _t__TemplateResponseAccount::EMAIL_ADDRESS * @return emailAddress */ @jakarta.annotation.Nullable @@ -142,7 +142,7 @@ public TemplateResponseAccount isLocked(@jakarta.annotation.Nullable Boolean isL } /** - * Returns `true` if the user has been locked out of their account by a team admin. + * _t__TemplateResponseAccount::IS_LOCKED * @return isLocked */ @jakarta.annotation.Nullable @@ -167,7 +167,7 @@ public TemplateResponseAccount isPaidHs(@jakarta.annotation.Nullable Boolean isP } /** - * Returns `true` if the user has a paid Dropbox Sign account. + * _t__TemplateResponseAccount::IS_PAID_HS * @return isPaidHs */ @jakarta.annotation.Nullable @@ -192,7 +192,7 @@ public TemplateResponseAccount isPaidHf(@jakarta.annotation.Nullable Boolean isP } /** - * Returns `true` if the user has a paid HelloFax account. + * _t__TemplateResponseAccount::IS_PAID_HF * @return isPaidHf */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java index 8c0615b74..018c4c1c4 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + * _t__TemplateResponseAccountQuota::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseAccountQuota.JSON_PROPERTY_TEMPLATES_LEFT, @@ -81,7 +81,7 @@ public TemplateResponseAccountQuota templatesLeft(@jakarta.annotation.Nullable I } /** - * API templates remaining. + * _t__TemplateResponseAccountQuota::TEMPLATES_LEFT * @return templatesLeft */ @jakarta.annotation.Nullable @@ -106,7 +106,7 @@ public TemplateResponseAccountQuota apiSignatureRequestsLeft(@jakarta.annotation } /** - * API signature requests remaining. + * _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT * @return apiSignatureRequestsLeft */ @jakarta.annotation.Nullable @@ -131,7 +131,7 @@ public TemplateResponseAccountQuota documentsLeft(@jakarta.annotation.Nullable I } /** - * Signature requests remaining. + * _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT * @return documentsLeft */ @jakarta.annotation.Nullable @@ -156,7 +156,7 @@ public TemplateResponseAccountQuota smsVerificationsLeft(@jakarta.annotation.Nul } /** - * SMS verifications remaining. + * _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT * @return smsVerificationsLeft */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java index 9c25e5292..d4623ffbb 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java @@ -66,7 +66,7 @@ public TemplateResponseCCRole name(@jakarta.annotation.Nullable String name) { } /** - * The name of the Role. + * _t__TemplateResponseCCRole::NAME * @return name */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java index 2ea3ac11b..235a86f92 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java @@ -97,7 +97,7 @@ public TemplateResponseDocument name(@jakarta.annotation.Nullable String name) { } /** - * Name of the associated file. + * _t__TemplateResponseDocument::NAME * @return name */ @jakarta.annotation.Nullable @@ -122,7 +122,7 @@ public TemplateResponseDocument index(@jakarta.annotation.Nullable Integer index } /** - * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + * _t__TemplateResponseDocument::INDEX * @return index */ @jakarta.annotation.Nullable @@ -155,7 +155,7 @@ public TemplateResponseDocument addFieldGroupsItem(TemplateResponseDocumentField } /** - * An array of Form Field Group objects. + * _t__TemplateResponseDocument::FIELD_GROUPS * @return fieldGroups */ @jakarta.annotation.Nullable @@ -188,7 +188,7 @@ public TemplateResponseDocument addFormFieldsItem(TemplateResponseDocumentFormFi } /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentFormField::DESCRIPTION * @return formFields */ @jakarta.annotation.Nullable @@ -221,7 +221,7 @@ public TemplateResponseDocument addCustomFieldsItem(TemplateResponseDocumentCust } /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentCustomField::DESCRIPTION * @return customFields */ @jakarta.annotation.Nullable @@ -254,7 +254,7 @@ public TemplateResponseDocument addStaticFieldsItem(TemplateResponseDocumentStat } /** - * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * _t__TemplateResponseDocumentStaticField::DESCRIPTION * @return staticFields */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java index 80e1e9c3f..8e16c8c70 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java @@ -33,7 +33,7 @@ import com.dropbox.sign.ApiException; /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentCustomField::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, @@ -148,7 +148,7 @@ public TemplateResponseDocumentCustomFieldBase apiId(@jakarta.annotation.Nullabl } /** - * The unique ID for this field. + * _t__TemplateResponseDocumentCustomField::API_ID * @return apiId */ @jakarta.annotation.Nullable @@ -173,7 +173,7 @@ public TemplateResponseDocumentCustomFieldBase name(@jakarta.annotation.Nullable } /** - * The name of the Custom Field. + * _t__TemplateResponseDocumentCustomField::NAME * @return name */ @jakarta.annotation.Nullable @@ -202,7 +202,7 @@ public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { } /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * _t__TemplateResponseDocumentCustomField::SIGNER * @return signer */ @jakarta.annotation.Nullable @@ -231,7 +231,7 @@ public TemplateResponseDocumentCustomFieldBase x(@jakarta.annotation.Nullable In } /** - * The horizontal offset in pixels for this form field. + * _t__TemplateResponseDocumentCustomField::X * @return x */ @jakarta.annotation.Nullable @@ -256,7 +256,7 @@ public TemplateResponseDocumentCustomFieldBase y(@jakarta.annotation.Nullable In } /** - * The vertical offset in pixels for this form field. + * _t__TemplateResponseDocumentCustomField::Y * @return y */ @jakarta.annotation.Nullable @@ -281,7 +281,7 @@ public TemplateResponseDocumentCustomFieldBase width(@jakarta.annotation.Nullabl } /** - * The width in pixels of this form field. + * _t__TemplateResponseDocumentCustomField::WIDTH * @return width */ @jakarta.annotation.Nullable @@ -306,7 +306,7 @@ public TemplateResponseDocumentCustomFieldBase height(@jakarta.annotation.Nullab } /** - * The height in pixels of this form field. + * _t__TemplateResponseDocumentCustomField::HEIGHT * @return height */ @jakarta.annotation.Nullable @@ -331,7 +331,7 @@ public TemplateResponseDocumentCustomFieldBase required(@jakarta.annotation.Null } /** - * Boolean showing whether or not this field is required. + * _t__TemplateResponseDocumentStaticField::REQUIRED * @return required */ @jakarta.annotation.Nullable @@ -356,7 +356,7 @@ public TemplateResponseDocumentCustomFieldBase group(@jakarta.annotation.Nullabl } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null`. + * _t__TemplateResponseDocumentCustomField::GROUP * @return group */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java index 40a4564a3..db2bd1668 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentCustomFieldBase` + * _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentCustomFieldCheckbox.JSON_PROPERTY_TYPE @@ -75,7 +75,7 @@ public TemplateResponseDocumentCustomFieldCheckbox type(@jakarta.annotation.Nonn } /** - * The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + * _t__TemplateResponseDocumentCustomField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java index e5666932b..5ecb830b3 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java @@ -35,7 +35,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentCustomFieldBase` + * _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentCustomFieldText.JSON_PROPERTY_TYPE, @@ -96,7 +96,7 @@ public TemplateResponseDocumentCustomFieldText type(@jakarta.annotation.Nonnull } /** - * The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + * _t__TemplateResponseDocumentCustomField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -146,7 +146,7 @@ public TemplateResponseDocumentCustomFieldText isMultiline(@jakarta.annotation.N } /** - * Whether this form field is multiline text. + * _t__TemplateResponseDocumentCustomField::IS_MULTILINE * @return isMultiline */ @jakarta.annotation.Nullable @@ -171,7 +171,7 @@ public TemplateResponseDocumentCustomFieldText originalFontSize(@jakarta.annotat } /** - * Original font size used in this form field's text. + * _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE * @return originalFontSize */ @jakarta.annotation.Nullable @@ -196,7 +196,7 @@ public TemplateResponseDocumentCustomFieldText fontFamily(@jakarta.annotation.Nu } /** - * Font family used in this form field's text. + * _t__TemplateResponseDocumentCustomField::FONT_FAMILY * @return fontFamily */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java index bffee5bb0..dc76b0337 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java @@ -72,7 +72,7 @@ public TemplateResponseDocumentFieldGroup name(@jakarta.annotation.Nullable Stri } /** - * The name of the form field group. + * _t__TemplateResponseDocumentFieldGroup::NAME * @return name */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java index 8842e29df..ecaa82351 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). + * _t__TemplateResponseDocumentFieldGroup::RULE */ @JsonPropertyOrder({ TemplateResponseDocumentFieldGroupRule.JSON_PROPERTY_REQUIREMENT, @@ -71,7 +71,7 @@ public TemplateResponseDocumentFieldGroupRule requirement(@jakarta.annotation.Nu } /** - * 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. + * _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT * @return requirement */ @jakarta.annotation.Nullable @@ -96,7 +96,7 @@ public TemplateResponseDocumentFieldGroupRule groupLabel(@jakarta.annotation.Nul } /** - * Name of the group + * _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL * @return groupLabel */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java index 6256087c4..e8e552f4d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java @@ -33,7 +33,7 @@ import com.dropbox.sign.ApiException; /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentFormField::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, @@ -149,7 +149,7 @@ public TemplateResponseDocumentFormFieldBase apiId(@jakarta.annotation.Nullable } /** - * A unique id for the form field. + * _t__TemplateResponseDocumentFormField::API_ID * @return apiId */ @jakarta.annotation.Nullable @@ -174,7 +174,7 @@ public TemplateResponseDocumentFormFieldBase name(@jakarta.annotation.Nullable S } /** - * The name of the form field. + * _t__TemplateResponseDocumentFormField::NAME * @return name */ @jakarta.annotation.Nullable @@ -203,7 +203,7 @@ public TemplateResponseDocumentFormFieldBase signer(Integer signer) { } /** - * The signer of the Form Field. + * _t__TemplateResponseDocumentFormField::SIGNER * @return signer */ @jakarta.annotation.Nullable @@ -232,7 +232,7 @@ public TemplateResponseDocumentFormFieldBase x(@jakarta.annotation.Nullable Inte } /** - * The horizontal offset in pixels for this form field. + * _t__TemplateResponseDocumentFormField::X * @return x */ @jakarta.annotation.Nullable @@ -257,7 +257,7 @@ public TemplateResponseDocumentFormFieldBase y(@jakarta.annotation.Nullable Inte } /** - * The vertical offset in pixels for this form field. + * _t__TemplateResponseDocumentFormField::Y * @return y */ @jakarta.annotation.Nullable @@ -282,7 +282,7 @@ public TemplateResponseDocumentFormFieldBase width(@jakarta.annotation.Nullable } /** - * The width in pixels of this form field. + * _t__TemplateResponseDocumentFormField::WIDTH * @return width */ @jakarta.annotation.Nullable @@ -307,7 +307,7 @@ public TemplateResponseDocumentFormFieldBase height(@jakarta.annotation.Nullable } /** - * The height in pixels of this form field. + * _t__TemplateResponseDocumentFormField::HEIGHT * @return height */ @jakarta.annotation.Nullable @@ -332,7 +332,7 @@ public TemplateResponseDocumentFormFieldBase required(@jakarta.annotation.Nullab } /** - * Boolean showing whether or not this field is required. + * _t__TemplateResponseDocumentFormField::REQUIRED * @return required */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java index 81b0ce164..b009848a2 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE, @@ -80,7 +80,7 @@ public TemplateResponseDocumentFormFieldCheckbox type(@jakarta.annotation.Nonnul } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -105,7 +105,7 @@ public TemplateResponseDocumentFormFieldCheckbox group(@jakarta.annotation.Nulla } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * @return group */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java index b59e545df..b4e2df01d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE, @@ -80,7 +80,7 @@ public TemplateResponseDocumentFormFieldDateSigned type(@jakarta.annotation.Nonn } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -105,7 +105,7 @@ public TemplateResponseDocumentFormFieldDateSigned group(@jakarta.annotation.Nul } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * @return group */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java index 951081dcf..b704e1b1f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE, @@ -80,7 +80,7 @@ public TemplateResponseDocumentFormFieldDropdown type(@jakarta.annotation.Nonnul } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -105,7 +105,7 @@ public TemplateResponseDocumentFormFieldDropdown group(@jakarta.annotation.Nulla } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * @return group */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java index 5a917fa31..7ae19a94e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java @@ -35,7 +35,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_TYPE, @@ -101,7 +101,7 @@ public TemplateResponseDocumentFormFieldHyperlink type(@jakarta.annotation.Nonnu } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -151,7 +151,7 @@ public TemplateResponseDocumentFormFieldHyperlink isMultiline(@jakarta.annotatio } /** - * Whether this form field is multiline text. + * _t__TemplateResponseDocumentFormField::IS_MULTILINE * @return isMultiline */ @jakarta.annotation.Nullable @@ -176,7 +176,7 @@ public TemplateResponseDocumentFormFieldHyperlink originalFontSize(@jakarta.anno } /** - * Original font size used in this form field's text. + * _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE * @return originalFontSize */ @jakarta.annotation.Nullable @@ -201,7 +201,7 @@ public TemplateResponseDocumentFormFieldHyperlink fontFamily(@jakarta.annotation } /** - * Font family used in this form field's text. + * _t__TemplateResponseDocumentFormField::FONT_FAMILY * @return fontFamily */ @jakarta.annotation.Nullable @@ -226,7 +226,7 @@ public TemplateResponseDocumentFormFieldHyperlink group(@jakarta.annotation.Null } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * @return group */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java index 336e01632..cbc36c9bd 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE, @@ -80,7 +80,7 @@ public TemplateResponseDocumentFormFieldInitials type(@jakarta.annotation.Nonnul } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -105,7 +105,7 @@ public TemplateResponseDocumentFormFieldInitials group(@jakarta.annotation.Nulla } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * @return group */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java index 7a41f8e9c..d59788fcd 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE, @@ -80,7 +80,7 @@ public TemplateResponseDocumentFormFieldRadio type(@jakarta.annotation.Nonnull S } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -105,7 +105,7 @@ public TemplateResponseDocumentFormFieldRadio group(@jakarta.annotation.Nonnull } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * @return group */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java index 17b167c7b..3615a396d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE, @@ -80,7 +80,7 @@ public TemplateResponseDocumentFormFieldSignature type(@jakarta.annotation.Nonnu } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -105,7 +105,7 @@ public TemplateResponseDocumentFormFieldSignature group(@jakarta.annotation.Null } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * @return group */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java index 47567e1ba..685a514e7 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java @@ -35,7 +35,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentFormFieldText.JSON_PROPERTY_TYPE, @@ -77,7 +77,7 @@ public class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum private String fontFamily; /** - * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + * _t__TemplateResponseDocumentFormField::VALIDATION_TYPE */ public enum ValidationTypeEnum { NUMBERS_ONLY(String.valueOf("numbers_only")), @@ -167,7 +167,7 @@ public TemplateResponseDocumentFormFieldText type(@jakarta.annotation.Nonnull St } /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE * @return type */ @jakarta.annotation.Nonnull @@ -217,7 +217,7 @@ public TemplateResponseDocumentFormFieldText isMultiline(@jakarta.annotation.Nul } /** - * Whether this form field is multiline text. + * _t__TemplateResponseDocumentFormField::IS_MULTILINE * @return isMultiline */ @jakarta.annotation.Nullable @@ -242,7 +242,7 @@ public TemplateResponseDocumentFormFieldText originalFontSize(@jakarta.annotatio } /** - * Original font size used in this form field's text. + * _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE * @return originalFontSize */ @jakarta.annotation.Nullable @@ -267,7 +267,7 @@ public TemplateResponseDocumentFormFieldText fontFamily(@jakarta.annotation.Null } /** - * Font family used in this form field's text. + * _t__TemplateResponseDocumentFormField::FONT_FAMILY * @return fontFamily */ @jakarta.annotation.Nullable @@ -292,7 +292,7 @@ public TemplateResponseDocumentFormFieldText validationType(@jakarta.annotation. } /** - * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + * _t__TemplateResponseDocumentFormField::VALIDATION_TYPE * @return validationType */ @jakarta.annotation.Nullable @@ -317,7 +317,7 @@ public TemplateResponseDocumentFormFieldText validationCustomRegex(@jakarta.anno } /** - * When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. + * _t__TemplateResponseDocumentFormField::CUSTOM_REGEX * @return validationCustomRegex */ @jakarta.annotation.Nullable @@ -342,7 +342,7 @@ public TemplateResponseDocumentFormFieldText validationCustomRegexFormatLabel(@j } /** - * When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. + * _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL * @return validationCustomRegexFormatLabel */ @jakarta.annotation.Nullable @@ -367,7 +367,7 @@ public TemplateResponseDocumentFormFieldText group(@jakarta.annotation.Nullable } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP * @return group */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java index 06bb9773f..ff838bf16 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java @@ -33,7 +33,7 @@ import com.dropbox.sign.ApiException; /** - * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * _t__TemplateResponseDocumentStaticField::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, @@ -154,7 +154,7 @@ public TemplateResponseDocumentStaticFieldBase apiId(@jakarta.annotation.Nullabl } /** - * A unique id for the static field. + * _t__TemplateResponseDocumentStaticField::API_ID * @return apiId */ @jakarta.annotation.Nullable @@ -179,7 +179,7 @@ public TemplateResponseDocumentStaticFieldBase name(@jakarta.annotation.Nullable } /** - * The name of the static field. + * _t__TemplateResponseDocumentStaticField::NAME * @return name */ @jakarta.annotation.Nullable @@ -204,7 +204,7 @@ public TemplateResponseDocumentStaticFieldBase signer(@jakarta.annotation.Nullab } /** - * The signer of the Static Field. + * _t__TemplateResponseDocumentStaticField::SIGNER * @return signer */ @jakarta.annotation.Nullable @@ -229,7 +229,7 @@ public TemplateResponseDocumentStaticFieldBase x(@jakarta.annotation.Nullable In } /** - * The horizontal offset in pixels for this static field. + * _t__TemplateResponseDocumentStaticField::X * @return x */ @jakarta.annotation.Nullable @@ -254,7 +254,7 @@ public TemplateResponseDocumentStaticFieldBase y(@jakarta.annotation.Nullable In } /** - * The vertical offset in pixels for this static field. + * _t__TemplateResponseDocumentStaticField::Y * @return y */ @jakarta.annotation.Nullable @@ -279,7 +279,7 @@ public TemplateResponseDocumentStaticFieldBase width(@jakarta.annotation.Nullabl } /** - * The width in pixels of this static field. + * _t__TemplateResponseDocumentStaticField::WIDTH * @return width */ @jakarta.annotation.Nullable @@ -304,7 +304,7 @@ public TemplateResponseDocumentStaticFieldBase height(@jakarta.annotation.Nullab } /** - * The height in pixels of this static field. + * _t__TemplateResponseDocumentStaticField::HEIGHT * @return height */ @jakarta.annotation.Nullable @@ -329,7 +329,7 @@ public TemplateResponseDocumentStaticFieldBase required(@jakarta.annotation.Null } /** - * Boolean showing whether or not this field is required. + * _t__TemplateResponseDocumentStaticField::REQUIRED * @return required */ @jakarta.annotation.Nullable @@ -354,7 +354,7 @@ public TemplateResponseDocumentStaticFieldBase group(@jakarta.annotation.Nullabl } /** - * The name of the group this field is in. If this field is not a group, this defaults to `null`. + * _t__TemplateResponseDocumentStaticField::GROUP * @return group */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java index 81c46c3c0..e22d02f77 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldCheckbox.JSON_PROPERTY_TYPE @@ -75,7 +75,7 @@ public TemplateResponseDocumentStaticFieldCheckbox type(@jakarta.annotation.Nonn } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java index 7afedcd0a..b4ba169f0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldDateSigned.JSON_PROPERTY_TYPE @@ -75,7 +75,7 @@ public TemplateResponseDocumentStaticFieldDateSigned type(@jakarta.annotation.No } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java index 41e424629..1288a97d2 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldDropdown.JSON_PROPERTY_TYPE @@ -75,7 +75,7 @@ public TemplateResponseDocumentStaticFieldDropdown type(@jakarta.annotation.Nonn } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java index bea9d8426..b36690d2d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldHyperlink.JSON_PROPERTY_TYPE @@ -75,7 +75,7 @@ public TemplateResponseDocumentStaticFieldHyperlink type(@jakarta.annotation.Non } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java index 1ec5db416..f9a446582 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldInitials.JSON_PROPERTY_TYPE @@ -75,7 +75,7 @@ public TemplateResponseDocumentStaticFieldInitials type(@jakarta.annotation.Nonn } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java index b1401f4ca..87b1ea15d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldRadio.JSON_PROPERTY_TYPE @@ -75,7 +75,7 @@ public TemplateResponseDocumentStaticFieldRadio type(@jakarta.annotation.Nonnull } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java index f72de56c5..0eb32e562 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldSignature.JSON_PROPERTY_TYPE @@ -75,7 +75,7 @@ public TemplateResponseDocumentStaticFieldSignature type(@jakarta.annotation.Non } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java index 4d313af54..580fa1e0a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java @@ -34,7 +34,7 @@ import com.dropbox.sign.ApiException; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldText.JSON_PROPERTY_TYPE @@ -75,7 +75,7 @@ public TemplateResponseDocumentStaticFieldText type(@jakarta.annotation.Nonnull } /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE * @return type */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java index e87ce403d..7db26d500 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * Average text length in this field. + * _t__TemplateResponseFieldAvgTextLength::DESCRIPTION */ @JsonPropertyOrder({ TemplateResponseFieldAvgTextLength.JSON_PROPERTY_NUM_LINES, @@ -71,7 +71,7 @@ public TemplateResponseFieldAvgTextLength numLines(@jakarta.annotation.Nullable } /** - * Number of lines. + * _t__TemplateResponseFieldAvgTextLength::NUM_LINES * @return numLines */ @jakarta.annotation.Nullable @@ -96,7 +96,7 @@ public TemplateResponseFieldAvgTextLength numCharsPerLine(@jakarta.annotation.Nu } /** - * Number of characters per line. + * _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE * @return numCharsPerLine */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java index 6e5e2127b..ed53eddbb 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java @@ -71,7 +71,7 @@ public TemplateResponseSignerRole name(@jakarta.annotation.Nullable String name) } /** - * The name of the Role. + * _t__TemplateResponseSignerRole::NAME * @return name */ @jakarta.annotation.Nullable @@ -96,7 +96,7 @@ public TemplateResponseSignerRole order(@jakarta.annotation.Nullable Integer ord } /** - * If signer order is assigned this is the 0-based index for this role. + * _t__TemplateResponseSignerRole::ORDER * @return order */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java index 3dc17d816..aa9da3e3d 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java @@ -33,7 +33,7 @@ import com.dropbox.sign.ApiException; /** - * Contains template id + * _t__TemplateUpdateFilesResponseTemplate::DESCRIPTION */ @JsonPropertyOrder({ TemplateUpdateFilesResponseTemplate.JSON_PROPERTY_TEMPLATE_ID, @@ -75,7 +75,7 @@ public TemplateUpdateFilesResponseTemplate templateId(@jakarta.annotation.Nullab } /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID * @return templateId */ @jakarta.annotation.Nullable @@ -109,7 +109,7 @@ public TemplateUpdateFilesResponseTemplate addWarningsItem(WarningResponse warni } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings * @deprecated */ diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java index 0c762b684..e0569be51 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java @@ -53,6 +53,7 @@ UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_FILE_URLS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_CCS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, + UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -111,6 +112,10 @@ public class UnclaimedDraftCreateEmbeddedRequest { @jakarta.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @jakarta.annotation.Nullable + private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @jakarta.annotation.Nullable private Boolean allowReassign = false; @@ -450,6 +455,31 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } + public UnclaimedDraftCreateEmbeddedRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @return allowFormView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowFormView() { + return allowFormView; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + + public UnclaimedDraftCreateEmbeddedRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; @@ -489,7 +519,7 @@ public UnclaimedDraftCreateEmbeddedRequest addAttachmentsItem(SubAttachment atta } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -887,7 +917,7 @@ public UnclaimedDraftCreateEmbeddedRequest putMetadataItem(String key, Object me } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable @@ -995,7 +1025,7 @@ public UnclaimedDraftCreateEmbeddedRequest addSignersItem(SubUnclaimedDraftSigne } /** - * Add Signers to your Unclaimed Draft Signature Request. + * _t__Sub::UnclaimedDraftSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nullable @@ -1282,6 +1312,7 @@ public boolean equals(Object o) { Objects.equals(this.fileUrls, unclaimedDraftCreateEmbeddedRequest.fileUrls) && Objects.equals(this.allowCcs, unclaimedDraftCreateEmbeddedRequest.allowCcs) && Objects.equals(this.allowDecline, unclaimedDraftCreateEmbeddedRequest.allowDecline) && + Objects.equals(this.allowFormView, unclaimedDraftCreateEmbeddedRequest.allowFormView) && Objects.equals(this.allowReassign, unclaimedDraftCreateEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, unclaimedDraftCreateEmbeddedRequest.attachments) && Objects.equals(this.ccEmailAddresses, unclaimedDraftCreateEmbeddedRequest.ccEmailAddresses) && @@ -1316,7 +1347,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(clientId, requesterEmailAddress, files, fileUrls, allowCcs, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, editorOptions, fieldOptions, forceSignerPage, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, holdRequest, isForEmbeddedSigning, message, metadata, requestingRedirectUrl, showPreview, showProgressStepper, signers, signingOptions, signingRedirectUrl, skipMeNow, subject, testMode, type, usePreexistingFields, useTextTags, populateAutoFillFields, expiresAt); + return Objects.hash(clientId, requesterEmailAddress, files, fileUrls, allowCcs, allowDecline, allowFormView, allowReassign, attachments, ccEmailAddresses, customFields, editorOptions, fieldOptions, forceSignerPage, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, holdRequest, isForEmbeddedSigning, message, metadata, requestingRedirectUrl, showPreview, showProgressStepper, signers, signingOptions, signingRedirectUrl, skipMeNow, subject, testMode, type, usePreexistingFields, useTextTags, populateAutoFillFields, expiresAt); } @Override @@ -1329,6 +1360,7 @@ public String toString() { sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowCcs: ").append(toIndentedString(allowCcs)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1481,6 +1513,25 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) || + allowFormView.getClass().equals(Integer.class) || + allowFormView.getClass().equals(String.class) || + allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for(int i = 0; i< getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } + else { + map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java index 3e598be92..1ccfb9ce7 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java @@ -670,7 +670,7 @@ public UnclaimedDraftCreateEmbeddedWithTemplateRequest putMetadataItem(String ke } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable @@ -803,7 +803,7 @@ public UnclaimedDraftCreateEmbeddedWithTemplateRequest addSignersItem(SubUnclaim } /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java index 58a73751a..ded662d4b 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java @@ -50,6 +50,7 @@ UnclaimedDraftCreateRequest.JSON_PROPERTY_FILES, UnclaimedDraftCreateRequest.JSON_PROPERTY_FILE_URLS, UnclaimedDraftCreateRequest.JSON_PROPERTY_ALLOW_DECLINE, + UnclaimedDraftCreateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, UnclaimedDraftCreateRequest.JSON_PROPERTY_ATTACHMENTS, UnclaimedDraftCreateRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, UnclaimedDraftCreateRequest.JSON_PROPERTY_CLIENT_ID, @@ -125,6 +126,10 @@ public static TypeEnum fromValue(String value) { @jakarta.annotation.Nullable private Boolean allowDecline = false; + public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + @jakarta.annotation.Nullable + private Boolean allowFormView = false; + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @jakarta.annotation.Nullable private List attachments = null; @@ -339,6 +344,31 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } + public UnclaimedDraftCreateRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + return this; + } + + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @return allowFormView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowFormView() { + return allowFormView; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { + this.allowFormView = allowFormView; + } + + public UnclaimedDraftCreateRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; @@ -353,7 +383,7 @@ public UnclaimedDraftCreateRequest addAttachmentsItem(SubAttachment attachmentsI } /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION * @return attachments */ @jakarta.annotation.Nullable @@ -651,7 +681,7 @@ public UnclaimedDraftCreateRequest putMetadataItem(String key, Object metadataIt } /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION * @return metadata */ @jakarta.annotation.Nullable @@ -709,7 +739,7 @@ public UnclaimedDraftCreateRequest addSignersItem(SubUnclaimedDraftSigner signer } /** - * Add Signers to your Unclaimed Draft Signature Request. + * _t__Sub::UnclaimedDraftSigner::DESCRIPTION * @return signers */ @jakarta.annotation.Nullable @@ -919,6 +949,7 @@ public boolean equals(Object o) { Objects.equals(this.files, unclaimedDraftCreateRequest.files) && Objects.equals(this.fileUrls, unclaimedDraftCreateRequest.fileUrls) && Objects.equals(this.allowDecline, unclaimedDraftCreateRequest.allowDecline) && + Objects.equals(this.allowFormView, unclaimedDraftCreateRequest.allowFormView) && Objects.equals(this.attachments, unclaimedDraftCreateRequest.attachments) && Objects.equals(this.ccEmailAddresses, unclaimedDraftCreateRequest.ccEmailAddresses) && Objects.equals(this.clientId, unclaimedDraftCreateRequest.clientId) && @@ -943,7 +974,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(type, files, fileUrls, allowDecline, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, showProgressStepper, signers, signingOptions, signingRedirectUrl, subject, testMode, usePreexistingFields, useTextTags, expiresAt); + return Objects.hash(type, files, fileUrls, allowDecline, allowFormView, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, showProgressStepper, signers, signingOptions, signingRedirectUrl, subject, testMode, usePreexistingFields, useTextTags, expiresAt); } @Override @@ -954,6 +985,7 @@ public String toString() { sb.append(" files: ").append(toIndentedString(files)).append("\n"); sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -1058,6 +1090,25 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } + if (allowFormView != null) { + if (isFileTypeOrListOfFiles(allowFormView)) { + fileTypeFound = true; + } + + if (allowFormView.getClass().equals(java.io.File.class) || + allowFormView.getClass().equals(Integer.class) || + allowFormView.getClass().equals(String.class) || + allowFormView.getClass().isEnum()) { + map.put("allow_form_view", allowFormView); + } else if (isListOfFile(allowFormView)) { + for(int i = 0; i< getListSize(allowFormView); i++) { + map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + } + } + else { + map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + } + } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java index 48eabe481..503e4466b 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java @@ -108,7 +108,7 @@ public UnclaimedDraftCreateResponse addWarningsItem(WarningResponse warningsItem } /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * @return warnings */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java index b5152809e..1c8da84ec 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * A group of documents that a user can take ownership of via the claim URL. + * _t__UnclaimedDraftResponse::DESCRIPTION */ @JsonPropertyOrder({ UnclaimedDraftResponse.JSON_PROPERTY_SIGNATURE_REQUEST_ID, @@ -91,7 +91,7 @@ public UnclaimedDraftResponse signatureRequestId(@jakarta.annotation.Nullable St } /** - * The ID of the signature request that is represented by this UnclaimedDraft. + * _t__UnclaimedDraft::SIGNATURE_REQUEST_ID * @return signatureRequestId */ @jakarta.annotation.Nullable @@ -116,7 +116,7 @@ public UnclaimedDraftResponse claimUrl(@jakarta.annotation.Nullable String claim } /** - * The URL to be used to claim this UnclaimedDraft. + * _t__UnclaimedDraft::CLAIM_URL * @return claimUrl */ @jakarta.annotation.Nullable @@ -141,7 +141,7 @@ public UnclaimedDraftResponse signingRedirectUrl(@jakarta.annotation.Nullable St } /** - * The URL you want signers redirected to after they successfully sign. + * _t__UnclaimedDraft::SIGNING_REDIRECT_URL * @return signingRedirectUrl */ @jakarta.annotation.Nullable @@ -166,7 +166,7 @@ public UnclaimedDraftResponse requestingRedirectUrl(@jakarta.annotation.Nullable } /** - * The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). + * _t__UnclaimedDraft::REQUESTING_REDIRECT_URL * @return requestingRedirectUrl */ @jakarta.annotation.Nullable @@ -191,7 +191,7 @@ public UnclaimedDraftResponse expiresAt(@jakarta.annotation.Nullable Integer exp } /** - * When the link expires. + * _t__UnclaimedDraft::EXPIRES_AT * @return expiresAt */ @jakarta.annotation.Nullable @@ -216,7 +216,7 @@ public UnclaimedDraftResponse testMode(@jakarta.annotation.Nullable Boolean test } /** - * Whether this is a test draft. Signature requests made from test drafts have no legal value. + * _t__UnclaimedDraft::TEST_MODE * @return testMode */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/WarningResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/WarningResponse.java index d8e314cb0..98bb550ab 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/WarningResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/WarningResponse.java @@ -30,7 +30,7 @@ import com.dropbox.sign.ApiException; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ @JsonPropertyOrder({ WarningResponse.JSON_PROPERTY_WARNING_MSG, @@ -71,7 +71,7 @@ public WarningResponse warningMsg(@jakarta.annotation.Nonnull String warningMsg) } /** - * Warning message + * _t__WarningResponse::WARNING_MSG * @return warningMsg */ @jakarta.annotation.Nonnull @@ -96,7 +96,7 @@ public WarningResponse warningName(@jakarta.annotation.Nonnull String warningNam } /** - * Warning name + * _t__WarningResponse::WARNING_NAME * @return warningName */ @jakarta.annotation.Nonnull diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 943de1b8c..c43edbe70 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -17470,7 +17470,7 @@ var BulkSendJobGetResponse = class _BulkSendJobGetResponse { var BulkSendJobGetResponseSignatureRequests = class _BulkSendJobGetResponseSignatureRequests { constructor() { /** - * Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + * _t__SignatureRequestResponse::TEST_MODE */ this["testMode"] = false; } @@ -17724,6 +17724,10 @@ var EmbeddedEditUrlRequest = class _EmbeddedEditUrlRequest { * This allows the requester to enable/disable to add or change CC roles when editing the template. */ this["allowEditCcs"] = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + this["allowFormView"] = false; /** * Provide users the ability to review/edit the template signer roles. */ @@ -17759,6 +17763,11 @@ var EmbeddedEditUrlRequest = class _EmbeddedEditUrlRequest { baseName: "allow_edit_ccs", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "ccRoles", baseName: "cc_roles", @@ -19239,6 +19248,7 @@ var ReportCreateRequest = class _ReportCreateRequest { ((ReportTypeEnum2) => { ReportTypeEnum2["UserActivity"] = "user_activity"; ReportTypeEnum2["DocumentStatus"] = "document_status"; + ReportTypeEnum2["SmsActivity"] = "sms_activity"; })(ReportTypeEnum = ReportCreateRequest2.ReportTypeEnum || (ReportCreateRequest2.ReportTypeEnum = {})); })(ReportCreateRequest || (ReportCreateRequest = {})); @@ -19312,6 +19322,7 @@ var ReportResponse = class _ReportResponse { ((ReportTypeEnum2) => { ReportTypeEnum2["UserActivity"] = "user_activity"; ReportTypeEnum2["DocumentStatus"] = "document_status"; + ReportTypeEnum2["SmsActivity"] = "sms_activity"; })(ReportTypeEnum = ReportResponse2.ReportTypeEnum || (ReportResponse2.ReportTypeEnum = {})); })(ReportResponse || (ReportResponse = {})); @@ -19514,6 +19525,10 @@ var SignatureRequestCreateEmbeddedRequest = class _SignatureRequestCreateEmbedde * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + this["allowFormView"] = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. */ @@ -19570,6 +19585,11 @@ var SignatureRequestCreateEmbeddedRequest = class _SignatureRequestCreateEmbedde baseName: "allow_decline", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "allowReassign", baseName: "allow_reassign", @@ -19791,6 +19811,10 @@ var SignatureRequestEditEmbeddedRequest = class _SignatureRequestEditEmbeddedReq * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + this["allowFormView"] = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. */ @@ -19847,6 +19871,11 @@ var SignatureRequestEditEmbeddedRequest = class _SignatureRequestEditEmbeddedReq baseName: "allow_decline", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "allowReassign", baseName: "allow_reassign", @@ -20068,6 +20097,10 @@ var SignatureRequestEditRequest = class _SignatureRequestEditRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + this["allowFormView"] = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ @@ -20119,6 +20152,11 @@ var SignatureRequestEditRequest = class _SignatureRequestEditRequest { baseName: "allow_decline", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "allowReassign", baseName: "allow_reassign", @@ -20438,7 +20476,7 @@ var SignatureRequestRemindRequest = class _SignatureRequestRemindRequest { var SignatureRequestResponse = class _SignatureRequestResponse { constructor() { /** - * Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + * _t__SignatureRequestResponse::TEST_MODE */ this["testMode"] = false; } @@ -20690,7 +20728,7 @@ var SignatureRequestResponseCustomFieldCheckbox = class _SignatureRequestRespons constructor() { super(...arguments); /** - * The type of this Custom Field. Only \'text\' and \'checkbox\' are currently supported. + * _t__SignatureRequestResponseCustomField::TYPE */ this["type"] = "checkbox"; } @@ -20728,7 +20766,7 @@ var SignatureRequestResponseCustomFieldText = class _SignatureRequestResponseCus constructor() { super(...arguments); /** - * The type of this Custom Field. Only \'text\' and \'checkbox\' are currently supported. + * _t__SignatureRequestResponseCustomField::TYPE */ this["type"] = "text"; } @@ -20859,7 +20897,7 @@ var SignatureRequestResponseDataValueCheckbox = class _SignatureRequestResponseD constructor() { super(...arguments); /** - * A yes/no checkbox + * _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE */ this["type"] = "checkbox"; } @@ -20897,7 +20935,7 @@ var SignatureRequestResponseDataValueCheckboxMerge = class _SignatureRequestResp constructor() { super(...arguments); /** - * A checkbox field that has default value set by the api + * _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE */ this["type"] = "checkbox-merge"; } @@ -20935,7 +20973,7 @@ var SignatureRequestResponseDataValueDateSigned = class _SignatureRequestRespons constructor() { super(...arguments); /** - * A date + * _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE */ this["type"] = "date_signed"; } @@ -20973,7 +21011,7 @@ var SignatureRequestResponseDataValueDropdown = class _SignatureRequestResponseD constructor() { super(...arguments); /** - * An input field for dropdowns + * _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE */ this["type"] = "dropdown"; } @@ -21011,7 +21049,7 @@ var SignatureRequestResponseDataValueInitials = class _SignatureRequestResponseD constructor() { super(...arguments); /** - * An input field for initials + * _t__SignatureRequestResponseDataValue::INITIAL_TYPE */ this["type"] = "initials"; } @@ -21054,7 +21092,7 @@ var SignatureRequestResponseDataValueRadio = class _SignatureRequestResponseData constructor() { super(...arguments); /** - * An input field for radios + * _t__SignatureRequestResponseDataValue::RADIO_TYPE */ this["type"] = "radio"; } @@ -21092,7 +21130,7 @@ var SignatureRequestResponseDataValueSignature = class _SignatureRequestResponse constructor() { super(...arguments); /** - * A signature input field + * _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE */ this["type"] = "signature"; } @@ -21135,7 +21173,7 @@ var SignatureRequestResponseDataValueText = class _SignatureRequestResponseDataV constructor() { super(...arguments); /** - * A text input field + * _t__SignatureRequestResponseDataValue::TEXT_TYPE */ this["type"] = "text"; } @@ -21173,7 +21211,7 @@ var SignatureRequestResponseDataValueTextMerge = class _SignatureRequestResponse constructor() { super(...arguments); /** - * A text field that has default text set by the api + * _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE */ this["type"] = "text-merge"; } @@ -21333,6 +21371,10 @@ var SignatureRequestSendRequest = class _SignatureRequestSendRequest { * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ this["allowReassign"] = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + this["allowFormView"] = false; /** * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. */ @@ -21391,6 +21433,11 @@ var SignatureRequestSendRequest = class _SignatureRequestSendRequest { baseName: "allow_reassign", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "attachments", baseName: "attachments", @@ -22737,7 +22784,7 @@ var SubFormFieldsPerDocumentTextMerge = class _SubFormFieldsPerDocumentTextMerge constructor() { super(...arguments); /** - * A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. + * _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE */ this["type"] = "text-merge"; /** @@ -22895,7 +22942,7 @@ var SubOAuth = class _SubOAuth { var SubOptions = class _SubOptions { constructor() { /** - * Determines if signers can use \"Insert Everywhere\" when signing a document. + * _t__Sub::Options::CAN_INSERT_EVERYWHERE */ this["canInsertEverywhere"] = false; } @@ -23073,19 +23120,19 @@ var SubSignatureRequestTemplateSigner = class _SubSignatureRequestTemplateSigner var SubSigningOptions = class _SubSigningOptions { constructor() { /** - * Allows drawing the signature + * _t__Sub::SigningOptions::DRAW */ this["draw"] = false; /** - * Allows using a smartphone to email the signature + * _t__Sub::SigningOptions::PHONE */ this["phone"] = false; /** - * Allows typing the signature + * _t__Sub::SigningOptions::TYPE */ this["type"] = false; /** - * Allows uploading the signature + * _t__Sub::SigningOptions::UPLOAD */ this["upload"] = false; } @@ -23916,6 +23963,10 @@ var TemplateCreateEmbeddedDraftRequest = class _TemplateCreateEmbeddedDraftReque * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ this["allowReassign"] = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + this["allowFormView"] = false; /** * Provide users the ability to review/edit the template signer roles. */ @@ -23975,6 +24026,11 @@ var TemplateCreateEmbeddedDraftRequest = class _TemplateCreateEmbeddedDraftReque baseName: "allow_reassign", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "attachments", baseName: "attachments", @@ -24168,6 +24224,10 @@ var TemplateCreateRequest = class _TemplateCreateRequest { * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ this["allowReassign"] = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + this["allowFormView"] = false; /** * Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. */ @@ -24207,6 +24267,11 @@ var TemplateCreateRequest = class _TemplateCreateRequest { baseName: "allow_reassign", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "attachments", baseName: "attachments", @@ -24782,7 +24847,7 @@ var TemplateResponseDocumentCustomFieldCheckbox = class _TemplateResponseDocumen constructor() { super(...arguments); /** - * The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + * _t__TemplateResponseDocumentCustomField::TYPE */ this["type"] = "checkbox"; } @@ -24815,7 +24880,7 @@ var TemplateResponseDocumentCustomFieldText = class _TemplateResponseDocumentCus constructor() { super(...arguments); /** - * The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + * _t__TemplateResponseDocumentCustomField::TYPE */ this["type"] = "text"; } @@ -25019,7 +25084,7 @@ var TemplateResponseDocumentFormFieldCheckbox = class _TemplateResponseDocumentF constructor() { super(...arguments); /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ this["type"] = "checkbox"; } @@ -25057,7 +25122,7 @@ var TemplateResponseDocumentFormFieldDateSigned = class _TemplateResponseDocumen constructor() { super(...arguments); /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ this["type"] = "date_signed"; } @@ -25095,7 +25160,7 @@ var TemplateResponseDocumentFormFieldDropdown = class _TemplateResponseDocumentF constructor() { super(...arguments); /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ this["type"] = "dropdown"; } @@ -25133,7 +25198,7 @@ var TemplateResponseDocumentFormFieldHyperlink = class _TemplateResponseDocument constructor() { super(...arguments); /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ this["type"] = "hyperlink"; } @@ -25191,7 +25256,7 @@ var TemplateResponseDocumentFormFieldInitials = class _TemplateResponseDocumentF constructor() { super(...arguments); /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ this["type"] = "initials"; } @@ -25229,7 +25294,7 @@ var TemplateResponseDocumentFormFieldRadio = class _TemplateResponseDocumentForm constructor() { super(...arguments); /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ this["type"] = "radio"; } @@ -25267,7 +25332,7 @@ var TemplateResponseDocumentFormFieldSignature = class _TemplateResponseDocument constructor() { super(...arguments); /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ this["type"] = "signature"; } @@ -25305,7 +25370,7 @@ var TemplateResponseDocumentFormFieldText = class _TemplateResponseDocumentFormF constructor() { super(...arguments); /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ this["type"] = "text"; } @@ -25392,7 +25457,7 @@ var TemplateResponseDocumentFormFieldText = class _TemplateResponseDocumentFormF var TemplateResponseDocumentStaticFieldBase = class _TemplateResponseDocumentStaticFieldBase { constructor() { /** - * The signer of the Static Field. + * _t__TemplateResponseDocumentStaticField::SIGNER */ this["signer"] = "me_now"; } @@ -25493,7 +25558,7 @@ var TemplateResponseDocumentStaticFieldCheckbox = class _TemplateResponseDocumen constructor() { super(...arguments); /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ this["type"] = "checkbox"; } @@ -25526,7 +25591,7 @@ var TemplateResponseDocumentStaticFieldDateSigned = class _TemplateResponseDocum constructor() { super(...arguments); /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ this["type"] = "date_signed"; } @@ -25559,7 +25624,7 @@ var TemplateResponseDocumentStaticFieldDropdown = class _TemplateResponseDocumen constructor() { super(...arguments); /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ this["type"] = "dropdown"; } @@ -25592,7 +25657,7 @@ var TemplateResponseDocumentStaticFieldHyperlink = class _TemplateResponseDocume constructor() { super(...arguments); /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ this["type"] = "hyperlink"; } @@ -25625,7 +25690,7 @@ var TemplateResponseDocumentStaticFieldInitials = class _TemplateResponseDocumen constructor() { super(...arguments); /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ this["type"] = "initials"; } @@ -25658,7 +25723,7 @@ var TemplateResponseDocumentStaticFieldRadio = class _TemplateResponseDocumentSt constructor() { super(...arguments); /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ this["type"] = "radio"; } @@ -25691,7 +25756,7 @@ var TemplateResponseDocumentStaticFieldSignature = class _TemplateResponseDocume constructor() { super(...arguments); /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ this["type"] = "signature"; } @@ -25724,7 +25789,7 @@ var TemplateResponseDocumentStaticFieldText = class _TemplateResponseDocumentSta constructor() { super(...arguments); /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ this["type"] = "text"; } @@ -25930,6 +25995,10 @@ var UnclaimedDraftCreateEmbeddedRequest = class _UnclaimedDraftCreateEmbeddedReq * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + this["allowFormView"] = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ @@ -26018,6 +26087,11 @@ var UnclaimedDraftCreateEmbeddedRequest = class _UnclaimedDraftCreateEmbeddedReq baseName: "allow_decline", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "allowReassign", baseName: "allow_reassign", @@ -26421,6 +26495,10 @@ var UnclaimedDraftCreateRequest = class _UnclaimedDraftCreateRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + this["allowFormView"] = false; /** * Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. */ @@ -26467,6 +26545,11 @@ var UnclaimedDraftCreateRequest = class _UnclaimedDraftCreateRequest { baseName: "allow_decline", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "attachments", baseName: "attachments", diff --git a/sdks/node/docs/model/AccountCreateResponse.md b/sdks/node/docs/model/AccountCreateResponse.md index 203a7e73d..e89ea5068 100644 --- a/sdks/node/docs/model/AccountCreateResponse.md +++ b/sdks/node/docs/model/AccountCreateResponse.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | | `oauthData` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/AccountGetResponse.md b/sdks/node/docs/model/AccountGetResponse.md index 38a4eeefe..2275e7da2 100644 --- a/sdks/node/docs/model/AccountGetResponse.md +++ b/sdks/node/docs/model/AccountGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/AccountResponse.md b/sdks/node/docs/model/AccountResponse.md index b24e1638f..26c3e7620 100644 --- a/sdks/node/docs/model/AccountResponse.md +++ b/sdks/node/docs/model/AccountResponse.md @@ -6,16 +6,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `accountId` | ```string``` | The ID of the Account | | -| `emailAddress` | ```string``` | The email address associated with the Account. | | -| `isLocked` | ```boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `accountId` | ```string``` | _t__Account::ACCOUNT_ID | | +| `emailAddress` | ```string``` | _t__Account::EMAIL_ADDRESS | | +| `isLocked` | ```boolean``` | _t__Account::IS_LOCKED | | +| `isPaidHs` | ```boolean``` | _t__Account::IS_PAID_HS | | +| `isPaidHf` | ```boolean``` | _t__Account::IS_PAID_HF | | | `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | -| `callbackUrl` | ```string``` | The URL that Dropbox Sign events will `POST` to. | | -| `roleCode` | ```string``` | The membership role for the team. | | -| `teamId` | ```string``` | The id of the team account belongs to. | | -| `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. | | +| `callbackUrl` | ```string``` | _t__Account::CALLBACK_URL | | +| `roleCode` | ```string``` | _t__Account::ROLE_CODE | | +| `teamId` | ```string``` | _t__Account::TEAM_ID | | +| `locale` | ```string``` | _t__Account::LOCALE | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/AccountResponseQuotas.md b/sdks/node/docs/model/AccountResponseQuotas.md index bc02d3242..30e6927e7 100644 --- a/sdks/node/docs/model/AccountResponseQuotas.md +++ b/sdks/node/docs/model/AccountResponseQuotas.md @@ -1,16 +1,16 @@ # # AccountResponseQuotas -Details concerning remaining monthly quotas. +_t__Account::QUOTA ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | | -| `documentsLeft` | ```number``` | Signature requests remaining. | | -| `templatesTotal` | ```number``` | Total API templates allowed. | | -| `templatesLeft` | ```number``` | API templates remaining. | | -| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | -| `numFaxPagesLeft` | ```number``` | Number of fax pages left | | +| `apiSignatureRequestsLeft` | ```number``` | _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documentsLeft` | ```number``` | _t__AccountQuota::DOCUMENTS_LEFT | | +| `templatesTotal` | ```number``` | _t__AccountQuota::TEMPLATES_TOTAL | | +| `templatesLeft` | ```number``` | _t__AccountQuota::TEMPLATES_LEFT | | +| `smsVerificationsLeft` | ```number``` | _t__AccountQuota::SMS_VERIFICATIONS_LEFT | | +| `numFaxPagesLeft` | ```number``` | _t__AccountQuota::NUM_FAX_PAGES_LEFT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/AccountResponseUsage.md b/sdks/node/docs/model/AccountResponseUsage.md index 2f095fba9..e2e420efb 100644 --- a/sdks/node/docs/model/AccountResponseUsage.md +++ b/sdks/node/docs/model/AccountResponseUsage.md @@ -1,11 +1,11 @@ # # AccountResponseUsage -Details concerning monthly usage +_t__Account::USAGE ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `faxPagesSent` | ```number``` | Number of fax pages sent | | +| `faxPagesSent` | ```number``` | _t__AccountUsage::FAX_PAGES_SENT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/AccountVerifyResponse.md b/sdks/node/docs/model/AccountVerifyResponse.md index 19094d2df..4aab0a21a 100644 --- a/sdks/node/docs/model/AccountVerifyResponse.md +++ b/sdks/node/docs/model/AccountVerifyResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `account` | [```AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/AccountVerifyResponseAccount.md b/sdks/node/docs/model/AccountVerifyResponseAccount.md index e0756d990..3c732f461 100644 --- a/sdks/node/docs/model/AccountVerifyResponseAccount.md +++ b/sdks/node/docs/model/AccountVerifyResponseAccount.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `emailAddress` | ```string``` | The email address associated with the Account. | | +| `emailAddress` | ```string``` | _t__Account::EMAIL_ADDRESS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ApiAppGetResponse.md b/sdks/node/docs/model/ApiAppGetResponse.md index a3f95b71c..264013977 100644 --- a/sdks/node/docs/model/ApiAppGetResponse.md +++ b/sdks/node/docs/model/ApiAppGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `apiApp`*_required_ | [```ApiAppResponse```](ApiAppResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ApiAppListResponse.md b/sdks/node/docs/model/ApiAppListResponse.md index 24dd3d3d2..26106d328 100644 --- a/sdks/node/docs/model/ApiAppListResponse.md +++ b/sdks/node/docs/model/ApiAppListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `apiApps`*_required_ | [```Array```](ApiAppResponse.md) | Contains information about API Apps. | | +| `apiApps`*_required_ | [```Array```](ApiAppResponse.md) | _t__ApiAppListResponse::DESCRIPTION | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ApiAppResponse.md b/sdks/node/docs/model/ApiAppResponse.md index 4c0e4a9ca..0bcaf6059 100644 --- a/sdks/node/docs/model/ApiAppResponse.md +++ b/sdks/node/docs/model/ApiAppResponse.md @@ -1,17 +1,17 @@ # # ApiAppResponse -Contains information about an API App. +_t__ApiAppResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callbackUrl` | ```string``` | The app's callback URL (for events) | | -| `clientId` | ```string``` | The app's client id | | -| `createdAt` | ```number``` | The time that the app was created | | -| `domains` | ```Array``` | The domain name(s) associated with the app | | -| `name` | ```string``` | The name of the app | | -| `isApproved` | ```boolean``` | Boolean to indicate if the app has been approved | | +| `callbackUrl` | ```string``` | _t__ApiAppResponse::CALLBACK_URL | | +| `clientId` | ```string``` | _t__ApiAppResponse::CLIENT_ID | | +| `createdAt` | ```number``` | _t__ApiAppResponse::CREATED_AT | | +| `domains` | ```Array``` | _t__ApiAppResponse::DOMAINS | | +| `name` | ```string``` | _t__ApiAppResponse::NAME | | +| `isApproved` | ```boolean``` | _t__ApiAppResponse::IS_APPROVED | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | | `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | | `ownerAccount` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | diff --git a/sdks/node/docs/model/ApiAppResponseOAuth.md b/sdks/node/docs/model/ApiAppResponseOAuth.md index 5f3376c3e..7be512256 100644 --- a/sdks/node/docs/model/ApiAppResponseOAuth.md +++ b/sdks/node/docs/model/ApiAppResponseOAuth.md @@ -1,14 +1,14 @@ # # ApiAppResponseOAuth -An object describing the app's OAuth properties, or null if OAuth is not configured for the app. +_t__ApiAppResponseOAuth::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callbackUrl` | ```string``` | The app's OAuth callback URL. | | -| `secret` | ```string``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```Array``` | Array of OAuth scopes used by the app. | | -| `chargesUsers` | ```boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callbackUrl` | ```string``` | _t__ApiAppResponseOAuth::CALLBACK_URL | | +| `secret` | ```string``` | _t__ApiAppResponseOAuth::SECRET | | +| `scopes` | ```Array``` | _t__ApiAppResponseOAuth::SCOPES | | +| `chargesUsers` | ```boolean``` | _t__ApiAppResponseOAuth::CHARGES_USERS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ApiAppResponseOptions.md b/sdks/node/docs/model/ApiAppResponseOptions.md index 2a3fcbabc..aa61245d6 100644 --- a/sdks/node/docs/model/ApiAppResponseOptions.md +++ b/sdks/node/docs/model/ApiAppResponseOptions.md @@ -1,11 +1,11 @@ # # ApiAppResponseOptions -An object with options that override account settings. +_t__ApiAppResponseOptions::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `canInsertEverywhere` | ```boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `canInsertEverywhere` | ```boolean``` | _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ApiAppResponseOwnerAccount.md b/sdks/node/docs/model/ApiAppResponseOwnerAccount.md index 5d1001008..4da7e2849 100644 --- a/sdks/node/docs/model/ApiAppResponseOwnerAccount.md +++ b/sdks/node/docs/model/ApiAppResponseOwnerAccount.md @@ -1,12 +1,12 @@ # # ApiAppResponseOwnerAccount -An object describing the app's owner +_t__ApiAppResponseOwnerAccount::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `accountId` | ```string``` | The owner account's ID | | -| `emailAddress` | ```string``` | The owner account's email address | | +| `accountId` | ```string``` | _t__ApiAppResponseOwnerAccount::ACCOUNT_ID | | +| `emailAddress` | ```string``` | _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md b/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md index 927f4521e..8854a8748 100644 --- a/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/node/docs/model/ApiAppResponseWhiteLabelingOptions.md @@ -1,6 +1,6 @@ # # ApiAppResponseWhiteLabelingOptions -An object with options to customize the app's signer page +_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION ## Properties diff --git a/sdks/node/docs/model/BulkSendJobGetResponse.md b/sdks/node/docs/model/BulkSendJobGetResponse.md index b0c299fce..27078fc16 100644 --- a/sdks/node/docs/model/BulkSendJobGetResponse.md +++ b/sdks/node/docs/model/BulkSendJobGetResponse.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `signatureRequests`*_required_ | [```Array```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `signatureRequests`*_required_ | [```Array```](BulkSendJobGetResponseSignatureRequests.md) | _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/BulkSendJobGetResponseSignatureRequests.md b/sdks/node/docs/model/BulkSendJobGetResponseSignatureRequests.md index fe84b808e..a27c8c323 100644 --- a/sdks/node/docs/model/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/node/docs/model/BulkSendJobGetResponseSignatureRequests.md @@ -6,30 +6,30 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `testMode` | ```boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | -| `signatureRequestId` | ```string``` | The id of the SignatureRequest. | | -| `requesterEmailAddress` | ```string``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```string``` | The title the specified Account uses for the SignatureRequest. | | -| `originalTitle` | ```string``` | Default Label for account. | | -| `subject` | ```string``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```string``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | The metadata attached to the signature request. | | -| `createdAt` | ```number``` | Time the signature request was created. | | -| `expiresAt` | ```number``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `isComplete` | ```boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `isDeclined` | ```boolean``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `hasError` | ```boolean``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `filesUrl` | ```string``` | The URL where a copy of the request's documents can be downloaded. | | -| `signingUrl` | ```string``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `detailsUrl` | ```string``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `ccEmailAddresses` | ```Array``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signingRedirectUrl` | ```string``` | The URL you want the signer redirected to after they successfully sign. | | -| `finalCopyUri` | ```string``` | The path where the completed document can be downloaded | | -| `templateIds` | ```Array``` | Templates IDs used in this SignatureRequest (if any). | | -| `customFields` | [```Array```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `responseData` | [```Array```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulkSendJobId` | ```string``` | The id of the BulkSendJob. | | +| `testMode` | ```boolean``` | _t__SignatureRequestResponse::TEST_MODE | [default to false] | +| `signatureRequestId` | ```string``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requesterEmailAddress` | ```string``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```string``` | _t__SignatureRequestResponse::TITLE | | +| `originalTitle` | ```string``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```string``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```string``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```{ [key: string]: any; }``` | _t__SignatureRequestResponse::METADATA | | +| `createdAt` | ```number``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expiresAt` | ```number``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `isComplete` | ```boolean``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `isDeclined` | ```boolean``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `hasError` | ```boolean``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `filesUrl` | ```string``` | _t__SignatureRequestResponse::FILES_URL | | +| `signingUrl` | ```string``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `detailsUrl` | ```string``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `ccEmailAddresses` | ```Array``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signingRedirectUrl` | ```string``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `finalCopyUri` | ```string``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `templateIds` | ```Array``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `customFields` | [```Array```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `responseData` | [```Array```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulkSendJobId` | ```string``` | _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/BulkSendJobListResponse.md b/sdks/node/docs/model/BulkSendJobListResponse.md index e9be32a88..e119e6104 100644 --- a/sdks/node/docs/model/BulkSendJobListResponse.md +++ b/sdks/node/docs/model/BulkSendJobListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulkSendJobs`*_required_ | [```Array```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | +| `bulkSendJobs`*_required_ | [```Array```](BulkSendJobResponse.md) | _t__BulkSendJobListResponse::BULK_SEND_JOBS | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/BulkSendJobResponse.md b/sdks/node/docs/model/BulkSendJobResponse.md index ecafe7ede..a11907618 100644 --- a/sdks/node/docs/model/BulkSendJobResponse.md +++ b/sdks/node/docs/model/BulkSendJobResponse.md @@ -1,14 +1,14 @@ # # BulkSendJobResponse -Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. +_t__BulkSendJobResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulkSendJobId` | ```string``` | The id of the BulkSendJob. | | -| `total` | ```number``` | The total amount of Signature Requests queued for sending. | | -| `isCreator` | ```boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `createdAt` | ```number``` | Time that the BulkSendJob was created. | | +| `bulkSendJobId` | ```string``` | _t__BulkSendJobResponse::BULK_SEND_JOB_ID | | +| `total` | ```number``` | _t__BulkSendJobResponse::TOTAL | | +| `isCreator` | ```boolean``` | _t__BulkSendJobResponse::IS_CREATOR | | +| `createdAt` | ```number``` | _t__BulkSendJobResponse::CREATED_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/BulkSendJobSendResponse.md b/sdks/node/docs/model/BulkSendJobSendResponse.md index 3619bdf29..08df8685c 100644 --- a/sdks/node/docs/model/BulkSendJobSendResponse.md +++ b/sdks/node/docs/model/BulkSendJobSendResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/EmbeddedEditUrlRequest.md b/sdks/node/docs/model/EmbeddedEditUrlRequest.md index 8430803ea..c19e59cde 100644 --- a/sdks/node/docs/model/EmbeddedEditUrlRequest.md +++ b/sdks/node/docs/model/EmbeddedEditUrlRequest.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `allowEditCcs` | ```boolean``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to false] | +| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `ccRoles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `forceSignerRoles` | ```boolean``` | Provide users the ability to review/edit the template signer roles. | [default to false] | diff --git a/sdks/node/docs/model/EmbeddedEditUrlResponse.md b/sdks/node/docs/model/EmbeddedEditUrlResponse.md index ed7cccca8..241d7922a 100644 --- a/sdks/node/docs/model/EmbeddedEditUrlResponse.md +++ b/sdks/node/docs/model/EmbeddedEditUrlResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `embedded`*_required_ | [```EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/EmbeddedEditUrlResponseEmbedded.md b/sdks/node/docs/model/EmbeddedEditUrlResponseEmbedded.md index 55663c9dc..e3baa932c 100644 --- a/sdks/node/docs/model/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/node/docs/model/EmbeddedEditUrlResponseEmbedded.md @@ -1,12 +1,12 @@ # # EmbeddedEditUrlResponseEmbedded -An embedded template object. +_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `editUrl` | ```string``` | A template url that can be opened in an iFrame. | | -| `expiresAt` | ```number``` | The specific time that the the `edit_url` link expires, in epoch. | | +| `editUrl` | ```string``` | _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL | | +| `expiresAt` | ```number``` | _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/EmbeddedSignUrlResponse.md b/sdks/node/docs/model/EmbeddedSignUrlResponse.md index fdcb5e5d8..d7065a948 100644 --- a/sdks/node/docs/model/EmbeddedSignUrlResponse.md +++ b/sdks/node/docs/model/EmbeddedSignUrlResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `embedded`*_required_ | [```EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/EmbeddedSignUrlResponseEmbedded.md b/sdks/node/docs/model/EmbeddedSignUrlResponseEmbedded.md index 601fe4b4c..06b2cfe97 100644 --- a/sdks/node/docs/model/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/node/docs/model/EmbeddedSignUrlResponseEmbedded.md @@ -1,12 +1,12 @@ # # EmbeddedSignUrlResponseEmbedded -An object that contains necessary information to set up embedded signing. +_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signUrl` | ```string``` | A signature url that can be opened in an iFrame. | | -| `expiresAt` | ```number``` | The specific time that the the `sign_url` link expires, in epoch. | | +| `signUrl` | ```string``` | _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL | | +| `expiresAt` | ```number``` | _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ErrorResponseError.md b/sdks/node/docs/model/ErrorResponseError.md index 38ca84b82..36666f6e0 100644 --- a/sdks/node/docs/model/ErrorResponseError.md +++ b/sdks/node/docs/model/ErrorResponseError.md @@ -1,13 +1,13 @@ # # ErrorResponseError -Contains information about an error that occurred. +_t__ErrorResponseError::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `errorMsg`*_required_ | ```string``` | Message describing an error. | | -| `errorName`*_required_ | ```string``` | Name of the error. | | -| `errorPath` | ```string``` | Path at which an error occurred. | | +| `errorMsg`*_required_ | ```string``` | _t__ErrorResponseError::ERROR_MSG | | +| `errorName`*_required_ | ```string``` | _t__ErrorResponseError::ERROR_NAME | | +| `errorPath` | ```string``` | _t__ErrorResponseError::ERROR_PATH | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/EventCallbackRequestEvent.md b/sdks/node/docs/model/EventCallbackRequestEvent.md index e0f1dc87e..5fe3e8f2f 100644 --- a/sdks/node/docs/model/EventCallbackRequestEvent.md +++ b/sdks/node/docs/model/EventCallbackRequestEvent.md @@ -1,14 +1,14 @@ # # EventCallbackRequestEvent -Basic information about the event that occurred. +_t__EventCallbackRequestEvent::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `eventTime`*_required_ | ```string``` | Time the event was created (using Unix time). | | -| `eventType`*_required_ | ```string``` | Type of callback event that was triggered. | | -| `eventHash`*_required_ | ```string``` | Generated hash used to verify source of event data. | | +| `eventTime`*_required_ | ```string``` | _t__EventCallbackRequestEvent::EVENT_TIME | | +| `eventType`*_required_ | ```string``` | _t__EventCallbackRequestEvent::EVENT_TYPE | | +| `eventHash`*_required_ | ```string``` | _t__EventCallbackRequestEvent::EVENT_HASH | | | `eventMetadata` | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/EventCallbackRequestEventMetadata.md b/sdks/node/docs/model/EventCallbackRequestEventMetadata.md index b978c54e1..ae521e992 100644 --- a/sdks/node/docs/model/EventCallbackRequestEventMetadata.md +++ b/sdks/node/docs/model/EventCallbackRequestEventMetadata.md @@ -1,14 +1,14 @@ # # EventCallbackRequestEventMetadata -Specific metadata about the event. +_t__EventCallbackRequestEventMetadata::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `relatedSignatureId` | ```string``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | -| `reportedForAccountId` | ```string``` | Account ID the event was reported for. | | -| `reportedForAppId` | ```string``` | App ID the event was reported for. | | -| `eventMessage` | ```string``` | Message about a declined or failed (due to error) signature flow. | | +| `relatedSignatureId` | ```string``` | _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID | | +| `reportedForAccountId` | ```string``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID | | +| `reportedForAppId` | ```string``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID | | +| `eventMessage` | ```string``` | _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxGetResponse.md b/sdks/node/docs/model/FaxGetResponse.md index d688d55b8..b21a33cee 100644 --- a/sdks/node/docs/model/FaxGetResponse.md +++ b/sdks/node/docs/model/FaxGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FileResponse.md b/sdks/node/docs/model/FileResponse.md index 0a81629ed..1e18b51c4 100644 --- a/sdks/node/docs/model/FileResponse.md +++ b/sdks/node/docs/model/FileResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fileUrl`*_required_ | ```string``` | URL to the file. | | -| `expiresAt`*_required_ | ```number``` | When the link expires. | | +| `fileUrl`*_required_ | ```string``` | _t__FileResponse::FILE_URL | | +| `expiresAt`*_required_ | ```number``` | _t__FileResponse::EXPIRES_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FileResponseDataUri.md b/sdks/node/docs/model/FileResponseDataUri.md index c9742c251..eec5168b4 100644 --- a/sdks/node/docs/model/FileResponseDataUri.md +++ b/sdks/node/docs/model/FileResponseDataUri.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `dataUri`*_required_ | ```string``` | File as base64 encoded string. | | +| `dataUri`*_required_ | ```string``` | _t__FileResponse::DATA_URI | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ListInfoResponse.md b/sdks/node/docs/model/ListInfoResponse.md index 68cc6f7e1..2b9eb5b9e 100644 --- a/sdks/node/docs/model/ListInfoResponse.md +++ b/sdks/node/docs/model/ListInfoResponse.md @@ -1,14 +1,14 @@ # # ListInfoResponse -Contains pagination information about the data returned. +_t__ListInfoResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `numPages` | ```number``` | Total number of pages available. | | -| `numResults` | ```number``` | Total number of objects available. | | -| `page` | ```number``` | Number of the page being returned. | | -| `pageSize` | ```number``` | Objects returned per page. | | +| `numPages` | ```number``` | _t__ListInfoResponse::NUM_PAGES | | +| `numResults` | ```number``` | _t__ListInfoResponse::NUM_RESULTS | | +| `page` | ```number``` | _t__ListInfoResponse::PAGE | | +| `pageSize` | ```number``` | _t__ListInfoResponse::PAGE_SIZE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/OAuthTokenResponse.md b/sdks/node/docs/model/OAuthTokenResponse.md index a419e5814..02459c953 100644 --- a/sdks/node/docs/model/OAuthTokenResponse.md +++ b/sdks/node/docs/model/OAuthTokenResponse.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes | `accessToken` | ```string``` | | | | `tokenType` | ```string``` | | | | `refreshToken` | ```string``` | | | -| `expiresIn` | ```number``` | Number of seconds until the `access_token` expires. Uses epoch time. | | +| `expiresIn` | ```number``` | _t__OAuthTokenResponse::EXPIRES_IN | | | `state` | ```string``` | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ReportCreateResponse.md b/sdks/node/docs/model/ReportCreateResponse.md index 81c15fe1e..656467de1 100644 --- a/sdks/node/docs/model/ReportCreateResponse.md +++ b/sdks/node/docs/model/ReportCreateResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `report`*_required_ | [```ReportResponse```](ReportResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/ReportResponse.md b/sdks/node/docs/model/ReportResponse.md index b83d9ac59..be4dd43a7 100644 --- a/sdks/node/docs/model/ReportResponse.md +++ b/sdks/node/docs/model/ReportResponse.md @@ -1,14 +1,14 @@ # # ReportResponse -Contains information about the report request. +_t__ReportResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `success` | ```string``` | A message indicating the requested operation's success | | -| `startDate` | ```string``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | | -| `endDate` | ```string``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | | -| `reportType` | ```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). | | +| `success` | ```string``` | _t__ReportResponse::SUCCESS | | +| `startDate` | ```string``` | _t__ReportResponse::START_DATE | | +| `endDate` | ```string``` | _t__ReportResponse::END_DATE | | +| `reportType` | ```Array``` | _t__ReportResponse::REPORT_TYPE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index d541a0d51..db7cff77c 100644 --- a/sdks/node/docs/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/node/docs/model/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestBulkSendWithTemplateRequest.md index 66d9f1a0a..daa95d56b 100644 --- a/sdks/node/docs/model/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestBulkSendWithTemplateRequest.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes | `clientId` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md b/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md index d8cbf1583..fb34de6f2 100644 --- a/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md @@ -9,11 +9,12 @@ Name | Type | Description | Notes | `clientId`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | | `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -22,7 +23,7 @@ Name | Type | Description | Notes | `formFieldsPerDocument` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hideTextTags` | ```boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/node/docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md index d440db010..f3ab8c8b5 100644 --- a/sdks/node/docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -8,14 +8,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `templateIds`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `clientId`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `customFields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md index bcc66ecf9..95881ebfd 100644 --- a/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md @@ -9,11 +9,12 @@ Name | Type | Description | Notes | `clientId`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | | `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -22,7 +23,7 @@ Name | Type | Description | Notes | `formFieldsPerDocument` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hideTextTags` | ```boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md index f417f0f72..0eb30ba74 100644 --- a/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -8,14 +8,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `templateIds`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `clientId`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `customFields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/node/docs/model/SignatureRequestEditRequest.md b/sdks/node/docs/model/SignatureRequestEditRequest.md index 309384652..b92542d79 100644 --- a/sdks/node/docs/model/SignatureRequestEditRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditRequest.md @@ -8,11 +8,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | | `clientId` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -23,7 +24,7 @@ Name | Type | Description | Notes | `hideTextTags` | ```boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | | `isEid` | ```boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md index fdec2cfc0..74dc3d92b 100644 --- a/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `templateIds`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `clientId` | ```string``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -16,7 +16,7 @@ Name | Type | Description | Notes | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `isEid` | ```boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/node/docs/model/SignatureRequestGetResponse.md b/sdks/node/docs/model/SignatureRequestGetResponse.md index ccddbf51d..6767c7eab 100644 --- a/sdks/node/docs/model/SignatureRequestGetResponse.md +++ b/sdks/node/docs/model/SignatureRequestGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `signatureRequest`*_required_ | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestListResponse.md b/sdks/node/docs/model/SignatureRequestListResponse.md index aebe68507..cd5044af2 100644 --- a/sdks/node/docs/model/SignatureRequestListResponse.md +++ b/sdks/node/docs/model/SignatureRequestListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signatureRequests`*_required_ | [```Array```](SignatureRequestResponse.md) | Contains information about signature requests. | | +| `signatureRequests`*_required_ | [```Array```](SignatureRequestResponse.md) | _t__SignatureRequestListResponse::DESCRIPTION | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponse.md b/sdks/node/docs/model/SignatureRequestResponse.md index 8bf5449d0..2ee2be529 100644 --- a/sdks/node/docs/model/SignatureRequestResponse.md +++ b/sdks/node/docs/model/SignatureRequestResponse.md @@ -1,35 +1,35 @@ # # SignatureRequestResponse -Contains information about a signature request. +_t__SignatureRequestResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `testMode` | ```boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | -| `signatureRequestId` | ```string``` | The id of the SignatureRequest. | | -| `requesterEmailAddress` | ```string``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```string``` | The title the specified Account uses for the SignatureRequest. | | -| `originalTitle` | ```string``` | Default Label for account. | | -| `subject` | ```string``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```string``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | The metadata attached to the signature request. | | -| `createdAt` | ```number``` | Time the signature request was created. | | -| `expiresAt` | ```number``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `isComplete` | ```boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `isDeclined` | ```boolean``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `hasError` | ```boolean``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `filesUrl` | ```string``` | The URL where a copy of the request's documents can be downloaded. | | -| `signingUrl` | ```string``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `detailsUrl` | ```string``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `ccEmailAddresses` | ```Array``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signingRedirectUrl` | ```string``` | The URL you want the signer redirected to after they successfully sign. | | -| `finalCopyUri` | ```string``` | The path where the completed document can be downloaded | | -| `templateIds` | ```Array``` | Templates IDs used in this SignatureRequest (if any). | | -| `customFields` | [```Array```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `responseData` | [```Array```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulkSendJobId` | ```string``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `testMode` | ```boolean``` | _t__SignatureRequestResponse::TEST_MODE | [default to false] | +| `signatureRequestId` | ```string``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requesterEmailAddress` | ```string``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```string``` | _t__SignatureRequestResponse::TITLE | | +| `originalTitle` | ```string``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```string``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```string``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```{ [key: string]: any; }``` | _t__SignatureRequestResponse::METADATA | | +| `createdAt` | ```number``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expiresAt` | ```number``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `isComplete` | ```boolean``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `isDeclined` | ```boolean``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `hasError` | ```boolean``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `filesUrl` | ```string``` | _t__SignatureRequestResponse::FILES_URL | | +| `signingUrl` | ```string``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `detailsUrl` | ```string``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `ccEmailAddresses` | ```Array``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signingRedirectUrl` | ```string``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `finalCopyUri` | ```string``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `templateIds` | ```Array``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `customFields` | [```Array```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `responseData` | [```Array```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulkSendJobId` | ```string``` | _t__SignatureRequestResponse::BULK_SEND_JOB_ID | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseAttachment.md b/sdks/node/docs/model/SignatureRequestResponseAttachment.md index c0eca9204..399dd7caa 100644 --- a/sdks/node/docs/model/SignatureRequestResponseAttachment.md +++ b/sdks/node/docs/model/SignatureRequestResponseAttachment.md @@ -1,16 +1,16 @@ # # SignatureRequestResponseAttachment -Signer attachments. +_t__SignatureRequestResponseAttachment::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `id`*_required_ | ```string``` | The unique ID for this attachment. | | -| `signer`*_required_ | ```string``` | The Signer this attachment is assigned to. | | -| `name`*_required_ | ```string``` | The name of this attachment. | | -| `required`*_required_ | ```boolean``` | A boolean value denoting if this attachment is required. | | -| `instructions` | ```string``` | Instructions for Signer. | | -| `uploadedAt` | ```number``` | Timestamp when attachment was uploaded by Signer. | | +| `id`*_required_ | ```string``` | _t__SignatureRequestResponseAttachment::ID | | +| `signer`*_required_ | ```string``` | _t__SignatureRequestResponseAttachment::SIGNER | | +| `name`*_required_ | ```string``` | _t__SignatureRequestResponseAttachment::NAME | | +| `required`*_required_ | ```boolean``` | _t__SignatureRequestResponseAttachment::REQUIRED | | +| `instructions` | ```string``` | _t__SignatureRequestResponseAttachment::INSTRUCTIONS | | +| `uploadedAt` | ```number``` | _t__SignatureRequestResponseAttachment::UPLOADED_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseCustomFieldBase.md b/sdks/node/docs/model/SignatureRequestResponseCustomFieldBase.md index 78eba3fbc..10c089833 100644 --- a/sdks/node/docs/model/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/node/docs/model/SignatureRequestResponseCustomFieldBase.md @@ -1,18 +1,15 @@ # # SignatureRequestResponseCustomFieldBase -An array of Custom Field objects containing the name and type of each custom field. - -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` +_t__SignatureRequestResponseCustomField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `name`*_required_ | ```string``` | The name of the Custom Field. | | -| `required` | ```boolean``` | A boolean value denoting if this field is required. | | -| `apiId` | ```string``` | The unique ID for this field. | | -| `editor` | ```string``` | The name of the Role that is able to edit this field. | | +| `type`*_required_ | ```string``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `name`*_required_ | ```string``` | _t__SignatureRequestResponseCustomField::NAME | | +| `required` | ```boolean``` | _t__SignatureRequestResponseCustomField::REQUIRED | | +| `apiId` | ```string``` | _t__SignatureRequestResponseCustomField::API_ID | | +| `editor` | ```string``` | _t__SignatureRequestResponseCustomField::EDITOR | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/node/docs/model/SignatureRequestResponseCustomFieldCheckbox.md index 649d26ab6..10a70bbfb 100644 --- a/sdks/node/docs/model/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/node/docs/model/SignatureRequestResponseCustomFieldCheckbox.md @@ -1,12 +1,12 @@ # # SignatureRequestResponseCustomFieldCheckbox -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'checkbox'] | -| `value` | ```boolean``` | A true/false for checkbox fields | | +| `type`*_required_ | ```string``` | _t__SignatureRequestResponseCustomField::TYPE | [default to 'checkbox'] | +| `value` | ```boolean``` | _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseCustomFieldText.md b/sdks/node/docs/model/SignatureRequestResponseCustomFieldText.md index 38486e804..825730495 100644 --- a/sdks/node/docs/model/SignatureRequestResponseCustomFieldText.md +++ b/sdks/node/docs/model/SignatureRequestResponseCustomFieldText.md @@ -1,12 +1,12 @@ # # SignatureRequestResponseCustomFieldText -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'text'] | -| `value` | ```string``` | A text string for text fields | | +| `type`*_required_ | ```string``` | _t__SignatureRequestResponseCustomField::TYPE | [default to 'text'] | +| `value` | ```string``` | _t__SignatureRequestResponseCustomField::VALUE_TEXT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataBase.md b/sdks/node/docs/model/SignatureRequestResponseDataBase.md index b04f6a1ed..209bdacd7 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataBase.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataBase.md @@ -1,15 +1,15 @@ # # SignatureRequestResponseDataBase -An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. +_t__SignatureRequestResponseData::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `apiId` | ```string``` | The unique ID for this field. | | -| `signatureId` | ```string``` | The ID of the signature to which this response is linked. | | -| `name` | ```string``` | The name of the form field. | | -| `required` | ```boolean``` | A boolean value denoting if this field is required. | | +| `apiId` | ```string``` | _t__SignatureRequestResponseData::API_ID | | +| `signatureId` | ```string``` | _t__SignatureRequestResponseData::SIGNATURE_ID | | +| `name` | ```string``` | _t__SignatureRequestResponseData::NAME | | +| `required` | ```boolean``` | _t__SignatureRequestResponseData::REQUIRED | | | `type` | ```string``` | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataValueCheckbox.md b/sdks/node/docs/model/SignatureRequestResponseDataValueCheckbox.md index 939b24d39..a58502ba4 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataValueCheckbox.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A yes/no checkbox | [default to 'checkbox'] | -| `value` | ```boolean``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE | [default to 'checkbox'] | +| `value` | ```boolean``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/node/docs/model/SignatureRequestResponseDataValueCheckboxMerge.md index 00475b7bd..d059a9e2d 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataValueCheckboxMerge.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A checkbox field that has default value set by the api | [default to 'checkbox-merge'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE | [default to 'checkbox-merge'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataValueDateSigned.md b/sdks/node/docs/model/SignatureRequestResponseDataValueDateSigned.md index 56a613c94..1423bb4e6 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataValueDateSigned.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A date | [default to 'date_signed'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE | [default to 'date_signed'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataValueDropdown.md b/sdks/node/docs/model/SignatureRequestResponseDataValueDropdown.md index 61ddaae67..48ff79580 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataValueDropdown.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | An input field for dropdowns | [default to 'dropdown'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE | [default to 'dropdown'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataValueInitials.md b/sdks/node/docs/model/SignatureRequestResponseDataValueInitials.md index 2a80d7347..831da586e 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataValueInitials.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataValueInitials.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | An input field for initials | [default to 'initials'] | -| `value` | ```string``` | The value of the form field. | | -| `isSigned` | ```boolean``` | This field contains the boolean true if the field is signed. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::INITIAL_TYPE | [default to 'initials'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `isSigned` | ```boolean``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataValueRadio.md b/sdks/node/docs/model/SignatureRequestResponseDataValueRadio.md index e5f5c18d1..0a930f60d 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataValueRadio.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataValueRadio.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | An input field for radios | [default to 'radio'] | -| `value` | ```boolean``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::RADIO_TYPE | [default to 'radio'] | +| `value` | ```boolean``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataValueSignature.md b/sdks/node/docs/model/SignatureRequestResponseDataValueSignature.md index 1b76c43b5..192cd6de0 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataValueSignature.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataValueSignature.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A signature input field | [default to 'signature'] | -| `value` | ```string``` | The value of the form field. | | -| `isSigned` | ```boolean``` | This field contains the boolean true if the field is signed. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE | [default to 'signature'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `isSigned` | ```boolean``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataValueText.md b/sdks/node/docs/model/SignatureRequestResponseDataValueText.md index 6058f2017..921d0ecbe 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataValueText.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataValueText.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A text input field | [default to 'text'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::TEXT_TYPE | [default to 'text'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseDataValueTextMerge.md b/sdks/node/docs/model/SignatureRequestResponseDataValueTextMerge.md index e1b140727..6009c6212 100644 --- a/sdks/node/docs/model/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/node/docs/model/SignatureRequestResponseDataValueTextMerge.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A text field that has default text set by the api | [default to 'text-merge'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE | [default to 'text-merge'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponseSignatures.md b/sdks/node/docs/model/SignatureRequestResponseSignatures.md index e13d49af6..effec32eb 100644 --- a/sdks/node/docs/model/SignatureRequestResponseSignatures.md +++ b/sdks/node/docs/model/SignatureRequestResponseSignatures.md @@ -1,29 +1,29 @@ # # SignatureRequestResponseSignatures -An array of signature objects, 1 for each signer. +_t__SignatureRequestResponseSignatures::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signatureId` | ```string``` | Signature identifier. | | -| `signerGroupGuid` | ```string``` | Signer Group GUID | | -| `signerEmailAddress` | ```string``` | The email address of the signer. | | -| `signerName` | ```string``` | The name of the signer. | | -| `signerRole` | ```string``` | The role of the signer. | | -| `order` | ```number``` | If signer order is assigned this is the 0-based index for this signer. | | -| `statusCode` | ```string``` | The current status of the signature. eg: awaiting_signature, signed, declined. | | -| `declineReason` | ```string``` | The reason provided by the signer for declining the request. | | -| `signedAt` | ```number``` | Time that the document was signed or null. | | -| `lastViewedAt` | ```number``` | The time that the document was last viewed by this signer or null. | | -| `lastRemindedAt` | ```number``` | The time the last reminder email was sent to the signer or null. | | -| `hasPin` | ```boolean``` | Boolean to indicate whether this signature requires a PIN to access. | | -| `hasSmsAuth` | ```boolean``` | Boolean to indicate whether this signature has SMS authentication enabled. | | -| `hasSmsDelivery` | ```boolean``` | Boolean to indicate whether this signature has SMS delivery enabled. | | -| `smsPhoneNumber` | ```string``` | The SMS phone number used for authentication or signature request delivery. | | -| `reassignedBy` | ```string``` | Email address of original signer who reassigned to this signer. | | -| `reassignmentReason` | ```string``` | Reason provided by original signer who reassigned to this signer. | | -| `reassignedFrom` | ```string``` | Previous signature identifier. | | -| `error` | ```string``` | Error message pertaining to this signer, or null. | | +| `signatureId` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNATURE_ID | | +| `signerGroupGuid` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID | | +| `signerEmailAddress` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS | | +| `signerName` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNER_NAME | | +| `signerRole` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNER_ROLE | | +| `order` | ```number``` | _t__SignatureRequestResponseSignatures::ORDER | | +| `statusCode` | ```string``` | _t__SignatureRequestResponseSignatures::STATUS_CODE | | +| `declineReason` | ```string``` | _t__SignatureRequestResponseSignatures::DECLINE_REASON | | +| `signedAt` | ```number``` | _t__SignatureRequestResponseSignatures::SIGNED_AT | | +| `lastViewedAt` | ```number``` | _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT | | +| `lastRemindedAt` | ```number``` | _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT | | +| `hasPin` | ```boolean``` | _t__SignatureRequestResponseSignatures::HAS_PIN | | +| `hasSmsAuth` | ```boolean``` | _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH | | +| `hasSmsDelivery` | ```boolean``` | _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY | | +| `smsPhoneNumber` | ```string``` | _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER | | +| `reassignedBy` | ```string``` | _t__SignatureRequestResponseSignatures::REASSIGNED_BY | | +| `reassignmentReason` | ```string``` | _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON | | +| `reassignedFrom` | ```string``` | _t__SignatureRequestResponseSignatures::REASSIGNED_FROM | | +| `error` | ```string``` | _t__SignatureRequestResponseSignatures::ERROR | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestSendRequest.md b/sdks/node/docs/model/SignatureRequestSendRequest.md index b35df0d86..54a8e1e36 100644 --- a/sdks/node/docs/model/SignatureRequestSendRequest.md +++ b/sdks/node/docs/model/SignatureRequestSendRequest.md @@ -8,11 +8,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | | `clientId` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -24,7 +25,7 @@ Name | Type | Description | Notes | `isQualifiedSignature` | ```boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `isEid` | ```boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md index 73d132e0b..083c6c875 100644 --- a/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `templateIds`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `clientId` | ```string``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -17,7 +17,7 @@ Name | Type | Description | Notes | `isQualifiedSignature` | ```boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `isEid` | ```boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/node/docs/model/SubFormFieldsPerDocumentBase.md b/sdks/node/docs/model/SubFormFieldsPerDocumentBase.md index 8c8aacb9a..81682c80d 100644 --- a/sdks/node/docs/model/SubFormFieldsPerDocumentBase.md +++ b/sdks/node/docs/model/SubFormFieldsPerDocumentBase.md @@ -25,9 +25,9 @@ Name | Type | Description | Notes | `required`*_required_ | ```boolean``` | Whether this field is required. | | | `signer`*_required_ | ```string``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | | | `type`*_required_ | ```string``` | | | -| `width`*_required_ | ```number``` | Size of the field in pixels. | | -| `x`*_required_ | ```number``` | Location coordinates of the field in pixels. | | -| `y`*_required_ | ```number``` | Location coordinates of the field in pixels. | | +| `width`*_required_ | ```number``` | _t__Sub::FormFieldsPerDocument::WIDTH | | +| `x`*_required_ | ```number``` | _t__Sub::FormFieldsPerDocument::X | | +| `y`*_required_ | ```number``` | _t__Sub::FormFieldsPerDocument::Y | | | `name` | ```string``` | Display name for the field. | | | `page` | ```number``` | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | | diff --git a/sdks/node/docs/model/SubFormFieldsPerDocumentText.md b/sdks/node/docs/model/SubFormFieldsPerDocumentText.md index 1d76813fc..636949dea 100644 --- a/sdks/node/docs/model/SubFormFieldsPerDocumentText.md +++ b/sdks/node/docs/model/SubFormFieldsPerDocumentText.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes | `autoFillType` | ```string``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | | | `linkId` | ```string``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | | | `masked` | ```boolean``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | | -| `validationType` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.

**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | | +| `validationType` | ```string``` | _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE | | | `validationCustomRegex` | ```string``` | | | | `validationCustomRegexFormatLabel` | ```string``` | | | | `content` | ```string``` | Content of a `me_now` text field | | diff --git a/sdks/node/docs/model/SubFormFieldsPerDocumentTextMerge.md b/sdks/node/docs/model/SubFormFieldsPerDocumentTextMerge.md index 5fbc42d22..0ccb36d57 100644 --- a/sdks/node/docs/model/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/node/docs/model/SubFormFieldsPerDocumentTextMerge.md @@ -6,7 +6,7 @@ This class extends `SubFormFieldsPerDocumentBase`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] | +| `type`*_required_ | ```string``` | _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE | [default to 'text-merge'] | | `fontFamily` | ```string``` | Font family for the field. | | | `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] | diff --git a/sdks/node/docs/model/SubMergeField.md b/sdks/node/docs/model/SubMergeField.md index 1114a084b..9751add42 100644 --- a/sdks/node/docs/model/SubMergeField.md +++ b/sdks/node/docs/model/SubMergeField.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the merge field. Must be unique. | | -| `type`*_required_ | ```string``` | The type of merge field. | | +| `name`*_required_ | ```string``` | _t__Sub::MergeField::NAME | | +| `type`*_required_ | ```string``` | _t__Sub::MergeField::TYPE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubOAuth.md b/sdks/node/docs/model/SubOAuth.md index 83003e3a4..adcec18e1 100644 --- a/sdks/node/docs/model/SubOAuth.md +++ b/sdks/node/docs/model/SubOAuth.md @@ -1,12 +1,12 @@ # # SubOAuth -OAuth related parameters. +_t__Sub::OAuth::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callbackUrl` | ```string``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | -| `scopes` | ```Array``` | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | +| `callbackUrl` | ```string``` | _t__Sub::OAuth::CALLBACK_URL | | +| `scopes` | ```Array``` | _t__Sub::OAuth::SCOPES | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubOptions.md b/sdks/node/docs/model/SubOptions.md index 724faf336..f6deac5b1 100644 --- a/sdks/node/docs/model/SubOptions.md +++ b/sdks/node/docs/model/SubOptions.md @@ -1,11 +1,11 @@ # # SubOptions -Additional options supported by API App. +_t__Sub::Options::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `canInsertEverywhere` | ```boolean``` | Determines if signers can use "Insert Everywhere" when signing a document. | [default to false] | +| `canInsertEverywhere` | ```boolean``` | _t__Sub::Options::CAN_INSERT_EVERYWHERE | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubSignatureRequestGroupedSigners.md b/sdks/node/docs/model/SubSignatureRequestGroupedSigners.md index ee20e27d9..fa7c575fb 100644 --- a/sdks/node/docs/model/SubSignatureRequestGroupedSigners.md +++ b/sdks/node/docs/model/SubSignatureRequestGroupedSigners.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `group`*_required_ | ```string``` | The name of the group. | | -| `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. | | -| `order` | ```number``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | +| `group`*_required_ | ```string``` | _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME | | +| `signers`*_required_ | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestGroupedSigners::SIGNERS | | +| `order` | ```number``` | _t__Sub::SignatureRequestGroupedSigners::ORDER | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubSignatureRequestSigner.md b/sdks/node/docs/model/SubSignatureRequestSigner.md index de817d161..76169ab4f 100644 --- a/sdks/node/docs/model/SubSignatureRequestSigner.md +++ b/sdks/node/docs/model/SubSignatureRequestSigner.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the signer. | | -| `emailAddress`*_required_ | ```string``` | The email address of the signer. | | -| `order` | ```number``` | The order the signer is required to sign in. | | -| `pin` | ```string``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `smsPhoneNumber` | ```string``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `smsPhoneNumberType` | ```string``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `name`*_required_ | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_NAME | | +| `emailAddress`*_required_ | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS | | +| `order` | ```number``` | _t__Sub::SignatureRequestSigner::SIGNER_ORDER | | +| `pin` | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_PIN | | +| `smsPhoneNumber` | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER | | +| `smsPhoneNumberType` | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubSignatureRequestTemplateSigner.md b/sdks/node/docs/model/SubSignatureRequestTemplateSigner.md index cebb3ec18..585717f56 100644 --- a/sdks/node/docs/model/SubSignatureRequestTemplateSigner.md +++ b/sdks/node/docs/model/SubSignatureRequestTemplateSigner.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | Must match an existing role in chosen Template(s). It's case-sensitive. | | -| `name`*_required_ | ```string``` | The name of the signer. | | -| `emailAddress`*_required_ | ```string``` | The email address of the signer. | | -| `pin` | ```string``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `smsPhoneNumber` | ```string``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `smsPhoneNumberType` | ```string``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `role`*_required_ | ```string``` | _t__Sub::SignatureRequestTemplateSigner::ROLE | | +| `name`*_required_ | ```string``` | _t__Sub::SignatureRequestTemplateSigner::NAME | | +| `emailAddress`*_required_ | ```string``` | _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS | | +| `pin` | ```string``` | _t__Sub::SignatureRequestTemplateSigner::PIN | | +| `smsPhoneNumber` | ```string``` | _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER | | +| `smsPhoneNumberType` | ```string``` | _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubSigningOptions.md b/sdks/node/docs/model/SubSigningOptions.md index 1e1c670f6..c74463095 100644 --- a/sdks/node/docs/model/SubSigningOptions.md +++ b/sdks/node/docs/model/SubSigningOptions.md @@ -1,17 +1,15 @@ # # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. - -**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +_t__Sub::SigningOptions::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `defaultType`*_required_ | ```string``` | The default type shown (limited to the listed types) | | -| `draw` | ```boolean``` | Allows drawing the signature | [default to false] | -| `phone` | ```boolean``` | Allows using a smartphone to email the signature | [default to false] | -| `type` | ```boolean``` | Allows typing the signature | [default to false] | -| `upload` | ```boolean``` | Allows uploading the signature | [default to false] | +| `defaultType`*_required_ | ```string``` | _t__Sub::SigningOptions::DEFAULT | | +| `draw` | ```boolean``` | _t__Sub::SigningOptions::DRAW | [default to false] | +| `phone` | ```boolean``` | _t__Sub::SigningOptions::PHONE | [default to false] | +| `type` | ```boolean``` | _t__Sub::SigningOptions::TYPE | [default to false] | +| `upload` | ```boolean``` | _t__Sub::SigningOptions::UPLOAD | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubTeamResponse.md b/sdks/node/docs/model/SubTeamResponse.md index 180edf9cd..5ad8cfca3 100644 --- a/sdks/node/docs/model/SubTeamResponse.md +++ b/sdks/node/docs/model/SubTeamResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `teamId` | ```string``` | The id of a team | | -| `name` | ```string``` | The name of a team | | +| `teamId` | ```string``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```string``` | _t__TeamGeneral::NAME | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubTemplateRole.md b/sdks/node/docs/model/SubTemplateRole.md index 27d1a0732..4e10da07a 100644 --- a/sdks/node/docs/model/SubTemplateRole.md +++ b/sdks/node/docs/model/SubTemplateRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | -| `order` | ```number``` | The order in which this signer role is required to sign. | | +| `name` | ```string``` | _t__Sub::SignerRole::NAME | | +| `order` | ```number``` | _t__Sub::SignerRole::ORDER | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubUnclaimedDraftSigner.md b/sdks/node/docs/model/SubUnclaimedDraftSigner.md index 0992a1641..e8e9448b7 100644 --- a/sdks/node/docs/model/SubUnclaimedDraftSigner.md +++ b/sdks/node/docs/model/SubUnclaimedDraftSigner.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `emailAddress`*_required_ | ```string``` | The email address of the signer. | | -| `name`*_required_ | ```string``` | The name of the signer. | | -| `order` | ```number``` | The order the signer is required to sign in. | | +| `emailAddress`*_required_ | ```string``` | _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS | | +| `name`*_required_ | ```string``` | _t__Sub::UnclaimedDraftSigner::NAME | | +| `order` | ```number``` | _t__Sub::UnclaimedDraftSigner::ORDER | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubUnclaimedDraftTemplateSigner.md b/sdks/node/docs/model/SubUnclaimedDraftTemplateSigner.md index b641c4251..3d337b2e0 100644 --- a/sdks/node/docs/model/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/node/docs/model/SubUnclaimedDraftTemplateSigner.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | Must match an existing role in chosen Template(s). | | -| `name`*_required_ | ```string``` | The name of the signer filling the role of `role`. | | -| `emailAddress`*_required_ | ```string``` | The email address of the signer filling the role of `role`. | | +| `role`*_required_ | ```string``` | _t__Sub::UnclaimedDraftTemplateSigner::ROLE | | +| `name`*_required_ | ```string``` | _t__Sub::UnclaimedDraftTemplateSigner::NAME | | +| `emailAddress`*_required_ | ```string``` | _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubWhiteLabelingOptions.md b/sdks/node/docs/model/SubWhiteLabelingOptions.md index b800c3f6b..82c428c28 100644 --- a/sdks/node/docs/model/SubWhiteLabelingOptions.md +++ b/sdks/node/docs/model/SubWhiteLabelingOptions.md @@ -1,8 +1,6 @@ # # SubWhiteLabelingOptions -An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) - -Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. +_t__Sub::WhiteLabelingOptions::DESCRIPTION ## Properties @@ -22,6 +20,6 @@ Name | Type | Description | Notes | `secondaryButtonTextColorHover` | ```string``` | | [default to '#0061FE'] | | `textColor1` | ```string``` | | [default to '#808080'] | | `textColor2` | ```string``` | | [default to '#ffffff'] | -| `resetToDefault` | ```boolean``` | Resets white labeling options to defaults. Only useful when updating an API App. | | +| `resetToDefault` | ```boolean``` | _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TeamGetInfoResponse.md b/sdks/node/docs/model/TeamGetInfoResponse.md index 1390eff5a..c359cf893 100644 --- a/sdks/node/docs/model/TeamGetInfoResponse.md +++ b/sdks/node/docs/model/TeamGetInfoResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `team`*_required_ | [```TeamInfoResponse```](TeamInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TeamGetResponse.md b/sdks/node/docs/model/TeamGetResponse.md index ffc3d96c0..58fde6c2d 100644 --- a/sdks/node/docs/model/TeamGetResponse.md +++ b/sdks/node/docs/model/TeamGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `team`*_required_ | [```TeamResponse```](TeamResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TeamInfoResponse.md b/sdks/node/docs/model/TeamInfoResponse.md index d4f5a92bb..aa3183db4 100644 --- a/sdks/node/docs/model/TeamInfoResponse.md +++ b/sdks/node/docs/model/TeamInfoResponse.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `teamId` | ```string``` | The id of a team | | +| `teamId` | ```string``` | _t__TeamGeneral::TEAM_ID | | | `teamParent` | [```TeamParentResponse```](TeamParentResponse.md) | | | -| `name` | ```string``` | The name of a team | | -| `numMembers` | ```number``` | Number of members within a team | | -| `numSubTeams` | ```number``` | Number of sub teams within a team | | +| `name` | ```string``` | _t__TeamGeneral::NAME | | +| `numMembers` | ```number``` | _t__TeamGeneral::NUM_MEMBERS | | +| `numSubTeams` | ```number``` | _t__TeamGeneral::NUM_SUB_TEAMS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TeamParentResponse.md b/sdks/node/docs/model/TeamParentResponse.md index b7b1aed76..52e137bf1 100644 --- a/sdks/node/docs/model/TeamParentResponse.md +++ b/sdks/node/docs/model/TeamParentResponse.md @@ -6,7 +6,7 @@ Information about the parent team if a team has one, set to `null` otherwise. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `teamId` | ```string``` | The id of a team | | -| `name` | ```string``` | The name of a team | | +| `teamId` | ```string``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```string``` | _t__TeamGeneral::NAME | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TeamResponse.md b/sdks/node/docs/model/TeamResponse.md index 39f6ae7fb..be114ef7a 100644 --- a/sdks/node/docs/model/TeamResponse.md +++ b/sdks/node/docs/model/TeamResponse.md @@ -1,14 +1,14 @@ # # TeamResponse -Contains information about your team and its members +_t__TeamResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of your Team | | +| `name` | ```string``` | _t__Team::NAME | | | `accounts` | [```Array```](AccountResponse.md) | | | -| `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`. | | -| `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. | | +| `invitedAccounts` | [```Array```](AccountResponse.md) | _t__Team::INVITED_ACCOUNTS | | +| `invitedEmails` | ```Array``` | _t__Team::INVITED_EMAILS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md b/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md index 0a6d8c813..b52f12088 100644 --- a/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md @@ -11,7 +11,8 @@ Name | Type | Description | Notes | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to true] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccRoles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -22,7 +23,7 @@ Name | Type | Description | Notes | `formFieldsPerDocument` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `mergeFields` | [```Array```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```string``` | The default template email message. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `showPreview` | ```boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | | `showProgressStepper` | ```boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | | `signerRoles` | [```Array```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | diff --git a/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponse.md b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponse.md index cbe628ace..0093749d2 100644 --- a/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template`*_required_ | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md index 05c82cd71..65f39b448 100644 --- a/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -1,14 +1,14 @@ # # TemplateCreateEmbeddedDraftResponseTemplate -Template object with parameters: `template_id`, `edit_url`, `expires_at`. +_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | -| `editUrl` | ```string``` | Link to edit the template. | | -| `expiresAt` | ```number``` | When the link expires. | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `templateId` | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | +| `editUrl` | ```string``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL | | +| `expiresAt` | ```number``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateCreateRequest.md b/sdks/node/docs/model/TemplateCreateRequest.md index 738ed648d..6befb5b28 100644 --- a/sdks/node/docs/model/TemplateCreateRequest.md +++ b/sdks/node/docs/model/TemplateCreateRequest.md @@ -11,7 +11,8 @@ Name | Type | Description | Notes | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccRoles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `clientId` | ```string``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | | `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -19,7 +20,7 @@ Name | Type | Description | Notes | `formFieldRules` | [```Array```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | | `mergeFields` | [```Array```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```string``` | The default template email message. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `subject` | ```string``` | The template title (alias). | | | `testMode` | ```boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | diff --git a/sdks/node/docs/model/TemplateCreateResponse.md b/sdks/node/docs/model/TemplateCreateResponse.md index f47cfb546..a000b8b68 100644 --- a/sdks/node/docs/model/TemplateCreateResponse.md +++ b/sdks/node/docs/model/TemplateCreateResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template`*_required_ | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateCreateResponseTemplate.md b/sdks/node/docs/model/TemplateCreateResponseTemplate.md index 3b4e62005..05c36b36b 100644 --- a/sdks/node/docs/model/TemplateCreateResponseTemplate.md +++ b/sdks/node/docs/model/TemplateCreateResponseTemplate.md @@ -1,11 +1,11 @@ # # TemplateCreateResponseTemplate -Template object with parameters: `template_id`. +_t__TemplateCreateResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | +| `templateId` | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateEditResponse.md b/sdks/node/docs/model/TemplateEditResponse.md index 2f40ccbad..fc18c398e 100644 --- a/sdks/node/docs/model/TemplateEditResponse.md +++ b/sdks/node/docs/model/TemplateEditResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId`*_required_ | ```string``` | The id of the Template. | | +| `templateId`*_required_ | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateGetResponse.md b/sdks/node/docs/model/TemplateGetResponse.md index 2724b34c0..2ca04ba64 100644 --- a/sdks/node/docs/model/TemplateGetResponse.md +++ b/sdks/node/docs/model/TemplateGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template`*_required_ | [```TemplateResponse```](TemplateResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateListResponse.md b/sdks/node/docs/model/TemplateListResponse.md index 4929e7844..1001c8993 100644 --- a/sdks/node/docs/model/TemplateListResponse.md +++ b/sdks/node/docs/model/TemplateListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates`*_required_ | [```Array```](TemplateResponse.md) | List of templates that the API caller has access to. | | +| `templates`*_required_ | [```Array```](TemplateResponse.md) | _t__TemplateListResponse::DESCRIPTION | | | `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponse.md b/sdks/node/docs/model/TemplateResponse.md index 05e6532d2..487822549 100644 --- a/sdks/node/docs/model/TemplateResponse.md +++ b/sdks/node/docs/model/TemplateResponse.md @@ -1,26 +1,26 @@ # # TemplateResponse -Contains information about the templates you and your team have created. +_t__TemplateResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | -| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `updatedAt` | ```number``` | Time the template was last updated. | | -| `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | -| `isCreator` | ```boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit` | ```boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked` | ```boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```{ [key: string]: any; }``` | The metadata attached to the template. | | -| `signerRoles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `namedFormFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `templateId` | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | +| `title` | ```string``` | _t__TemplateResponse::TITLE | | +| `message` | ```string``` | _t__TemplateResponse::MESSAGE | | +| `updatedAt` | ```number``` | _t__TemplateResponse::UPDATED_AT | | +| `isEmbedded` | ```boolean``` | _t__TemplateResponse::IS_EMBEDDED | | +| `isCreator` | ```boolean``` | _t__TemplateResponse::IS_CREATOR | | +| `canEdit` | ```boolean``` | _t__TemplateResponse::CAN_EDIT | | +| `isLocked` | ```boolean``` | _t__TemplateResponse::IS_LOCKED | | +| `metadata` | ```{ [key: string]: any; }``` | _t__TemplateResponse::METADATA | | +| `signerRoles` | [```Array```](TemplateResponseSignerRole.md) | _t__TemplateResponse::SIGNER_ROLES | | +| `ccRoles` | [```Array```](TemplateResponseCCRole.md) | _t__TemplateResponse::CC_ROLES | | +| `documents` | [```Array```](TemplateResponseDocument.md) | _t__TemplateResponse::DOCUMENTS | | +| `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseCustomField::DESCRIPTION | | +| `namedFormFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseNamedFormField::DESCRIPTION | | +| `accounts` | [```Array```](TemplateResponseAccount.md) | _t__TemplateResponse::ACCOUNTS | | +| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseAccount.md b/sdks/node/docs/model/TemplateResponseAccount.md index 524109d96..895157a11 100644 --- a/sdks/node/docs/model/TemplateResponseAccount.md +++ b/sdks/node/docs/model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `accountId` | ```string``` | The id of the Account. | | -| `emailAddress` | ```string``` | The email address associated with the Account. | | -| `isLocked` | ```boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `accountId` | ```string``` | _t__TemplateResponseAccount::ACCOUNT_ID | | +| `emailAddress` | ```string``` | _t__TemplateResponseAccount::EMAIL_ADDRESS | | +| `isLocked` | ```boolean``` | _t__TemplateResponseAccount::IS_LOCKED | | +| `isPaidHs` | ```boolean``` | _t__TemplateResponseAccount::IS_PAID_HS | | +| `isPaidHf` | ```boolean``` | _t__TemplateResponseAccount::IS_PAID_HF | | | `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseAccountQuota.md b/sdks/node/docs/model/TemplateResponseAccountQuota.md index 587c6dab3..985f671f4 100644 --- a/sdks/node/docs/model/TemplateResponseAccountQuota.md +++ b/sdks/node/docs/model/TemplateResponseAccountQuota.md @@ -1,14 +1,14 @@ # # TemplateResponseAccountQuota -An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. +_t__TemplateResponseAccountQuota::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templatesLeft` | ```number``` | API templates remaining. | | -| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | | -| `documentsLeft` | ```number``` | Signature requests remaining. | | -| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | +| `templatesLeft` | ```number``` | _t__TemplateResponseAccountQuota::TEMPLATES_LEFT | | +| `apiSignatureRequestsLeft` | ```number``` | _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documentsLeft` | ```number``` | _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT | | +| `smsVerificationsLeft` | ```number``` | _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseCCRole.md b/sdks/node/docs/model/TemplateResponseCCRole.md index 32ad82ef9..b164f0409 100644 --- a/sdks/node/docs/model/TemplateResponseCCRole.md +++ b/sdks/node/docs/model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name` | ```string``` | _t__TemplateResponseCCRole::NAME | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocument.md b/sdks/node/docs/model/TemplateResponseDocument.md index 5f3f0d214..e09b3c8d1 100644 --- a/sdks/node/docs/model/TemplateResponseDocument.md +++ b/sdks/node/docs/model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | Name of the associated file. | | -| `index` | ```number``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `fieldGroups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```string``` | _t__TemplateResponseDocument::NAME | | +| `index` | ```number``` | _t__TemplateResponseDocument::INDEX | | +| `fieldGroups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | _t__TemplateResponseDocument::FIELD_GROUPS | | +| `formFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseDocumentFormField::DESCRIPTION | | +| `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseDocumentCustomField::DESCRIPTION | | +| `staticFields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | _t__TemplateResponseDocumentStaticField::DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md index 81418366f..4039f6ca9 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md @@ -1,20 +1,20 @@ # # TemplateResponseDocumentCustomFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentCustomField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | | | -| `apiId` | ```string``` | The unique ID for this field. | | -| `name` | ```string``` | The name of the Custom Field. | | -| `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```number``` | The horizontal offset in pixels for this form field. | | -| `y` | ```number``` | The vertical offset in pixels for this form field. | | -| `width` | ```number``` | The width in pixels of this form field. | | -| `height` | ```number``` | The height in pixels of this form field. | | -| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `apiId` | ```string``` | _t__TemplateResponseDocumentCustomField::API_ID | | +| `name` | ```string``` | _t__TemplateResponseDocumentCustomField::NAME | | +| `signer` | ```string``` | _t__TemplateResponseDocumentCustomField::SIGNER | | +| `x` | ```number``` | _t__TemplateResponseDocumentCustomField::X | | +| `y` | ```number``` | _t__TemplateResponseDocumentCustomField::Y | | +| `width` | ```number``` | _t__TemplateResponseDocumentCustomField::WIDTH | | +| `height` | ```number``` | _t__TemplateResponseDocumentCustomField::HEIGHT | | +| `required` | ```boolean``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```string``` | _t__TemplateResponseDocumentCustomField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldCheckbox.md index 4b1e53fb0..20f3deca0 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldCheckbox.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentCustomFieldCheckbox -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `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'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentCustomField::TYPE | [default to 'checkbox'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md index 035c69583..b13d6ce81 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md @@ -1,15 +1,15 @@ # # TemplateResponseDocumentCustomFieldText -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentCustomField::TYPE | [default to 'text'] | | `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | -| `fontFamily` | ```string``` | Font family used in this form field's text. | | +| `isMultiline` | ```boolean``` | _t__TemplateResponseDocumentCustomField::IS_MULTILINE | | +| `originalFontSize` | ```number``` | _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE | | +| `fontFamily` | ```string``` | _t__TemplateResponseDocumentCustomField::FONT_FAMILY | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md b/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md index 51f7c3369..9b4ad76a7 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the form field group. | | +| `name` | ```string``` | _t__TemplateResponseDocumentFieldGroup::NAME | | | `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md b/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md index 95e4fa470..91fdd893e 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFieldGroupRule -The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). +_t__TemplateResponseDocumentFieldGroup::RULE ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `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. | | -| `groupLabel` | ```string``` | Name of the group | | +| `requirement` | ```string``` | _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT | | +| `groupLabel` | ```string``` | _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md index 648b7fd5d..d4d4e4f8c 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md @@ -1,19 +1,19 @@ # # TemplateResponseDocumentFormFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentFormField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | | | -| `apiId` | ```string``` | A unique id for the form field. | | -| `name` | ```string``` | The name of the form field. | | -| `signer` | ```string``` | The signer of the Form Field. | | -| `x` | ```number``` | The horizontal offset in pixels for this form field. | | -| `y` | ```number``` | The vertical offset in pixels for this form field. | | -| `width` | ```number``` | The width in pixels of this form field. | | -| `height` | ```number``` | The height in pixels of this form field. | | -| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | +| `apiId` | ```string``` | _t__TemplateResponseDocumentFormField::API_ID | | +| `name` | ```string``` | _t__TemplateResponseDocumentFormField::NAME | | +| `signer` | ```string``` | _t__TemplateResponseDocumentFormField::SIGNER | | +| `x` | ```number``` | _t__TemplateResponseDocumentFormField::X | | +| `y` | ```number``` | _t__TemplateResponseDocumentFormField::Y | | +| `width` | ```number``` | _t__TemplateResponseDocumentFormField::WIDTH | | +| `height` | ```number``` | _t__TemplateResponseDocumentFormField::HEIGHT | | +| `required` | ```boolean``` | _t__TemplateResponseDocumentFormField::REQUIRED | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md index 2ee1b9e5e..eb129d01a 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldCheckbox -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'checkbox'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md index 8996ce7a3..1d8dab153 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldDateSigned -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'date_signed'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md index 35cadabb5..826798d61 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldDropdown -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'dropdown'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md index 6ba74dff4..638ec9576 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md @@ -1,16 +1,16 @@ # # TemplateResponseDocumentFormFieldHyperlink -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'hyperlink'] | | `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | -| `fontFamily` | ```string``` | Font family used in this form field's text. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `isMultiline` | ```boolean``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `originalFontSize` | ```number``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `fontFamily` | ```string``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md index ab0ccda06..3c5eb1601 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldInitials -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'initials'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md index 3b888caf7..e0955dd1a 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldRadio -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | -| `group`*_required_ | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'radio'] | +| `group`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md index b46f1d963..5fcba3ee9 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldSignature -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'signature'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md index 07154a227..27578cbbb 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md @@ -1,19 +1,19 @@ # # TemplateResponseDocumentFormFieldText -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'text'] | | `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | -| `fontFamily` | ```string``` | Font family used in this form field's text. | | -| `validationType` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | -| `validationCustomRegex` | ```string``` | When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. | | -| `validationCustomRegexFormatLabel` | ```string``` | When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `isMultiline` | ```boolean``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `originalFontSize` | ```number``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `fontFamily` | ```string``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `validationType` | ```string``` | _t__TemplateResponseDocumentFormField::VALIDATION_TYPE | | +| `validationCustomRegex` | ```string``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX | | +| `validationCustomRegexFormatLabel` | ```string``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL | | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md index 243c1d108..1138268ba 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md @@ -1,20 +1,20 @@ # # TemplateResponseDocumentStaticFieldBase -An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. +_t__TemplateResponseDocumentStaticField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | | | -| `apiId` | ```string``` | A unique id for the static field. | | -| `name` | ```string``` | The name of the static field. | | -| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```number``` | The horizontal offset in pixels for this static field. | | -| `y` | ```number``` | The vertical offset in pixels for this static field. | | -| `width` | ```number``` | The width in pixels of this static field. | | -| `height` | ```number``` | The height in pixels of this static field. | | -| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `apiId` | ```string``` | _t__TemplateResponseDocumentStaticField::API_ID | | +| `name` | ```string``` | _t__TemplateResponseDocumentStaticField::NAME | | +| `signer` | ```string``` | _t__TemplateResponseDocumentStaticField::SIGNER | [default to 'me_now'] | +| `x` | ```number``` | _t__TemplateResponseDocumentStaticField::X | | +| `y` | ```number``` | _t__TemplateResponseDocumentStaticField::Y | | +| `width` | ```number``` | _t__TemplateResponseDocumentStaticField::WIDTH | | +| `height` | ```number``` | _t__TemplateResponseDocumentStaticField::HEIGHT | | +| `required` | ```boolean``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```string``` | _t__TemplateResponseDocumentStaticField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldCheckbox.md index 4a23cb66b..10a815b37 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldCheckbox.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldCheckbox -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'checkbox'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'checkbox'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldDateSigned.md index 9c9d86fb4..d61a4af2b 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldDateSigned.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldDateSigned -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'date_signed'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'date_signed'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldDropdown.md index d5cdc36da..337592144 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldDropdown.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldDropdown -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'dropdown'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'dropdown'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldHyperlink.md index 304d2e082..99953b4a6 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldHyperlink.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldHyperlink -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'hyperlink'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'hyperlink'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldInitials.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldInitials.md index 9f112d1f3..044caca87 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldInitials.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldInitials -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'initials'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'initials'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldRadio.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldRadio.md index 1225138aa..b210f3134 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldRadio.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldRadio -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'radio'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'radio'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldSignature.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldSignature.md index 661b84cfd..76637edc9 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldSignature.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldSignature -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'signature'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'signature'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldText.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldText.md index fa528fb68..be321f68d 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldText.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldText -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'text'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'text'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md b/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md index 45daf9dae..697f39896 100644 --- a/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md @@ -1,12 +1,12 @@ # # TemplateResponseFieldAvgTextLength -Average text length in this field. +_t__TemplateResponseFieldAvgTextLength::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `numLines` | ```number``` | Number of lines. | | -| `numCharsPerLine` | ```number``` | Number of characters per line. | | +| `numLines` | ```number``` | _t__TemplateResponseFieldAvgTextLength::NUM_LINES | | +| `numCharsPerLine` | ```number``` | _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseSignerRole.md b/sdks/node/docs/model/TemplateResponseSignerRole.md index e33fced3c..ab1fe38ee 100644 --- a/sdks/node/docs/model/TemplateResponseSignerRole.md +++ b/sdks/node/docs/model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | -| `order` | ```number``` | If signer order is assigned this is the 0-based index for this role. | | +| `name` | ```string``` | _t__TemplateResponseSignerRole::NAME | | +| `order` | ```number``` | _t__TemplateResponseSignerRole::ORDER | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md b/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md index aea14ab0c..fd8498c20 100644 --- a/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md @@ -1,12 +1,12 @@ # # TemplateUpdateFilesResponseTemplate -Contains template id +_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `templateId` | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md index 444d8d77c..cbe44a4b6 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md @@ -12,8 +12,9 @@ Name | Type | Description | Notes | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to true] | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | | `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -27,11 +28,11 @@ Name | Type | Description | Notes | `holdRequest` | ```boolean``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | | `isForEmbeddedSigning` | ```boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `requestingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | | `showPreview` | ```boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `showProgressStepper` | ```boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```Array```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```Array```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `skipMeNow` | ```boolean``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | diff --git a/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index 7f9545930..14ef056dc 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -22,12 +22,12 @@ Name | Type | Description | Notes | `holdRequest` | ```boolean``` | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | | `isForEmbeddedSigning` | ```boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `previewOnly` | ```boolean``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | [default to false] | | `requestingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | | `showPreview` | ```boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | | `showProgressStepper` | ```boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```Array```](SubUnclaimedDraftTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers` | [```Array```](SubUnclaimedDraftTemplateSigner.md) | _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `skipMeNow` | ```boolean``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | diff --git a/sdks/node/docs/model/UnclaimedDraftCreateRequest.md b/sdks/node/docs/model/UnclaimedDraftCreateRequest.md index 255cbe395..17e3367a2 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateRequest.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateRequest.md @@ -10,7 +10,8 @@ Name | Type | Description | Notes | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | | `clientId` | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | | `customFields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -20,9 +21,9 @@ Name | Type | Description | Notes | `formFieldsPerDocument` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hideTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```{ [key: string]: any; }``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```{ [key: string]: any; }``` | _t__Sub::Metadata::DESCRIPTION | | | `showProgressStepper` | ```boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```Array```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```Array```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/node/docs/model/UnclaimedDraftCreateResponse.md b/sdks/node/docs/model/UnclaimedDraftCreateResponse.md index 439d6b272..3dd57c60b 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateResponse.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `unclaimedDraft`*_required_ | [```UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/UnclaimedDraftResponse.md b/sdks/node/docs/model/UnclaimedDraftResponse.md index 0d7be38bc..314f48f79 100644 --- a/sdks/node/docs/model/UnclaimedDraftResponse.md +++ b/sdks/node/docs/model/UnclaimedDraftResponse.md @@ -1,16 +1,16 @@ # # UnclaimedDraftResponse -A group of documents that a user can take ownership of via the claim URL. +_t__UnclaimedDraftResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signatureRequestId` | ```string``` | The ID of the signature request that is represented by this UnclaimedDraft. | | -| `claimUrl` | ```string``` | The URL to be used to claim this UnclaimedDraft. | | -| `signingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `requestingRedirectUrl` | ```string``` | The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). | | -| `expiresAt` | ```number``` | When the link expires. | | -| `testMode` | ```boolean``` | Whether this is a test draft. Signature requests made from test drafts have no legal value. | | +| `signatureRequestId` | ```string``` | _t__UnclaimedDraft::SIGNATURE_REQUEST_ID | | +| `claimUrl` | ```string``` | _t__UnclaimedDraft::CLAIM_URL | | +| `signingRedirectUrl` | ```string``` | _t__UnclaimedDraft::SIGNING_REDIRECT_URL | | +| `requestingRedirectUrl` | ```string``` | _t__UnclaimedDraft::REQUESTING_REDIRECT_URL | | +| `expiresAt` | ```number``` | _t__UnclaimedDraft::EXPIRES_AT | | +| `testMode` | ```boolean``` | _t__UnclaimedDraft::TEST_MODE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/WarningResponse.md b/sdks/node/docs/model/WarningResponse.md index 446eab4bb..ec2fbdef2 100644 --- a/sdks/node/docs/model/WarningResponse.md +++ b/sdks/node/docs/model/WarningResponse.md @@ -1,12 +1,12 @@ # # WarningResponse -A list of warnings. +_t__WarningResponse::LIST_DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `warningMsg`*_required_ | ```string``` | Warning message | | -| `warningName`*_required_ | ```string``` | Warning name | | +| `warningMsg`*_required_ | ```string``` | _t__WarningResponse::WARNING_MSG | | +| `warningName`*_required_ | ```string``` | _t__WarningResponse::WARNING_NAME | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/model/accountCreateResponse.ts b/sdks/node/model/accountCreateResponse.ts index cdc2e0479..68974c938 100644 --- a/sdks/node/model/accountCreateResponse.ts +++ b/sdks/node/model/accountCreateResponse.ts @@ -31,7 +31,7 @@ export class AccountCreateResponse { "account": AccountResponse; "oauthData"?: OAuthTokenResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/accountGetResponse.ts b/sdks/node/model/accountGetResponse.ts index 1ce7e6d37..35374fd66 100644 --- a/sdks/node/model/accountGetResponse.ts +++ b/sdks/node/model/accountGetResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class AccountGetResponse { "account": AccountResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/accountResponse.ts b/sdks/node/model/accountResponse.ts index 73394d615..7ad56d260 100644 --- a/sdks/node/model/accountResponse.ts +++ b/sdks/node/model/accountResponse.ts @@ -28,40 +28,40 @@ import { AccountResponseUsage } from "./accountResponseUsage"; export class AccountResponse { /** - * The ID of the Account + * _t__Account::ACCOUNT_ID */ "accountId"?: string; /** - * The email address associated with the Account. + * _t__Account::EMAIL_ADDRESS */ "emailAddress"?: string; /** - * Returns `true` if the user has been locked out of their account by a team admin. + * _t__Account::IS_LOCKED */ "isLocked"?: boolean; /** - * Returns `true` if the user has a paid Dropbox Sign account. + * _t__Account::IS_PAID_HS */ "isPaidHs"?: boolean; /** - * Returns `true` if the user has a paid HelloFax account. + * _t__Account::IS_PAID_HF */ "isPaidHf"?: boolean; "quotas"?: AccountResponseQuotas; /** - * The URL that Dropbox Sign events will `POST` to. + * _t__Account::CALLBACK_URL */ "callbackUrl"?: string | null; /** - * The membership role for the team. + * _t__Account::ROLE_CODE */ "roleCode"?: string | null; /** - * The id of the team account belongs to. + * _t__Account::TEAM_ID */ "teamId"?: string | null; /** - * 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. + * _t__Account::LOCALE */ "locale"?: string | null; "usage"?: AccountResponseUsage; diff --git a/sdks/node/model/accountResponseQuotas.ts b/sdks/node/model/accountResponseQuotas.ts index 5bc605e4f..fb8db0829 100644 --- a/sdks/node/model/accountResponseQuotas.ts +++ b/sdks/node/model/accountResponseQuotas.ts @@ -25,31 +25,31 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Details concerning remaining monthly quotas. + * _t__Account::QUOTA */ export class AccountResponseQuotas { /** - * API signature requests remaining. + * _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT */ "apiSignatureRequestsLeft"?: number | null; /** - * Signature requests remaining. + * _t__AccountQuota::DOCUMENTS_LEFT */ "documentsLeft"?: number | null; /** - * Total API templates allowed. + * _t__AccountQuota::TEMPLATES_TOTAL */ "templatesTotal"?: number | null; /** - * API templates remaining. + * _t__AccountQuota::TEMPLATES_LEFT */ "templatesLeft"?: number | null; /** - * SMS verifications remaining. + * _t__AccountQuota::SMS_VERIFICATIONS_LEFT */ "smsVerificationsLeft"?: number | null; /** - * Number of fax pages left + * _t__AccountQuota::NUM_FAX_PAGES_LEFT */ "numFaxPagesLeft"?: number | null; diff --git a/sdks/node/model/accountResponseUsage.ts b/sdks/node/model/accountResponseUsage.ts index 95f6f9f88..bbf0d04a8 100644 --- a/sdks/node/model/accountResponseUsage.ts +++ b/sdks/node/model/accountResponseUsage.ts @@ -25,11 +25,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Details concerning monthly usage + * _t__Account::USAGE */ export class AccountResponseUsage { /** - * Number of fax pages sent + * _t__AccountUsage::FAX_PAGES_SENT */ "faxPagesSent"?: number | null; diff --git a/sdks/node/model/accountVerifyResponse.ts b/sdks/node/model/accountVerifyResponse.ts index ef067ad84..f7440a761 100644 --- a/sdks/node/model/accountVerifyResponse.ts +++ b/sdks/node/model/accountVerifyResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class AccountVerifyResponse { "account"?: AccountVerifyResponseAccount; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/accountVerifyResponseAccount.ts b/sdks/node/model/accountVerifyResponseAccount.ts index 0db1f1770..b09176992 100644 --- a/sdks/node/model/accountVerifyResponseAccount.ts +++ b/sdks/node/model/accountVerifyResponseAccount.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class AccountVerifyResponseAccount { /** - * The email address associated with the Account. + * _t__Account::EMAIL_ADDRESS */ "emailAddress"?: string; diff --git a/sdks/node/model/apiAppGetResponse.ts b/sdks/node/model/apiAppGetResponse.ts index de4f9211a..739932cc7 100644 --- a/sdks/node/model/apiAppGetResponse.ts +++ b/sdks/node/model/apiAppGetResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class ApiAppGetResponse { "apiApp": ApiAppResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/apiAppListResponse.ts b/sdks/node/model/apiAppListResponse.ts index d5b3379a9..18347067c 100644 --- a/sdks/node/model/apiAppListResponse.ts +++ b/sdks/node/model/apiAppListResponse.ts @@ -29,12 +29,12 @@ import { WarningResponse } from "./warningResponse"; export class ApiAppListResponse { /** - * Contains information about API Apps. + * _t__ApiAppListResponse::DESCRIPTION */ "apiApps": Array; "listInfo": ListInfoResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/apiAppResponse.ts b/sdks/node/model/apiAppResponse.ts index 167b3eb15..605196372 100644 --- a/sdks/node/model/apiAppResponse.ts +++ b/sdks/node/model/apiAppResponse.ts @@ -29,31 +29,31 @@ import { ApiAppResponseOwnerAccount } from "./apiAppResponseOwnerAccount"; import { ApiAppResponseWhiteLabelingOptions } from "./apiAppResponseWhiteLabelingOptions"; /** - * Contains information about an API App. + * _t__ApiAppResponse::DESCRIPTION */ export class ApiAppResponse { /** - * The app\'s callback URL (for events) + * _t__ApiAppResponse::CALLBACK_URL */ "callbackUrl"?: string | null; /** - * The app\'s client id + * _t__ApiAppResponse::CLIENT_ID */ "clientId"?: string; /** - * The time that the app was created + * _t__ApiAppResponse::CREATED_AT */ "createdAt"?: number; /** - * The domain name(s) associated with the app + * _t__ApiAppResponse::DOMAINS */ "domains"?: Array; /** - * The name of the app + * _t__ApiAppResponse::NAME */ "name"?: string; /** - * Boolean to indicate if the app has been approved + * _t__ApiAppResponse::IS_APPROVED */ "isApproved"?: boolean; "oauth"?: ApiAppResponseOAuth | null; diff --git a/sdks/node/model/apiAppResponseOAuth.ts b/sdks/node/model/apiAppResponseOAuth.ts index cefb71be1..b5c13094f 100644 --- a/sdks/node/model/apiAppResponseOAuth.ts +++ b/sdks/node/model/apiAppResponseOAuth.ts @@ -25,23 +25,23 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * An object describing the app\'s OAuth properties, or null if OAuth is not configured for the app. + * _t__ApiAppResponseOAuth::DESCRIPTION */ export class ApiAppResponseOAuth { /** - * The app\'s OAuth callback URL. + * _t__ApiAppResponseOAuth::CALLBACK_URL */ "callbackUrl"?: string; /** - * The app\'s OAuth secret, or null if the app does not belong to user. + * _t__ApiAppResponseOAuth::SECRET */ "secret"?: string | null; /** - * Array of OAuth scopes used by the app. + * _t__ApiAppResponseOAuth::SCOPES */ "scopes"?: Array; /** - * Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. + * _t__ApiAppResponseOAuth::CHARGES_USERS */ "chargesUsers"?: boolean; diff --git a/sdks/node/model/apiAppResponseOptions.ts b/sdks/node/model/apiAppResponseOptions.ts index 3d36cd672..9dfeb3f09 100644 --- a/sdks/node/model/apiAppResponseOptions.ts +++ b/sdks/node/model/apiAppResponseOptions.ts @@ -25,11 +25,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * An object with options that override account settings. + * _t__ApiAppResponseOptions::DESCRIPTION */ export class ApiAppResponseOptions { /** - * Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document + * _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE */ "canInsertEverywhere"?: boolean; diff --git a/sdks/node/model/apiAppResponseOwnerAccount.ts b/sdks/node/model/apiAppResponseOwnerAccount.ts index 8abfae818..a0845bca8 100644 --- a/sdks/node/model/apiAppResponseOwnerAccount.ts +++ b/sdks/node/model/apiAppResponseOwnerAccount.ts @@ -25,15 +25,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * An object describing the app\'s owner + * _t__ApiAppResponseOwnerAccount::DESCRIPTION */ export class ApiAppResponseOwnerAccount { /** - * The owner account\'s ID + * _t__ApiAppResponseOwnerAccount::ACCOUNT_ID */ "accountId"?: string; /** - * The owner account\'s email address + * _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS */ "emailAddress"?: string; diff --git a/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts b/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts index 6c4beeebe..55e7b466d 100644 --- a/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts +++ b/sdks/node/model/apiAppResponseWhiteLabelingOptions.ts @@ -25,7 +25,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * An object with options to customize the app\'s signer page + * _t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION */ export class ApiAppResponseWhiteLabelingOptions { "headerBackgroundColor"?: string; diff --git a/sdks/node/model/bulkSendJobGetResponse.ts b/sdks/node/model/bulkSendJobGetResponse.ts index ed3ed1c3a..4fd36975b 100644 --- a/sdks/node/model/bulkSendJobGetResponse.ts +++ b/sdks/node/model/bulkSendJobGetResponse.ts @@ -32,11 +32,11 @@ export class BulkSendJobGetResponse { "bulkSendJob": BulkSendJobResponse; "listInfo": ListInfoResponse; /** - * Contains information about the Signature Requests sent in bulk. + * _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS */ "signatureRequests": Array; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/bulkSendJobGetResponseSignatureRequests.ts b/sdks/node/model/bulkSendJobGetResponseSignatureRequests.ts index 9ff1456f6..68157c897 100644 --- a/sdks/node/model/bulkSendJobGetResponseSignatureRequests.ts +++ b/sdks/node/model/bulkSendJobGetResponseSignatureRequests.ts @@ -30,103 +30,103 @@ import { SignatureRequestResponseSignatures } from "./signatureRequestResponseSi export class BulkSendJobGetResponseSignatureRequests { /** - * Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + * _t__SignatureRequestResponse::TEST_MODE */ "testMode"?: boolean = false; /** - * The id of the SignatureRequest. + * _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID */ "signatureRequestId"?: string; /** - * The email address of the initiator of the SignatureRequest. + * _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS */ "requesterEmailAddress"?: string | null; /** - * The title the specified Account uses for the SignatureRequest. + * _t__SignatureRequestResponse::TITLE */ "title"?: string; /** - * Default Label for account. + * _t__SignatureRequestResponse::ORIGINAL_TITLE */ "originalTitle"?: string; /** - * The subject in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::SUBJECT */ "subject"?: string | null; /** - * The custom message in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::MESSAGE */ "message"?: string | null; /** - * The metadata attached to the signature request. + * _t__SignatureRequestResponse::METADATA */ "metadata"?: { [key: string]: any }; /** - * Time the signature request was created. + * _t__SignatureRequestResponse::CREATED_AT */ "createdAt"?: number; /** - * The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * _t__SignatureRequestResponse::EXPIRES_AT */ "expiresAt"?: number | null; /** - * Whether or not the SignatureRequest has been fully executed by all signers. + * _t__SignatureRequestResponse::IS_COMPLETE */ "isComplete"?: boolean; /** - * Whether or not the SignatureRequest has been declined by a signer. + * _t__SignatureRequestResponse::IS_DECLINED */ "isDeclined"?: boolean; /** - * Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + * _t__SignatureRequestResponse::HAS_ERROR */ "hasError"?: boolean; /** - * The URL where a copy of the request\'s documents can be downloaded. + * _t__SignatureRequestResponse::FILES_URL */ "filesUrl"?: string; /** - * The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + * _t__SignatureRequestResponse::SIGNING_URL */ "signingUrl"?: string | null; /** - * The URL where the requester and the signers can view the current status of the SignatureRequest. + * _t__SignatureRequestResponse::DETAILS_URL */ "detailsUrl"?: string; /** - * A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + * _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES */ "ccEmailAddresses"?: Array; /** - * The URL you want the signer redirected to after they successfully sign. + * _t__SignatureRequestResponse::SIGNING_REDIRECT_URL */ "signingRedirectUrl"?: string | null; /** - * The path where the completed document can be downloaded + * _t__SignatureRequestResponse::FINAL_COPY_URI */ "finalCopyUri"?: string | null; /** - * Templates IDs used in this SignatureRequest (if any). + * _t__SignatureRequestResponse::TEMPLATE_IDS */ "templateIds"?: Array | null; /** - * An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * _t__SignatureRequestResponseCustomField::DESCRIPTION */ "customFields"?: Array | null; /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION */ "attachments"?: Array | null; /** - * An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + * _t__SignatureRequestResponseData::DESCRIPTION */ "responseData"?: Array | null; /** - * An array of signature objects, 1 for each signer. + * _t__SignatureRequestResponseSignatures::DESCRIPTION */ "signatures"?: Array; /** - * The id of the BulkSendJob. + * _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID */ "bulkSendJobId"?: string; diff --git a/sdks/node/model/bulkSendJobListResponse.ts b/sdks/node/model/bulkSendJobListResponse.ts index 142a37d20..937540f90 100644 --- a/sdks/node/model/bulkSendJobListResponse.ts +++ b/sdks/node/model/bulkSendJobListResponse.ts @@ -29,12 +29,12 @@ import { WarningResponse } from "./warningResponse"; export class BulkSendJobListResponse { /** - * Contains a list of BulkSendJobs that the API caller has access to. + * _t__BulkSendJobListResponse::BULK_SEND_JOBS */ "bulkSendJobs": Array; "listInfo": ListInfoResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/bulkSendJobResponse.ts b/sdks/node/model/bulkSendJobResponse.ts index 115d7fb01..c9ec4604b 100644 --- a/sdks/node/model/bulkSendJobResponse.ts +++ b/sdks/node/model/bulkSendJobResponse.ts @@ -25,23 +25,23 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. + * _t__BulkSendJobResponse::DESCRIPTION */ export class BulkSendJobResponse { /** - * The id of the BulkSendJob. + * _t__BulkSendJobResponse::BULK_SEND_JOB_ID */ "bulkSendJobId"?: string | null; /** - * The total amount of Signature Requests queued for sending. + * _t__BulkSendJobResponse::TOTAL */ "total"?: number; /** - * True if you are the owner of this BulkSendJob, false if it\'s been shared with you by a team member. + * _t__BulkSendJobResponse::IS_CREATOR */ "isCreator"?: boolean; /** - * Time that the BulkSendJob was created. + * _t__BulkSendJobResponse::CREATED_AT */ "createdAt"?: number; diff --git a/sdks/node/model/bulkSendJobSendResponse.ts b/sdks/node/model/bulkSendJobSendResponse.ts index 0d9efa12d..8497302ce 100644 --- a/sdks/node/model/bulkSendJobSendResponse.ts +++ b/sdks/node/model/bulkSendJobSendResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class BulkSendJobSendResponse { "bulkSendJob": BulkSendJobResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/embeddedEditUrlRequest.ts b/sdks/node/model/embeddedEditUrlRequest.ts index 865da4415..5548ef9bb 100644 --- a/sdks/node/model/embeddedEditUrlRequest.ts +++ b/sdks/node/model/embeddedEditUrlRequest.ts @@ -31,6 +31,10 @@ export class EmbeddedEditUrlRequest { * This allows the requester to enable/disable to add or change CC roles when editing the template. */ "allowEditCcs"?: boolean = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; /** * The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. */ @@ -73,6 +77,11 @@ export class EmbeddedEditUrlRequest { baseName: "allow_edit_ccs", type: "boolean", }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean", + }, { name: "ccRoles", baseName: "cc_roles", diff --git a/sdks/node/model/embeddedEditUrlResponse.ts b/sdks/node/model/embeddedEditUrlResponse.ts index d299e6a0a..d7fb54410 100644 --- a/sdks/node/model/embeddedEditUrlResponse.ts +++ b/sdks/node/model/embeddedEditUrlResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class EmbeddedEditUrlResponse { "embedded": EmbeddedEditUrlResponseEmbedded; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/embeddedEditUrlResponseEmbedded.ts b/sdks/node/model/embeddedEditUrlResponseEmbedded.ts index ad3a99e08..e72f35d91 100644 --- a/sdks/node/model/embeddedEditUrlResponseEmbedded.ts +++ b/sdks/node/model/embeddedEditUrlResponseEmbedded.ts @@ -25,15 +25,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * An embedded template object. + * _t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION */ export class EmbeddedEditUrlResponseEmbedded { /** - * A template url that can be opened in an iFrame. + * _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL */ "editUrl"?: string; /** - * The specific time that the the `edit_url` link expires, in epoch. + * _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT */ "expiresAt"?: number; diff --git a/sdks/node/model/embeddedSignUrlResponse.ts b/sdks/node/model/embeddedSignUrlResponse.ts index 8e34234d0..9908b27f9 100644 --- a/sdks/node/model/embeddedSignUrlResponse.ts +++ b/sdks/node/model/embeddedSignUrlResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class EmbeddedSignUrlResponse { "embedded": EmbeddedSignUrlResponseEmbedded; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/embeddedSignUrlResponseEmbedded.ts b/sdks/node/model/embeddedSignUrlResponseEmbedded.ts index 2cc11e748..70ca35e29 100644 --- a/sdks/node/model/embeddedSignUrlResponseEmbedded.ts +++ b/sdks/node/model/embeddedSignUrlResponseEmbedded.ts @@ -25,15 +25,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * An object that contains necessary information to set up embedded signing. + * _t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION */ export class EmbeddedSignUrlResponseEmbedded { /** - * A signature url that can be opened in an iFrame. + * _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL */ "signUrl"?: string; /** - * The specific time that the the `sign_url` link expires, in epoch. + * _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT */ "expiresAt"?: number; diff --git a/sdks/node/model/errorResponseError.ts b/sdks/node/model/errorResponseError.ts index 577bb5dd5..1988f2eec 100644 --- a/sdks/node/model/errorResponseError.ts +++ b/sdks/node/model/errorResponseError.ts @@ -25,19 +25,19 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Contains information about an error that occurred. + * _t__ErrorResponseError::DESCRIPTION */ export class ErrorResponseError { /** - * Message describing an error. + * _t__ErrorResponseError::ERROR_MSG */ "errorMsg": string; /** - * Name of the error. + * _t__ErrorResponseError::ERROR_NAME */ "errorName": string; /** - * Path at which an error occurred. + * _t__ErrorResponseError::ERROR_PATH */ "errorPath"?: string; diff --git a/sdks/node/model/eventCallbackRequestEvent.ts b/sdks/node/model/eventCallbackRequestEvent.ts index 423380752..3f5810362 100644 --- a/sdks/node/model/eventCallbackRequestEvent.ts +++ b/sdks/node/model/eventCallbackRequestEvent.ts @@ -26,19 +26,19 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { EventCallbackRequestEventMetadata } from "./eventCallbackRequestEventMetadata"; /** - * Basic information about the event that occurred. + * _t__EventCallbackRequestEvent::DESCRIPTION */ export class EventCallbackRequestEvent { /** - * Time the event was created (using Unix time). + * _t__EventCallbackRequestEvent::EVENT_TIME */ "eventTime": string; /** - * Type of callback event that was triggered. + * _t__EventCallbackRequestEvent::EVENT_TYPE */ "eventType": EventCallbackRequestEvent.EventTypeEnum; /** - * Generated hash used to verify source of event data. + * _t__EventCallbackRequestEvent::EVENT_HASH */ "eventHash": string; "eventMetadata"?: EventCallbackRequestEventMetadata; diff --git a/sdks/node/model/eventCallbackRequestEventMetadata.ts b/sdks/node/model/eventCallbackRequestEventMetadata.ts index 22894d2d8..2710cf37b 100644 --- a/sdks/node/model/eventCallbackRequestEventMetadata.ts +++ b/sdks/node/model/eventCallbackRequestEventMetadata.ts @@ -25,23 +25,23 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Specific metadata about the event. + * _t__EventCallbackRequestEventMetadata::DESCRIPTION */ export class EventCallbackRequestEventMetadata { /** - * Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. + * _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID */ "relatedSignatureId"?: string | null; /** - * Account ID the event was reported for. + * _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID */ "reportedForAccountId"?: string | null; /** - * App ID the event was reported for. + * _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID */ "reportedForAppId"?: string | null; /** - * Message about a declined or failed (due to error) signature flow. + * _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE */ "eventMessage"?: string | null; diff --git a/sdks/node/model/faxGetResponse.ts b/sdks/node/model/faxGetResponse.ts index aa016746a..1c13138ba 100644 --- a/sdks/node/model/faxGetResponse.ts +++ b/sdks/node/model/faxGetResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class FaxGetResponse { "fax": FaxResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/fileResponse.ts b/sdks/node/model/fileResponse.ts index 068b9e7a5..80bd7706c 100644 --- a/sdks/node/model/fileResponse.ts +++ b/sdks/node/model/fileResponse.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FileResponse { /** - * URL to the file. + * _t__FileResponse::FILE_URL */ "fileUrl": string; /** - * When the link expires. + * _t__FileResponse::EXPIRES_AT */ "expiresAt": number; diff --git a/sdks/node/model/fileResponseDataUri.ts b/sdks/node/model/fileResponseDataUri.ts index 44ec2dbab..16634c53b 100644 --- a/sdks/node/model/fileResponseDataUri.ts +++ b/sdks/node/model/fileResponseDataUri.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FileResponseDataUri { /** - * File as base64 encoded string. + * _t__FileResponse::DATA_URI */ "dataUri": string; diff --git a/sdks/node/model/listInfoResponse.ts b/sdks/node/model/listInfoResponse.ts index b689f42e7..c8d9fd89e 100644 --- a/sdks/node/model/listInfoResponse.ts +++ b/sdks/node/model/listInfoResponse.ts @@ -25,23 +25,23 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Contains pagination information about the data returned. + * _t__ListInfoResponse::DESCRIPTION */ export class ListInfoResponse { /** - * Total number of pages available. + * _t__ListInfoResponse::NUM_PAGES */ "numPages"?: number; /** - * Total number of objects available. + * _t__ListInfoResponse::NUM_RESULTS */ "numResults"?: number | null; /** - * Number of the page being returned. + * _t__ListInfoResponse::PAGE */ "page"?: number; /** - * Objects returned per page. + * _t__ListInfoResponse::PAGE_SIZE */ "pageSize"?: number; diff --git a/sdks/node/model/oAuthTokenResponse.ts b/sdks/node/model/oAuthTokenResponse.ts index e1c6d4c0c..076aefac0 100644 --- a/sdks/node/model/oAuthTokenResponse.ts +++ b/sdks/node/model/oAuthTokenResponse.ts @@ -29,7 +29,7 @@ export class OAuthTokenResponse { "tokenType"?: string; "refreshToken"?: string; /** - * Number of seconds until the `access_token` expires. Uses epoch time. + * _t__OAuthTokenResponse::EXPIRES_IN */ "expiresIn"?: number; "state"?: string | null; diff --git a/sdks/node/model/reportCreateRequest.ts b/sdks/node/model/reportCreateRequest.ts index 48960ccc4..de074447a 100644 --- a/sdks/node/model/reportCreateRequest.ts +++ b/sdks/node/model/reportCreateRequest.ts @@ -72,5 +72,6 @@ export namespace ReportCreateRequest { export enum ReportTypeEnum { UserActivity = "user_activity", DocumentStatus = "document_status", + SmsActivity = "sms_activity", } } diff --git a/sdks/node/model/reportCreateResponse.ts b/sdks/node/model/reportCreateResponse.ts index 1c651699f..05432b7d1 100644 --- a/sdks/node/model/reportCreateResponse.ts +++ b/sdks/node/model/reportCreateResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class ReportCreateResponse { "report": ReportResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/reportResponse.ts b/sdks/node/model/reportResponse.ts index 589ded1ce..2ec513678 100644 --- a/sdks/node/model/reportResponse.ts +++ b/sdks/node/model/reportResponse.ts @@ -25,23 +25,23 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Contains information about the report request. + * _t__ReportResponse::DESCRIPTION */ export class ReportResponse { /** - * A message indicating the requested operation\'s success + * _t__ReportResponse::SUCCESS */ "success"?: string; /** - * The (inclusive) start date for the report data in MM/DD/YYYY format. + * _t__ReportResponse::START_DATE */ "startDate"?: string; /** - * The (inclusive) end date for the report data in MM/DD/YYYY format. + * _t__ReportResponse::END_DATE */ "endDate"?: string; /** - * 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). + * _t__ReportResponse::REPORT_TYPE */ "reportType"?: Array; @@ -84,5 +84,6 @@ export namespace ReportResponse { export enum ReportTypeEnum { UserActivity = "user_activity", DocumentStatus = "document_status", + SmsActivity = "sms_activity", } } diff --git a/sdks/node/model/signatureRequestBulkCreateEmbeddedWithTemplateRequest.ts b/sdks/node/model/signatureRequestBulkCreateEmbeddedWithTemplateRequest.ts index 8901d5b16..aac6a7725 100644 --- a/sdks/node/model/signatureRequestBulkCreateEmbeddedWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestBulkCreateEmbeddedWithTemplateRequest.ts @@ -61,7 +61,7 @@ export class SignatureRequestBulkCreateEmbeddedWithTemplateRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; /** diff --git a/sdks/node/model/signatureRequestBulkSendWithTemplateRequest.ts b/sdks/node/model/signatureRequestBulkSendWithTemplateRequest.ts index c8c07dc36..9a523e9a1 100644 --- a/sdks/node/model/signatureRequestBulkSendWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestBulkSendWithTemplateRequest.ts @@ -61,7 +61,7 @@ export class SignatureRequestBulkSendWithTemplateRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; /** diff --git a/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts b/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts index 774cbec6c..a0d636d1a 100644 --- a/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts +++ b/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts @@ -47,23 +47,27 @@ export class SignatureRequestCreateEmbeddedRequest { */ "fileUrls"?: Array; /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION */ "signers"?: Array; /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION */ "groupedSigners"?: Array; /** * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ "allowDecline"?: boolean = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. */ "allowReassign"?: boolean = false; /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION */ "attachments"?: Array; /** @@ -96,7 +100,7 @@ export class SignatureRequestCreateEmbeddedRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; "signingOptions"?: SubSigningOptions; @@ -158,6 +162,11 @@ export class SignatureRequestCreateEmbeddedRequest { baseName: "allow_decline", type: "boolean", }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean", + }, { name: "allowReassign", baseName: "allow_reassign", diff --git a/sdks/node/model/signatureRequestCreateEmbeddedWithTemplateRequest.ts b/sdks/node/model/signatureRequestCreateEmbeddedWithTemplateRequest.ts index 08b7b6e58..b1e2ee5cc 100644 --- a/sdks/node/model/signatureRequestCreateEmbeddedWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestCreateEmbeddedWithTemplateRequest.ts @@ -38,7 +38,7 @@ export class SignatureRequestCreateEmbeddedWithTemplateRequest { */ "clientId": string; /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION */ "signers": Array; /** @@ -66,7 +66,7 @@ export class SignatureRequestCreateEmbeddedWithTemplateRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; "signingOptions"?: SubSigningOptions; diff --git a/sdks/node/model/signatureRequestEditEmbeddedRequest.ts b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts index 78b05c0ac..691272967 100644 --- a/sdks/node/model/signatureRequestEditEmbeddedRequest.ts +++ b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts @@ -47,23 +47,27 @@ export class SignatureRequestEditEmbeddedRequest { */ "fileUrls"?: Array; /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION */ "signers"?: Array; /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION */ "groupedSigners"?: Array; /** * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ "allowDecline"?: boolean = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. */ "allowReassign"?: boolean = false; /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION */ "attachments"?: Array; /** @@ -96,7 +100,7 @@ export class SignatureRequestEditEmbeddedRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; "signingOptions"?: SubSigningOptions; @@ -158,6 +162,11 @@ export class SignatureRequestEditEmbeddedRequest { baseName: "allow_decline", type: "boolean", }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean", + }, { name: "allowReassign", baseName: "allow_reassign", diff --git a/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts b/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts index c007c76ca..ca946d5ef 100644 --- a/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts @@ -38,7 +38,7 @@ export class SignatureRequestEditEmbeddedWithTemplateRequest { */ "clientId": string; /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION */ "signers": Array; /** @@ -66,7 +66,7 @@ export class SignatureRequestEditEmbeddedWithTemplateRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; "signingOptions"?: SubSigningOptions; diff --git a/sdks/node/model/signatureRequestEditRequest.ts b/sdks/node/model/signatureRequestEditRequest.ts index 432e8fe4f..c438c36ce 100644 --- a/sdks/node/model/signatureRequestEditRequest.ts +++ b/sdks/node/model/signatureRequestEditRequest.ts @@ -43,23 +43,27 @@ export class SignatureRequestEditRequest { */ "fileUrls"?: Array; /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION */ "signers"?: Array; /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION */ "groupedSigners"?: Array; /** * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ "allowDecline"?: boolean = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ "allowReassign"?: boolean = false; /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION */ "attachments"?: Array; /** @@ -100,7 +104,7 @@ export class SignatureRequestEditRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; "signingOptions"?: SubSigningOptions; @@ -157,6 +161,11 @@ export class SignatureRequestEditRequest { baseName: "allow_decline", type: "boolean", }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean", + }, { name: "allowReassign", baseName: "allow_reassign", diff --git a/sdks/node/model/signatureRequestEditWithTemplateRequest.ts b/sdks/node/model/signatureRequestEditWithTemplateRequest.ts index f35af5999..f1ce12cee 100644 --- a/sdks/node/model/signatureRequestEditWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestEditWithTemplateRequest.ts @@ -37,7 +37,7 @@ export class SignatureRequestEditWithTemplateRequest { */ "templateIds": Array; /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION */ "signers": Array; /** @@ -73,7 +73,7 @@ export class SignatureRequestEditWithTemplateRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; "signingOptions"?: SubSigningOptions; diff --git a/sdks/node/model/signatureRequestGetResponse.ts b/sdks/node/model/signatureRequestGetResponse.ts index 31023c28f..4a82f1eb6 100644 --- a/sdks/node/model/signatureRequestGetResponse.ts +++ b/sdks/node/model/signatureRequestGetResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class SignatureRequestGetResponse { "signatureRequest": SignatureRequestResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/signatureRequestListResponse.ts b/sdks/node/model/signatureRequestListResponse.ts index acb50fe40..1109154af 100644 --- a/sdks/node/model/signatureRequestListResponse.ts +++ b/sdks/node/model/signatureRequestListResponse.ts @@ -29,12 +29,12 @@ import { WarningResponse } from "./warningResponse"; export class SignatureRequestListResponse { /** - * Contains information about signature requests. + * _t__SignatureRequestListResponse::DESCRIPTION */ "signatureRequests": Array; "listInfo": ListInfoResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/signatureRequestResponse.ts b/sdks/node/model/signatureRequestResponse.ts index 014da962b..30cfc5ac4 100644 --- a/sdks/node/model/signatureRequestResponse.ts +++ b/sdks/node/model/signatureRequestResponse.ts @@ -29,107 +29,107 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData import { SignatureRequestResponseSignatures } from "./signatureRequestResponseSignatures"; /** - * Contains information about a signature request. + * _t__SignatureRequestResponse::DESCRIPTION */ export class SignatureRequestResponse { /** - * Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + * _t__SignatureRequestResponse::TEST_MODE */ "testMode"?: boolean = false; /** - * The id of the SignatureRequest. + * _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID */ "signatureRequestId"?: string; /** - * The email address of the initiator of the SignatureRequest. + * _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS */ "requesterEmailAddress"?: string | null; /** - * The title the specified Account uses for the SignatureRequest. + * _t__SignatureRequestResponse::TITLE */ "title"?: string; /** - * Default Label for account. + * _t__SignatureRequestResponse::ORIGINAL_TITLE */ "originalTitle"?: string; /** - * The subject in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::SUBJECT */ "subject"?: string | null; /** - * The custom message in the email that was initially sent to the signers. + * _t__SignatureRequestResponse::MESSAGE */ "message"?: string | null; /** - * The metadata attached to the signature request. + * _t__SignatureRequestResponse::METADATA */ "metadata"?: { [key: string]: any }; /** - * Time the signature request was created. + * _t__SignatureRequestResponse::CREATED_AT */ "createdAt"?: number; /** - * The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * _t__SignatureRequestResponse::EXPIRES_AT */ "expiresAt"?: number | null; /** - * Whether or not the SignatureRequest has been fully executed by all signers. + * _t__SignatureRequestResponse::IS_COMPLETE */ "isComplete"?: boolean; /** - * Whether or not the SignatureRequest has been declined by a signer. + * _t__SignatureRequestResponse::IS_DECLINED */ "isDeclined"?: boolean; /** - * Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + * _t__SignatureRequestResponse::HAS_ERROR */ "hasError"?: boolean; /** - * The URL where a copy of the request\'s documents can be downloaded. + * _t__SignatureRequestResponse::FILES_URL */ "filesUrl"?: string; /** - * The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + * _t__SignatureRequestResponse::SIGNING_URL */ "signingUrl"?: string | null; /** - * The URL where the requester and the signers can view the current status of the SignatureRequest. + * _t__SignatureRequestResponse::DETAILS_URL */ "detailsUrl"?: string; /** - * A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + * _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES */ "ccEmailAddresses"?: Array; /** - * The URL you want the signer redirected to after they successfully sign. + * _t__SignatureRequestResponse::SIGNING_REDIRECT_URL */ "signingRedirectUrl"?: string | null; /** - * The path where the completed document can be downloaded + * _t__SignatureRequestResponse::FINAL_COPY_URI */ "finalCopyUri"?: string | null; /** - * Templates IDs used in this SignatureRequest (if any). + * _t__SignatureRequestResponse::TEMPLATE_IDS */ "templateIds"?: Array | null; /** - * An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * _t__SignatureRequestResponseCustomField::DESCRIPTION */ "customFields"?: Array | null; /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION */ "attachments"?: Array | null; /** - * An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + * _t__SignatureRequestResponseData::DESCRIPTION */ "responseData"?: Array | null; /** - * An array of signature objects, 1 for each signer. + * _t__SignatureRequestResponseSignatures::DESCRIPTION */ "signatures"?: Array; /** - * The ID of the Bulk Send job which sent the signature request, if applicable. + * _t__SignatureRequestResponse::BULK_SEND_JOB_ID */ "bulkSendJobId"?: string | null; diff --git a/sdks/node/model/signatureRequestResponseAttachment.ts b/sdks/node/model/signatureRequestResponseAttachment.ts index 8a59e65d2..928edf720 100644 --- a/sdks/node/model/signatureRequestResponseAttachment.ts +++ b/sdks/node/model/signatureRequestResponseAttachment.ts @@ -25,31 +25,31 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION */ export class SignatureRequestResponseAttachment { /** - * The unique ID for this attachment. + * _t__SignatureRequestResponseAttachment::ID */ "id": string; /** - * The Signer this attachment is assigned to. + * _t__SignatureRequestResponseAttachment::SIGNER */ "signer": number | string; /** - * The name of this attachment. + * _t__SignatureRequestResponseAttachment::NAME */ "name": string; /** - * A boolean value denoting if this attachment is required. + * _t__SignatureRequestResponseAttachment::REQUIRED */ "required": boolean; /** - * Instructions for Signer. + * _t__SignatureRequestResponseAttachment::INSTRUCTIONS */ "instructions"?: string | null; /** - * Timestamp when attachment was uploaded by Signer. + * _t__SignatureRequestResponseAttachment::UPLOADED_AT */ "uploadedAt"?: number | null; diff --git a/sdks/node/model/signatureRequestResponseCustomFieldBase.ts b/sdks/node/model/signatureRequestResponseCustomFieldBase.ts index ce0ace207..5cb215f05 100644 --- a/sdks/node/model/signatureRequestResponseCustomFieldBase.ts +++ b/sdks/node/model/signatureRequestResponseCustomFieldBase.ts @@ -25,27 +25,27 @@ import { AttributeTypeMap } from "./"; /** - * An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * _t__SignatureRequestResponseCustomField::DESCRIPTION */ export abstract class SignatureRequestResponseCustomFieldBase { /** - * The type of this Custom Field. Only \'text\' and \'checkbox\' are currently supported. + * _t__SignatureRequestResponseCustomField::TYPE */ "type": string; /** - * The name of the Custom Field. + * _t__SignatureRequestResponseCustomField::NAME */ "name": string; /** - * A boolean value denoting if this field is required. + * _t__SignatureRequestResponseCustomField::REQUIRED */ "required"?: boolean; /** - * The unique ID for this field. + * _t__SignatureRequestResponseCustomField::API_ID */ "apiId"?: string; /** - * The name of the Role that is able to edit this field. + * _t__SignatureRequestResponseCustomField::EDITOR */ "editor"?: string | null; diff --git a/sdks/node/model/signatureRequestResponseCustomFieldCheckbox.ts b/sdks/node/model/signatureRequestResponseCustomFieldCheckbox.ts index 02ab8dcfd..cc12d0bdb 100644 --- a/sdks/node/model/signatureRequestResponseCustomFieldCheckbox.ts +++ b/sdks/node/model/signatureRequestResponseCustomFieldCheckbox.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { SignatureRequestResponseCustomFieldBase } from "./signatureRequestResponseCustomFieldBase"; /** - * This class extends `SignatureRequestResponseCustomFieldBase`. + * _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS */ export class SignatureRequestResponseCustomFieldCheckbox extends SignatureRequestResponseCustomFieldBase { /** - * The type of this Custom Field. Only \'text\' and \'checkbox\' are currently supported. + * _t__SignatureRequestResponseCustomField::TYPE */ "type": string = "checkbox"; /** - * A true/false for checkbox fields + * _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX */ "value"?: boolean; diff --git a/sdks/node/model/signatureRequestResponseCustomFieldText.ts b/sdks/node/model/signatureRequestResponseCustomFieldText.ts index c6b1bc73a..ae9bb2f7e 100644 --- a/sdks/node/model/signatureRequestResponseCustomFieldText.ts +++ b/sdks/node/model/signatureRequestResponseCustomFieldText.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { SignatureRequestResponseCustomFieldBase } from "./signatureRequestResponseCustomFieldBase"; /** - * This class extends `SignatureRequestResponseCustomFieldBase`. + * _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS */ export class SignatureRequestResponseCustomFieldText extends SignatureRequestResponseCustomFieldBase { /** - * The type of this Custom Field. Only \'text\' and \'checkbox\' are currently supported. + * _t__SignatureRequestResponseCustomField::TYPE */ "type": string = "text"; /** - * A text string for text fields + * _t__SignatureRequestResponseCustomField::VALUE_TEXT */ "value"?: string; diff --git a/sdks/node/model/signatureRequestResponseDataBase.ts b/sdks/node/model/signatureRequestResponseDataBase.ts index 42c150334..81a8d8026 100644 --- a/sdks/node/model/signatureRequestResponseDataBase.ts +++ b/sdks/node/model/signatureRequestResponseDataBase.ts @@ -25,23 +25,23 @@ import { AttributeTypeMap } from "./"; /** - * An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + * _t__SignatureRequestResponseData::DESCRIPTION */ export abstract class SignatureRequestResponseDataBase { /** - * The unique ID for this field. + * _t__SignatureRequestResponseData::API_ID */ "apiId"?: string; /** - * The ID of the signature to which this response is linked. + * _t__SignatureRequestResponseData::SIGNATURE_ID */ "signatureId"?: string; /** - * The name of the form field. + * _t__SignatureRequestResponseData::NAME */ "name"?: string; /** - * A boolean value denoting if this field is required. + * _t__SignatureRequestResponseData::REQUIRED */ "required"?: boolean; "type"?: string; diff --git a/sdks/node/model/signatureRequestResponseDataValueCheckbox.ts b/sdks/node/model/signatureRequestResponseDataValueCheckbox.ts index c64f356c9..c6486867e 100644 --- a/sdks/node/model/signatureRequestResponseDataValueCheckbox.ts +++ b/sdks/node/model/signatureRequestResponseDataValueCheckbox.ts @@ -27,11 +27,11 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData export class SignatureRequestResponseDataValueCheckbox extends SignatureRequestResponseDataBase { /** - * A yes/no checkbox + * _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE */ "type"?: string = "checkbox"; /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE */ "value"?: boolean; diff --git a/sdks/node/model/signatureRequestResponseDataValueCheckboxMerge.ts b/sdks/node/model/signatureRequestResponseDataValueCheckboxMerge.ts index 2c5edeb49..c5ac52d6c 100644 --- a/sdks/node/model/signatureRequestResponseDataValueCheckboxMerge.ts +++ b/sdks/node/model/signatureRequestResponseDataValueCheckboxMerge.ts @@ -27,11 +27,11 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData export class SignatureRequestResponseDataValueCheckboxMerge extends SignatureRequestResponseDataBase { /** - * A checkbox field that has default value set by the api + * _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE */ "type"?: string = "checkbox-merge"; /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE */ "value"?: string; diff --git a/sdks/node/model/signatureRequestResponseDataValueDateSigned.ts b/sdks/node/model/signatureRequestResponseDataValueDateSigned.ts index 097e81008..06bd8328f 100644 --- a/sdks/node/model/signatureRequestResponseDataValueDateSigned.ts +++ b/sdks/node/model/signatureRequestResponseDataValueDateSigned.ts @@ -27,11 +27,11 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData export class SignatureRequestResponseDataValueDateSigned extends SignatureRequestResponseDataBase { /** - * A date + * _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE */ "type"?: string = "date_signed"; /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE */ "value"?: string; diff --git a/sdks/node/model/signatureRequestResponseDataValueDropdown.ts b/sdks/node/model/signatureRequestResponseDataValueDropdown.ts index b9660803d..58251f76e 100644 --- a/sdks/node/model/signatureRequestResponseDataValueDropdown.ts +++ b/sdks/node/model/signatureRequestResponseDataValueDropdown.ts @@ -27,11 +27,11 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData export class SignatureRequestResponseDataValueDropdown extends SignatureRequestResponseDataBase { /** - * An input field for dropdowns + * _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE */ "type"?: string = "dropdown"; /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE */ "value"?: string; diff --git a/sdks/node/model/signatureRequestResponseDataValueInitials.ts b/sdks/node/model/signatureRequestResponseDataValueInitials.ts index 9d3975eb1..69d86c9fa 100644 --- a/sdks/node/model/signatureRequestResponseDataValueInitials.ts +++ b/sdks/node/model/signatureRequestResponseDataValueInitials.ts @@ -27,15 +27,15 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData export class SignatureRequestResponseDataValueInitials extends SignatureRequestResponseDataBase { /** - * An input field for initials + * _t__SignatureRequestResponseDataValue::INITIAL_TYPE */ "type"?: string = "initials"; /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE */ "value"?: string; /** - * This field contains the boolean true if the field is signed. + * _t__SignatureRequestResponseDataValue::IS_SIGNED */ "isSigned"?: boolean | null; diff --git a/sdks/node/model/signatureRequestResponseDataValueRadio.ts b/sdks/node/model/signatureRequestResponseDataValueRadio.ts index 8f570485a..6de35f9d0 100644 --- a/sdks/node/model/signatureRequestResponseDataValueRadio.ts +++ b/sdks/node/model/signatureRequestResponseDataValueRadio.ts @@ -27,11 +27,11 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData export class SignatureRequestResponseDataValueRadio extends SignatureRequestResponseDataBase { /** - * An input field for radios + * _t__SignatureRequestResponseDataValue::RADIO_TYPE */ "type"?: string = "radio"; /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE */ "value"?: boolean; diff --git a/sdks/node/model/signatureRequestResponseDataValueSignature.ts b/sdks/node/model/signatureRequestResponseDataValueSignature.ts index dae941876..b1de4d6e0 100644 --- a/sdks/node/model/signatureRequestResponseDataValueSignature.ts +++ b/sdks/node/model/signatureRequestResponseDataValueSignature.ts @@ -27,15 +27,15 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData export class SignatureRequestResponseDataValueSignature extends SignatureRequestResponseDataBase { /** - * A signature input field + * _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE */ "type"?: string = "signature"; /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE */ "value"?: string; /** - * This field contains the boolean true if the field is signed. + * _t__SignatureRequestResponseDataValue::IS_SIGNED */ "isSigned"?: boolean | null; diff --git a/sdks/node/model/signatureRequestResponseDataValueText.ts b/sdks/node/model/signatureRequestResponseDataValueText.ts index 9d5f4ad8d..6e90b7f5b 100644 --- a/sdks/node/model/signatureRequestResponseDataValueText.ts +++ b/sdks/node/model/signatureRequestResponseDataValueText.ts @@ -27,11 +27,11 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData export class SignatureRequestResponseDataValueText extends SignatureRequestResponseDataBase { /** - * A text input field + * _t__SignatureRequestResponseDataValue::TEXT_TYPE */ "type"?: string = "text"; /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE */ "value"?: string; diff --git a/sdks/node/model/signatureRequestResponseDataValueTextMerge.ts b/sdks/node/model/signatureRequestResponseDataValueTextMerge.ts index 45ac660c6..088d056ef 100644 --- a/sdks/node/model/signatureRequestResponseDataValueTextMerge.ts +++ b/sdks/node/model/signatureRequestResponseDataValueTextMerge.ts @@ -27,11 +27,11 @@ import { SignatureRequestResponseDataBase } from "./signatureRequestResponseData export class SignatureRequestResponseDataValueTextMerge extends SignatureRequestResponseDataBase { /** - * A text field that has default text set by the api + * _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE */ "type"?: string = "text-merge"; /** - * The value of the form field. + * _t__SignatureRequestResponseDataValue::VALUE */ "value"?: string; diff --git a/sdks/node/model/signatureRequestResponseSignatures.ts b/sdks/node/model/signatureRequestResponseSignatures.ts index 1311ebea1..e8a4cfe7d 100644 --- a/sdks/node/model/signatureRequestResponseSignatures.ts +++ b/sdks/node/model/signatureRequestResponseSignatures.ts @@ -25,83 +25,83 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * An array of signature objects, 1 for each signer. + * _t__SignatureRequestResponseSignatures::DESCRIPTION */ export class SignatureRequestResponseSignatures { /** - * Signature identifier. + * _t__SignatureRequestResponseSignatures::SIGNATURE_ID */ "signatureId"?: string; /** - * Signer Group GUID + * _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID */ "signerGroupGuid"?: string | null; /** - * The email address of the signer. + * _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS */ "signerEmailAddress"?: string; /** - * The name of the signer. + * _t__SignatureRequestResponseSignatures::SIGNER_NAME */ "signerName"?: string | null; /** - * The role of the signer. + * _t__SignatureRequestResponseSignatures::SIGNER_ROLE */ "signerRole"?: string | null; /** - * If signer order is assigned this is the 0-based index for this signer. + * _t__SignatureRequestResponseSignatures::ORDER */ "order"?: number | null; /** - * The current status of the signature. eg: awaiting_signature, signed, declined. + * _t__SignatureRequestResponseSignatures::STATUS_CODE */ "statusCode"?: string; /** - * The reason provided by the signer for declining the request. + * _t__SignatureRequestResponseSignatures::DECLINE_REASON */ "declineReason"?: string | null; /** - * Time that the document was signed or null. + * _t__SignatureRequestResponseSignatures::SIGNED_AT */ "signedAt"?: number | null; /** - * The time that the document was last viewed by this signer or null. + * _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT */ "lastViewedAt"?: number | null; /** - * The time the last reminder email was sent to the signer or null. + * _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT */ "lastRemindedAt"?: number | null; /** - * Boolean to indicate whether this signature requires a PIN to access. + * _t__SignatureRequestResponseSignatures::HAS_PIN */ "hasPin"?: boolean; /** - * Boolean to indicate whether this signature has SMS authentication enabled. + * _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH */ "hasSmsAuth"?: boolean | null; /** - * Boolean to indicate whether this signature has SMS delivery enabled. + * _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY */ "hasSmsDelivery"?: boolean | null; /** - * The SMS phone number used for authentication or signature request delivery. + * _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER */ "smsPhoneNumber"?: string | null; /** - * Email address of original signer who reassigned to this signer. + * _t__SignatureRequestResponseSignatures::REASSIGNED_BY */ "reassignedBy"?: string | null; /** - * Reason provided by original signer who reassigned to this signer. + * _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON */ "reassignmentReason"?: string | null; /** - * Previous signature identifier. + * _t__SignatureRequestResponseSignatures::REASSIGNED_FROM */ "reassignedFrom"?: string | null; /** - * Error message pertaining to this signer, or null. + * _t__SignatureRequestResponseSignatures::ERROR */ "error"?: string | null; diff --git a/sdks/node/model/signatureRequestSendRequest.ts b/sdks/node/model/signatureRequestSendRequest.ts index 75720c17b..0aa4b927f 100644 --- a/sdks/node/model/signatureRequestSendRequest.ts +++ b/sdks/node/model/signatureRequestSendRequest.ts @@ -43,11 +43,11 @@ export class SignatureRequestSendRequest { */ "fileUrls"?: Array; /** - * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestSigner::DESCRIPTION */ "signers"?: Array; /** - * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION */ "groupedSigners"?: Array; /** @@ -59,7 +59,11 @@ export class SignatureRequestSendRequest { */ "allowReassign"?: boolean = false; /** - * A list describing the attachments + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; + /** + * _t__SubAttachment::LIST_DESCRIPTION */ "attachments"?: Array; /** @@ -106,7 +110,7 @@ export class SignatureRequestSendRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; "signingOptions"?: SubSigningOptions; @@ -168,6 +172,11 @@ export class SignatureRequestSendRequest { baseName: "allow_reassign", type: "boolean", }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean", + }, { name: "attachments", baseName: "attachments", diff --git a/sdks/node/model/signatureRequestSendWithTemplateRequest.ts b/sdks/node/model/signatureRequestSendWithTemplateRequest.ts index 12232a129..dfb7d6bfa 100644 --- a/sdks/node/model/signatureRequestSendWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestSendWithTemplateRequest.ts @@ -37,7 +37,7 @@ export class SignatureRequestSendWithTemplateRequest { */ "templateIds": Array; /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION */ "signers": Array; /** @@ -79,7 +79,7 @@ export class SignatureRequestSendWithTemplateRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; "signingOptions"?: SubSigningOptions; diff --git a/sdks/node/model/subFormFieldsPerDocumentBase.ts b/sdks/node/model/subFormFieldsPerDocumentBase.ts index 098c5730f..a2f65a2c6 100644 --- a/sdks/node/model/subFormFieldsPerDocumentBase.ts +++ b/sdks/node/model/subFormFieldsPerDocumentBase.ts @@ -50,15 +50,15 @@ export abstract class SubFormFieldsPerDocumentBase { "signer": number | string; "type": string; /** - * Size of the field in pixels. + * _t__Sub::FormFieldsPerDocument::WIDTH */ "width": number; /** - * Location coordinates of the field in pixels. + * _t__Sub::FormFieldsPerDocument::X */ "x": number; /** - * Location coordinates of the field in pixels. + * _t__Sub::FormFieldsPerDocument::Y */ "y": number; /** diff --git a/sdks/node/model/subFormFieldsPerDocumentText.ts b/sdks/node/model/subFormFieldsPerDocumentText.ts index 6f05f4ceb..2ea35f55c 100644 --- a/sdks/node/model/subFormFieldsPerDocumentText.ts +++ b/sdks/node/model/subFormFieldsPerDocumentText.ts @@ -50,7 +50,7 @@ export class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase { */ "masked"?: boolean; /** - * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + * _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE */ "validationType"?: SubFormFieldsPerDocumentText.ValidationTypeEnum; "validationCustomRegex"?: string; diff --git a/sdks/node/model/subFormFieldsPerDocumentTextMerge.ts b/sdks/node/model/subFormFieldsPerDocumentTextMerge.ts index f8b658a0a..4a5feef81 100644 --- a/sdks/node/model/subFormFieldsPerDocumentTextMerge.ts +++ b/sdks/node/model/subFormFieldsPerDocumentTextMerge.ts @@ -30,7 +30,7 @@ import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; */ export class SubFormFieldsPerDocumentTextMerge extends SubFormFieldsPerDocumentBase { /** - * A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. + * _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE */ "type": string = "text-merge"; /** diff --git a/sdks/node/model/subMergeField.ts b/sdks/node/model/subMergeField.ts index f728475c2..80e537700 100644 --- a/sdks/node/model/subMergeField.ts +++ b/sdks/node/model/subMergeField.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class SubMergeField { /** - * The name of the merge field. Must be unique. + * _t__Sub::MergeField::NAME */ "name": string; /** - * The type of merge field. + * _t__Sub::MergeField::TYPE */ "type": SubMergeField.TypeEnum; diff --git a/sdks/node/model/subOAuth.ts b/sdks/node/model/subOAuth.ts index ab3979846..00ab883bd 100644 --- a/sdks/node/model/subOAuth.ts +++ b/sdks/node/model/subOAuth.ts @@ -25,15 +25,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * OAuth related parameters. + * _t__Sub::OAuth::DESCRIPTION */ export class SubOAuth { /** - * The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) + * _t__Sub::OAuth::CALLBACK_URL */ "callbackUrl"?: string; /** - * A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). + * _t__Sub::OAuth::SCOPES */ "scopes"?: Array; diff --git a/sdks/node/model/subOptions.ts b/sdks/node/model/subOptions.ts index 844e4ff23..1d3f07dde 100644 --- a/sdks/node/model/subOptions.ts +++ b/sdks/node/model/subOptions.ts @@ -25,11 +25,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Additional options supported by API App. + * _t__Sub::Options::DESCRIPTION */ export class SubOptions { /** - * Determines if signers can use \"Insert Everywhere\" when signing a document. + * _t__Sub::Options::CAN_INSERT_EVERYWHERE */ "canInsertEverywhere"?: boolean = false; diff --git a/sdks/node/model/subSignatureRequestGroupedSigners.ts b/sdks/node/model/subSignatureRequestGroupedSigners.ts index 9417509e4..b0835d07e 100644 --- a/sdks/node/model/subSignatureRequestGroupedSigners.ts +++ b/sdks/node/model/subSignatureRequestGroupedSigners.ts @@ -27,15 +27,15 @@ import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; export class SubSignatureRequestGroupedSigners { /** - * The name of the group. + * _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME */ "group": string; /** - * 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. + * _t__Sub::SignatureRequestGroupedSigners::SIGNERS */ "signers": Array; /** - * The order the group is required to sign in. Use this instead of Signer-level `order`. + * _t__Sub::SignatureRequestGroupedSigners::ORDER */ "order"?: number | null; diff --git a/sdks/node/model/subSignatureRequestSigner.ts b/sdks/node/model/subSignatureRequestSigner.ts index 6eb403434..8bec09da5 100644 --- a/sdks/node/model/subSignatureRequestSigner.ts +++ b/sdks/node/model/subSignatureRequestSigner.ts @@ -26,27 +26,27 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class SubSignatureRequestSigner { /** - * The name of the signer. + * _t__Sub::SignatureRequestSigner::SIGNER_NAME */ "name": string; /** - * The email address of the signer. + * _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS */ "emailAddress": string; /** - * The order the signer is required to sign in. + * _t__Sub::SignatureRequestSigner::SIGNER_ORDER */ "order"?: number | null; /** - * The 4- to 12-character access code that will secure this signer\'s signature page. + * _t__Sub::SignatureRequestSigner::SIGNER_PIN */ "pin"?: string; /** - * An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer\'s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + * _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER */ "smsPhoneNumber"?: string; /** - * Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + * _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE */ "smsPhoneNumberType"?: SubSignatureRequestSigner.SmsPhoneNumberTypeEnum; diff --git a/sdks/node/model/subSignatureRequestTemplateSigner.ts b/sdks/node/model/subSignatureRequestTemplateSigner.ts index 7722e724e..66cfdd161 100644 --- a/sdks/node/model/subSignatureRequestTemplateSigner.ts +++ b/sdks/node/model/subSignatureRequestTemplateSigner.ts @@ -26,27 +26,27 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class SubSignatureRequestTemplateSigner { /** - * Must match an existing role in chosen Template(s). It\'s case-sensitive. + * _t__Sub::SignatureRequestTemplateSigner::ROLE */ "role": string; /** - * The name of the signer. + * _t__Sub::SignatureRequestTemplateSigner::NAME */ "name": string; /** - * The email address of the signer. + * _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS */ "emailAddress": string; /** - * The 4- to 12-character access code that will secure this signer\'s signature page. + * _t__Sub::SignatureRequestTemplateSigner::PIN */ "pin"?: string; /** - * An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer\'s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + * _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER */ "smsPhoneNumber"?: string; /** - * Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + * _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE */ "smsPhoneNumberType"?: SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum; diff --git a/sdks/node/model/subSigningOptions.ts b/sdks/node/model/subSigningOptions.ts index 886d611c7..cdde26857 100644 --- a/sdks/node/model/subSigningOptions.ts +++ b/sdks/node/model/subSigningOptions.ts @@ -25,27 +25,27 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + * _t__Sub::SigningOptions::DESCRIPTION */ export class SubSigningOptions { /** - * The default type shown (limited to the listed types) + * _t__Sub::SigningOptions::DEFAULT */ "defaultType": SubSigningOptions.DefaultTypeEnum; /** - * Allows drawing the signature + * _t__Sub::SigningOptions::DRAW */ "draw"?: boolean = false; /** - * Allows using a smartphone to email the signature + * _t__Sub::SigningOptions::PHONE */ "phone"?: boolean = false; /** - * Allows typing the signature + * _t__Sub::SigningOptions::TYPE */ "type"?: boolean = false; /** - * Allows uploading the signature + * _t__Sub::SigningOptions::UPLOAD */ "upload"?: boolean = false; diff --git a/sdks/node/model/subTeamResponse.ts b/sdks/node/model/subTeamResponse.ts index 22111b62e..2dd2be2f9 100644 --- a/sdks/node/model/subTeamResponse.ts +++ b/sdks/node/model/subTeamResponse.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class SubTeamResponse { /** - * The id of a team + * _t__TeamGeneral::TEAM_ID */ "teamId"?: string; /** - * The name of a team + * _t__TeamGeneral::NAME */ "name"?: string; diff --git a/sdks/node/model/subTemplateRole.ts b/sdks/node/model/subTemplateRole.ts index 249f3628d..a7664f961 100644 --- a/sdks/node/model/subTemplateRole.ts +++ b/sdks/node/model/subTemplateRole.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class SubTemplateRole { /** - * The role name of the signer that will be displayed when the template is used to create a signature request. + * _t__Sub::SignerRole::NAME */ "name"?: string; /** - * The order in which this signer role is required to sign. + * _t__Sub::SignerRole::ORDER */ "order"?: number | null; diff --git a/sdks/node/model/subUnclaimedDraftSigner.ts b/sdks/node/model/subUnclaimedDraftSigner.ts index 6207006bf..eaaa5a7b5 100644 --- a/sdks/node/model/subUnclaimedDraftSigner.ts +++ b/sdks/node/model/subUnclaimedDraftSigner.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class SubUnclaimedDraftSigner { /** - * The email address of the signer. + * _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS */ "emailAddress": string; /** - * The name of the signer. + * _t__Sub::UnclaimedDraftSigner::NAME */ "name": string; /** - * The order the signer is required to sign in. + * _t__Sub::UnclaimedDraftSigner::ORDER */ "order"?: number | null; diff --git a/sdks/node/model/subUnclaimedDraftTemplateSigner.ts b/sdks/node/model/subUnclaimedDraftTemplateSigner.ts index dd341e84a..202cf7c57 100644 --- a/sdks/node/model/subUnclaimedDraftTemplateSigner.ts +++ b/sdks/node/model/subUnclaimedDraftTemplateSigner.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class SubUnclaimedDraftTemplateSigner { /** - * Must match an existing role in chosen Template(s). + * _t__Sub::UnclaimedDraftTemplateSigner::ROLE */ "role": string; /** - * The name of the signer filling the role of `role`. + * _t__Sub::UnclaimedDraftTemplateSigner::NAME */ "name": string; /** - * The email address of the signer filling the role of `role`. + * _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS */ "emailAddress": string; diff --git a/sdks/node/model/subWhiteLabelingOptions.ts b/sdks/node/model/subWhiteLabelingOptions.ts index 0c1c50286..2ec927104 100644 --- a/sdks/node/model/subWhiteLabelingOptions.ts +++ b/sdks/node/model/subWhiteLabelingOptions.ts @@ -25,7 +25,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * An array of elements and values serialized to a string, to be used to customize the app\'s signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. + * _t__Sub::WhiteLabelingOptions::DESCRIPTION */ export class SubWhiteLabelingOptions { "headerBackgroundColor"?: string = "#1a1a1a"; @@ -44,7 +44,7 @@ export class SubWhiteLabelingOptions { "textColor1"?: string = "#808080"; "textColor2"?: string = "#ffffff"; /** - * Resets white labeling options to defaults. Only useful when updating an API App. + * _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT */ "resetToDefault"?: boolean; diff --git a/sdks/node/model/teamGetInfoResponse.ts b/sdks/node/model/teamGetInfoResponse.ts index 48159ef24..f1590e171 100644 --- a/sdks/node/model/teamGetInfoResponse.ts +++ b/sdks/node/model/teamGetInfoResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class TeamGetInfoResponse { "team": TeamInfoResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/teamGetResponse.ts b/sdks/node/model/teamGetResponse.ts index 01aaca14b..512a02791 100644 --- a/sdks/node/model/teamGetResponse.ts +++ b/sdks/node/model/teamGetResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class TeamGetResponse { "team": TeamResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/teamInfoResponse.ts b/sdks/node/model/teamInfoResponse.ts index 40ae3cd2c..147a4caf8 100644 --- a/sdks/node/model/teamInfoResponse.ts +++ b/sdks/node/model/teamInfoResponse.ts @@ -27,20 +27,20 @@ import { TeamParentResponse } from "./teamParentResponse"; export class TeamInfoResponse { /** - * The id of a team + * _t__TeamGeneral::TEAM_ID */ "teamId"?: string; "teamParent"?: TeamParentResponse | null; /** - * The name of a team + * _t__TeamGeneral::NAME */ "name"?: string; /** - * Number of members within a team + * _t__TeamGeneral::NUM_MEMBERS */ "numMembers"?: number; /** - * Number of sub teams within a team + * _t__TeamGeneral::NUM_SUB_TEAMS */ "numSubTeams"?: number; diff --git a/sdks/node/model/teamParentResponse.ts b/sdks/node/model/teamParentResponse.ts index b5b67f4e7..a994e8134 100644 --- a/sdks/node/model/teamParentResponse.ts +++ b/sdks/node/model/teamParentResponse.ts @@ -29,11 +29,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; */ export class TeamParentResponse { /** - * The id of a team + * _t__TeamGeneral::TEAM_ID */ "teamId"?: string; /** - * The name of a team + * _t__TeamGeneral::NAME */ "name"?: string; diff --git a/sdks/node/model/teamResponse.ts b/sdks/node/model/teamResponse.ts index 4d0a233d0..8e28db76b 100644 --- a/sdks/node/model/teamResponse.ts +++ b/sdks/node/model/teamResponse.ts @@ -26,20 +26,20 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { AccountResponse } from "./accountResponse"; /** - * Contains information about your team and its members + * _t__TeamResponse::DESCRIPTION */ export class TeamResponse { /** - * The name of your Team + * _t__Team::NAME */ "name"?: string; "accounts"?: Array; /** - * 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`. + * _t__Team::INVITED_ACCOUNTS */ "invitedAccounts"?: Array; /** - * A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. + * _t__Team::INVITED_EMAILS */ "invitedEmails"?: Array; diff --git a/sdks/node/model/templateCreateEmbeddedDraftRequest.ts b/sdks/node/model/templateCreateEmbeddedDraftRequest.ts index 657fa7c86..79c0b279b 100644 --- a/sdks/node/model/templateCreateEmbeddedDraftRequest.ts +++ b/sdks/node/model/templateCreateEmbeddedDraftRequest.ts @@ -54,7 +54,11 @@ export class TemplateCreateEmbeddedDraftRequest { */ "allowReassign"?: boolean = false; /** - * A list describing the attachments + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; + /** + * _t__SubAttachment::LIST_DESCRIPTION */ "attachments"?: Array; /** @@ -92,7 +96,7 @@ export class TemplateCreateEmbeddedDraftRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; /** @@ -156,6 +160,11 @@ export class TemplateCreateEmbeddedDraftRequest { baseName: "allow_reassign", type: "boolean", }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean", + }, { name: "attachments", baseName: "attachments", diff --git a/sdks/node/model/templateCreateEmbeddedDraftResponse.ts b/sdks/node/model/templateCreateEmbeddedDraftResponse.ts index 7d2a40559..6bf0fe171 100644 --- a/sdks/node/model/templateCreateEmbeddedDraftResponse.ts +++ b/sdks/node/model/templateCreateEmbeddedDraftResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class TemplateCreateEmbeddedDraftResponse { "template": TemplateCreateEmbeddedDraftResponseTemplate; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts b/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts index d74b06aed..948a25cac 100644 --- a/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts +++ b/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts @@ -26,23 +26,23 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { WarningResponse } from "./warningResponse"; /** - * Template object with parameters: `template_id`, `edit_url`, `expires_at`. + * _t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION */ export class TemplateCreateEmbeddedDraftResponseTemplate { /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID */ "templateId"?: string; /** - * Link to edit the template. + * _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL */ "editUrl"?: string; /** - * When the link expires. + * _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT */ "expiresAt"?: number; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @deprecated */ diff --git a/sdks/node/model/templateCreateRequest.ts b/sdks/node/model/templateCreateRequest.ts index 66701c09e..8d4a4bb40 100644 --- a/sdks/node/model/templateCreateRequest.ts +++ b/sdks/node/model/templateCreateRequest.ts @@ -53,7 +53,11 @@ export class TemplateCreateRequest { */ "allowReassign"?: boolean = false; /** - * A list describing the attachments + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; + /** + * _t__SubAttachment::LIST_DESCRIPTION */ "attachments"?: Array; /** @@ -82,7 +86,7 @@ export class TemplateCreateRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; /** @@ -130,6 +134,11 @@ export class TemplateCreateRequest { baseName: "allow_reassign", type: "boolean", }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean", + }, { name: "attachments", baseName: "attachments", diff --git a/sdks/node/model/templateCreateResponse.ts b/sdks/node/model/templateCreateResponse.ts index fdf2e1e40..8f573cee0 100644 --- a/sdks/node/model/templateCreateResponse.ts +++ b/sdks/node/model/templateCreateResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class TemplateCreateResponse { "template": TemplateCreateResponseTemplate; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/templateCreateResponseTemplate.ts b/sdks/node/model/templateCreateResponseTemplate.ts index cdcd61167..6cdab8e58 100644 --- a/sdks/node/model/templateCreateResponseTemplate.ts +++ b/sdks/node/model/templateCreateResponseTemplate.ts @@ -25,11 +25,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Template object with parameters: `template_id`. + * _t__TemplateCreateResponseTemplate::DESCRIPTION */ export class TemplateCreateResponseTemplate { /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID */ "templateId"?: string; diff --git a/sdks/node/model/templateEditResponse.ts b/sdks/node/model/templateEditResponse.ts index aa51f43d0..2d1802cef 100644 --- a/sdks/node/model/templateEditResponse.ts +++ b/sdks/node/model/templateEditResponse.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class TemplateEditResponse { /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID */ "templateId": string; diff --git a/sdks/node/model/templateGetResponse.ts b/sdks/node/model/templateGetResponse.ts index a00f271e3..4a90e929d 100644 --- a/sdks/node/model/templateGetResponse.ts +++ b/sdks/node/model/templateGetResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class TemplateGetResponse { "template": TemplateResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/templateListResponse.ts b/sdks/node/model/templateListResponse.ts index 0a797e6c1..2cdaf4d5e 100644 --- a/sdks/node/model/templateListResponse.ts +++ b/sdks/node/model/templateListResponse.ts @@ -29,12 +29,12 @@ import { WarningResponse } from "./warningResponse"; export class TemplateListResponse { /** - * List of templates that the API caller has access to. + * _t__TemplateListResponse::DESCRIPTION */ "templates": Array; "listInfo": ListInfoResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/templateResponse.ts b/sdks/node/model/templateResponse.ts index 298db4670..21b000c97 100644 --- a/sdks/node/model/templateResponse.ts +++ b/sdks/node/model/templateResponse.ts @@ -32,75 +32,75 @@ import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumen import { TemplateResponseSignerRole } from "./templateResponseSignerRole"; /** - * Contains information about the templates you and your team have created. + * _t__TemplateResponse::DESCRIPTION */ export class TemplateResponse { /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID */ "templateId"?: string; /** - * The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * _t__TemplateResponse::TITLE */ "title"?: string; /** - * The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * _t__TemplateResponse::MESSAGE */ "message"?: string; /** - * Time the template was last updated. + * _t__TemplateResponse::UPDATED_AT */ "updatedAt"?: number; /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + * _t__TemplateResponse::IS_EMBEDDED */ "isEmbedded"?: boolean | null; /** - * `true` if you are the owner of this template, `false` if it\'s been shared with you by a team member. + * _t__TemplateResponse::IS_CREATOR */ "isCreator"?: boolean; /** - * Indicates whether edit rights have been granted to you by the owner (always `true` if that\'s you). + * _t__TemplateResponse::CAN_EDIT */ "canEdit"?: boolean; /** - * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + * _t__TemplateResponse::IS_LOCKED */ "isLocked"?: boolean; /** - * The metadata attached to the template. + * _t__TemplateResponse::METADATA */ "metadata"?: { [key: string]: any }; /** - * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + * _t__TemplateResponse::SIGNER_ROLES */ "signerRoles"?: Array; /** - * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + * _t__TemplateResponse::CC_ROLES */ "ccRoles"?: Array; /** - * An array describing each document associated with this Template. Includes form field data for each document. + * _t__TemplateResponse::DOCUMENTS */ "documents"?: Array; /** - * Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * _t__TemplateResponseCustomField::DESCRIPTION * * @deprecated */ "customFields"?: Array | null; /** - * Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * _t__TemplateResponseNamedFormField::DESCRIPTION * * @deprecated */ "namedFormFields"?: Array | null; /** - * An array of the Accounts that can use this Template. + * _t__TemplateResponse::ACCOUNTS */ "accounts"?: Array; /** - * Signer attachments. + * _t__SignatureRequestResponseAttachment::DESCRIPTION */ "attachments"?: Array; diff --git a/sdks/node/model/templateResponseAccount.ts b/sdks/node/model/templateResponseAccount.ts index 3b43d9351..bfe6bccf8 100644 --- a/sdks/node/model/templateResponseAccount.ts +++ b/sdks/node/model/templateResponseAccount.ts @@ -27,23 +27,23 @@ import { TemplateResponseAccountQuota } from "./templateResponseAccountQuota"; export class TemplateResponseAccount { /** - * The id of the Account. + * _t__TemplateResponseAccount::ACCOUNT_ID */ "accountId"?: string; /** - * The email address associated with the Account. + * _t__TemplateResponseAccount::EMAIL_ADDRESS */ "emailAddress"?: string; /** - * Returns `true` if the user has been locked out of their account by a team admin. + * _t__TemplateResponseAccount::IS_LOCKED */ "isLocked"?: boolean; /** - * Returns `true` if the user has a paid Dropbox Sign account. + * _t__TemplateResponseAccount::IS_PAID_HS */ "isPaidHs"?: boolean; /** - * Returns `true` if the user has a paid HelloFax account. + * _t__TemplateResponseAccount::IS_PAID_HF */ "isPaidHf"?: boolean; "quotas"?: TemplateResponseAccountQuota; diff --git a/sdks/node/model/templateResponseAccountQuota.ts b/sdks/node/model/templateResponseAccountQuota.ts index e2d6669b6..a8178f6fc 100644 --- a/sdks/node/model/templateResponseAccountQuota.ts +++ b/sdks/node/model/templateResponseAccountQuota.ts @@ -25,23 +25,23 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + * _t__TemplateResponseAccountQuota::DESCRIPTION */ export class TemplateResponseAccountQuota { /** - * API templates remaining. + * _t__TemplateResponseAccountQuota::TEMPLATES_LEFT */ "templatesLeft"?: number; /** - * API signature requests remaining. + * _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT */ "apiSignatureRequestsLeft"?: number; /** - * Signature requests remaining. + * _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT */ "documentsLeft"?: number; /** - * SMS verifications remaining. + * _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT */ "smsVerificationsLeft"?: number; diff --git a/sdks/node/model/templateResponseCCRole.ts b/sdks/node/model/templateResponseCCRole.ts index b3b7a2fd7..1751fd629 100644 --- a/sdks/node/model/templateResponseCCRole.ts +++ b/sdks/node/model/templateResponseCCRole.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class TemplateResponseCCRole { /** - * The name of the Role. + * _t__TemplateResponseCCRole::NAME */ "name"?: string; diff --git a/sdks/node/model/templateResponseDocument.ts b/sdks/node/model/templateResponseDocument.ts index 681736701..2b9b2890c 100644 --- a/sdks/node/model/templateResponseDocument.ts +++ b/sdks/node/model/templateResponseDocument.ts @@ -30,27 +30,27 @@ import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocum export class TemplateResponseDocument { /** - * Name of the associated file. + * _t__TemplateResponseDocument::NAME */ "name"?: string; /** - * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + * _t__TemplateResponseDocument::INDEX */ "index"?: number; /** - * An array of Form Field Group objects. + * _t__TemplateResponseDocument::FIELD_GROUPS */ "fieldGroups"?: Array; /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentFormField::DESCRIPTION */ "formFields"?: Array; /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentCustomField::DESCRIPTION */ "customFields"?: Array; /** - * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * _t__TemplateResponseDocumentStaticField::DESCRIPTION */ "staticFields"?: Array; diff --git a/sdks/node/model/templateResponseDocumentCustomFieldBase.ts b/sdks/node/model/templateResponseDocumentCustomFieldBase.ts index a0ed43965..9110955e8 100644 --- a/sdks/node/model/templateResponseDocumentCustomFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentCustomFieldBase.ts @@ -25,44 +25,44 @@ import { AttributeTypeMap } from "./"; /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentCustomField::DESCRIPTION */ export abstract class TemplateResponseDocumentCustomFieldBase { "type": string; /** - * The unique ID for this field. + * _t__TemplateResponseDocumentCustomField::API_ID */ "apiId"?: string; /** - * The name of the Custom Field. + * _t__TemplateResponseDocumentCustomField::NAME */ "name"?: string; /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * _t__TemplateResponseDocumentCustomField::SIGNER */ "signer"?: number | string | null; /** - * The horizontal offset in pixels for this form field. + * _t__TemplateResponseDocumentCustomField::X */ "x"?: number; /** - * The vertical offset in pixels for this form field. + * _t__TemplateResponseDocumentCustomField::Y */ "y"?: number; /** - * The width in pixels of this form field. + * _t__TemplateResponseDocumentCustomField::WIDTH */ "width"?: number; /** - * The height in pixels of this form field. + * _t__TemplateResponseDocumentCustomField::HEIGHT */ "height"?: number; /** - * Boolean showing whether or not this field is required. + * _t__TemplateResponseDocumentStaticField::REQUIRED */ "required"?: boolean; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null`. + * _t__TemplateResponseDocumentCustomField::GROUP */ "group"?: string | null; diff --git a/sdks/node/model/templateResponseDocumentCustomFieldCheckbox.ts b/sdks/node/model/templateResponseDocumentCustomFieldCheckbox.ts index f499b69fc..2f7a73a80 100644 --- a/sdks/node/model/templateResponseDocumentCustomFieldCheckbox.ts +++ b/sdks/node/model/templateResponseDocumentCustomFieldCheckbox.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocumentCustomFieldBase"; /** - * This class extends `TemplateResponseDocumentCustomFieldBase` + * _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentCustomFieldCheckbox extends TemplateResponseDocumentCustomFieldBase { /** - * The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + * _t__TemplateResponseDocumentCustomField::TYPE */ "type": string = "checkbox"; diff --git a/sdks/node/model/templateResponseDocumentCustomFieldText.ts b/sdks/node/model/templateResponseDocumentCustomFieldText.ts index 3f59efc19..4319d9b73 100644 --- a/sdks/node/model/templateResponseDocumentCustomFieldText.ts +++ b/sdks/node/model/templateResponseDocumentCustomFieldText.ts @@ -27,24 +27,24 @@ import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocum import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; /** - * This class extends `TemplateResponseDocumentCustomFieldBase` + * _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCustomFieldBase { /** - * The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + * _t__TemplateResponseDocumentCustomField::TYPE */ "type": string = "text"; "avgTextLength"?: TemplateResponseFieldAvgTextLength; /** - * Whether this form field is multiline text. + * _t__TemplateResponseDocumentCustomField::IS_MULTILINE */ "isMultiline"?: boolean; /** - * Original font size used in this form field\'s text. + * _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE */ "originalFontSize"?: number; /** - * Font family used in this form field\'s text. + * _t__TemplateResponseDocumentCustomField::FONT_FAMILY */ "fontFamily"?: string; diff --git a/sdks/node/model/templateResponseDocumentFieldGroup.ts b/sdks/node/model/templateResponseDocumentFieldGroup.ts index 4d2f9c695..38727b129 100644 --- a/sdks/node/model/templateResponseDocumentFieldGroup.ts +++ b/sdks/node/model/templateResponseDocumentFieldGroup.ts @@ -27,7 +27,7 @@ import { TemplateResponseDocumentFieldGroupRule } from "./templateResponseDocume export class TemplateResponseDocumentFieldGroup { /** - * The name of the form field group. + * _t__TemplateResponseDocumentFieldGroup::NAME */ "name"?: string; "rule"?: TemplateResponseDocumentFieldGroupRule; diff --git a/sdks/node/model/templateResponseDocumentFieldGroupRule.ts b/sdks/node/model/templateResponseDocumentFieldGroupRule.ts index f5ad93cf4..9230c6591 100644 --- a/sdks/node/model/templateResponseDocumentFieldGroupRule.ts +++ b/sdks/node/model/templateResponseDocumentFieldGroupRule.ts @@ -25,15 +25,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). + * _t__TemplateResponseDocumentFieldGroup::RULE */ export class TemplateResponseDocumentFieldGroupRule { /** - * 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. + * _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT */ "requirement"?: string; /** - * Name of the group + * _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL */ "groupLabel"?: string; diff --git a/sdks/node/model/templateResponseDocumentFormFieldBase.ts b/sdks/node/model/templateResponseDocumentFormFieldBase.ts index e28159b30..86497ee8e 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldBase.ts @@ -25,40 +25,40 @@ import { AttributeTypeMap } from "./"; /** - * An array of Form Field objects containing the name and type of each named field. + * _t__TemplateResponseDocumentFormField::DESCRIPTION */ export abstract class TemplateResponseDocumentFormFieldBase { "type": string; /** - * A unique id for the form field. + * _t__TemplateResponseDocumentFormField::API_ID */ "apiId"?: string; /** - * The name of the form field. + * _t__TemplateResponseDocumentFormField::NAME */ "name"?: string; /** - * The signer of the Form Field. + * _t__TemplateResponseDocumentFormField::SIGNER */ "signer"?: number | string; /** - * The horizontal offset in pixels for this form field. + * _t__TemplateResponseDocumentFormField::X */ "x"?: number; /** - * The vertical offset in pixels for this form field. + * _t__TemplateResponseDocumentFormField::Y */ "y"?: number; /** - * The width in pixels of this form field. + * _t__TemplateResponseDocumentFormField::WIDTH */ "width"?: number; /** - * The height in pixels of this form field. + * _t__TemplateResponseDocumentFormField::HEIGHT */ "height"?: number; /** - * Boolean showing whether or not this field is required. + * _t__TemplateResponseDocumentFormField::REQUIRED */ "required"?: boolean; diff --git a/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts b/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts index e27a9fd0a..59ffd9eb7 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocumentFormFieldBase { /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ "type": string = "checkbox"; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP */ "group"?: string | null; diff --git a/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts b/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts index 08ce11026..8d1d8ddd4 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocumentFormFieldBase { /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ "type": string = "date_signed"; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP */ "group"?: string | null; diff --git a/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts b/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts index 0aeb3e4e0..9cbeedff8 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocumentFormFieldBase { /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ "type": string = "dropdown"; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP */ "group"?: string | null; diff --git a/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts b/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts index a3693ec83..0bf1142db 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts @@ -27,28 +27,28 @@ import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumen import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumentFormFieldBase { /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ "type": string = "hyperlink"; "avgTextLength"?: TemplateResponseFieldAvgTextLength; /** - * Whether this form field is multiline text. + * _t__TemplateResponseDocumentFormField::IS_MULTILINE */ "isMultiline"?: boolean; /** - * Original font size used in this form field\'s text. + * _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE */ "originalFontSize"?: number; /** - * Font family used in this form field\'s text. + * _t__TemplateResponseDocumentFormField::FONT_FAMILY */ "fontFamily"?: string; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP */ "group"?: string | null; diff --git a/sdks/node/model/templateResponseDocumentFormFieldInitials.ts b/sdks/node/model/templateResponseDocumentFormFieldInitials.ts index 02f89a99e..6d957f15a 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldInitials.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldInitials.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocumentFormFieldBase { /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ "type": string = "initials"; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP */ "group"?: string | null; diff --git a/sdks/node/model/templateResponseDocumentFormFieldRadio.ts b/sdks/node/model/templateResponseDocumentFormFieldRadio.ts index 0841c0d5a..fd86be3fb 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldRadio.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldRadio.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFormFieldBase { /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ "type": string = "radio"; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP */ "group": string; diff --git a/sdks/node/model/templateResponseDocumentFormFieldSignature.ts b/sdks/node/model/templateResponseDocumentFormFieldSignature.ts index 8467c9103..74d76f845 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldSignature.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldSignature.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumentFormFieldBase { /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ "type": string = "signature"; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP */ "group"?: string | null; diff --git a/sdks/node/model/templateResponseDocumentFormFieldText.ts b/sdks/node/model/templateResponseDocumentFormFieldText.ts index a10ace959..ebcfad57b 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldText.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldText.ts @@ -27,40 +27,40 @@ import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumen import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; /** - * This class extends `TemplateResponseDocumentFormFieldBase` + * _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentFormFieldBase { /** - * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * _t__TemplateResponseDocumentFormField::TYPE */ "type": string = "text"; "avgTextLength"?: TemplateResponseFieldAvgTextLength; /** - * Whether this form field is multiline text. + * _t__TemplateResponseDocumentFormField::IS_MULTILINE */ "isMultiline"?: boolean; /** - * Original font size used in this form field\'s text. + * _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE */ "originalFontSize"?: number; /** - * Font family used in this form field\'s text. + * _t__TemplateResponseDocumentFormField::FONT_FAMILY */ "fontFamily"?: string; /** - * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + * _t__TemplateResponseDocumentFormField::VALIDATION_TYPE */ "validationType"?: TemplateResponseDocumentFormFieldText.ValidationTypeEnum; /** - * When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. + * _t__TemplateResponseDocumentFormField::CUSTOM_REGEX */ "validationCustomRegex"?: string | null; /** - * When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. + * _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL */ "validationCustomRegexFormatLabel"?: string | null; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * _t__TemplateResponseDocumentFormField::GROUP */ "group"?: string | null; diff --git a/sdks/node/model/templateResponseDocumentStaticFieldBase.ts b/sdks/node/model/templateResponseDocumentStaticFieldBase.ts index 04d3275ef..d4fb8b31b 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldBase.ts @@ -25,44 +25,44 @@ import { AttributeTypeMap } from "./"; /** - * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * _t__TemplateResponseDocumentStaticField::DESCRIPTION */ export abstract class TemplateResponseDocumentStaticFieldBase { "type": string; /** - * A unique id for the static field. + * _t__TemplateResponseDocumentStaticField::API_ID */ "apiId"?: string; /** - * The name of the static field. + * _t__TemplateResponseDocumentStaticField::NAME */ "name"?: string; /** - * The signer of the Static Field. + * _t__TemplateResponseDocumentStaticField::SIGNER */ "signer"?: string = "me_now"; /** - * The horizontal offset in pixels for this static field. + * _t__TemplateResponseDocumentStaticField::X */ "x"?: number; /** - * The vertical offset in pixels for this static field. + * _t__TemplateResponseDocumentStaticField::Y */ "y"?: number; /** - * The width in pixels of this static field. + * _t__TemplateResponseDocumentStaticField::WIDTH */ "width"?: number; /** - * The height in pixels of this static field. + * _t__TemplateResponseDocumentStaticField::HEIGHT */ "height"?: number; /** - * Boolean showing whether or not this field is required. + * _t__TemplateResponseDocumentStaticField::REQUIRED */ "required"?: boolean; /** - * The name of the group this field is in. If this field is not a group, this defaults to `null`. + * _t__TemplateResponseDocumentStaticField::GROUP */ "group"?: string | null; diff --git a/sdks/node/model/templateResponseDocumentStaticFieldCheckbox.ts b/sdks/node/model/templateResponseDocumentStaticFieldCheckbox.ts index 2a6d05dcb..ff86bba5c 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldCheckbox.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldCheckbox.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentStaticFieldCheckbox extends TemplateResponseDocumentStaticFieldBase { /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ "type": string = "checkbox"; diff --git a/sdks/node/model/templateResponseDocumentStaticFieldDateSigned.ts b/sdks/node/model/templateResponseDocumentStaticFieldDateSigned.ts index 4e9a7d785..dee528a58 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldDateSigned.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldDateSigned.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentStaticFieldDateSigned extends TemplateResponseDocumentStaticFieldBase { /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ "type": string = "date_signed"; diff --git a/sdks/node/model/templateResponseDocumentStaticFieldDropdown.ts b/sdks/node/model/templateResponseDocumentStaticFieldDropdown.ts index 228547758..42e489f6a 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldDropdown.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldDropdown.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentStaticFieldDropdown extends TemplateResponseDocumentStaticFieldBase { /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ "type": string = "dropdown"; diff --git a/sdks/node/model/templateResponseDocumentStaticFieldHyperlink.ts b/sdks/node/model/templateResponseDocumentStaticFieldHyperlink.ts index e930e6037..01350c210 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldHyperlink.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldHyperlink.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentStaticFieldHyperlink extends TemplateResponseDocumentStaticFieldBase { /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ "type": string = "hyperlink"; diff --git a/sdks/node/model/templateResponseDocumentStaticFieldInitials.ts b/sdks/node/model/templateResponseDocumentStaticFieldInitials.ts index bd478bdd7..497a968ac 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldInitials.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldInitials.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentStaticFieldInitials extends TemplateResponseDocumentStaticFieldBase { /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ "type": string = "initials"; diff --git a/sdks/node/model/templateResponseDocumentStaticFieldRadio.ts b/sdks/node/model/templateResponseDocumentStaticFieldRadio.ts index b6cfa1af8..9d0f2b388 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldRadio.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldRadio.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentStaticFieldRadio extends TemplateResponseDocumentStaticFieldBase { /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ "type": string = "radio"; diff --git a/sdks/node/model/templateResponseDocumentStaticFieldSignature.ts b/sdks/node/model/templateResponseDocumentStaticFieldSignature.ts index bdf167863..44483faee 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldSignature.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldSignature.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentStaticFieldSignature extends TemplateResponseDocumentStaticFieldBase { /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ "type": string = "signature"; diff --git a/sdks/node/model/templateResponseDocumentStaticFieldText.ts b/sdks/node/model/templateResponseDocumentStaticFieldText.ts index 7a768c4ae..e7d05dd33 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldText.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldText.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; /** - * This class extends `TemplateResponseDocumentStaticFieldBase` + * _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS */ export class TemplateResponseDocumentStaticFieldText extends TemplateResponseDocumentStaticFieldBase { /** - * The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * _t__TemplateResponseDocumentStaticField::TYPE */ "type": string = "text"; diff --git a/sdks/node/model/templateResponseFieldAvgTextLength.ts b/sdks/node/model/templateResponseFieldAvgTextLength.ts index d0a4fc396..de987433b 100644 --- a/sdks/node/model/templateResponseFieldAvgTextLength.ts +++ b/sdks/node/model/templateResponseFieldAvgTextLength.ts @@ -25,15 +25,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * Average text length in this field. + * _t__TemplateResponseFieldAvgTextLength::DESCRIPTION */ export class TemplateResponseFieldAvgTextLength { /** - * Number of lines. + * _t__TemplateResponseFieldAvgTextLength::NUM_LINES */ "numLines"?: number; /** - * Number of characters per line. + * _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE */ "numCharsPerLine"?: number; diff --git a/sdks/node/model/templateResponseSignerRole.ts b/sdks/node/model/templateResponseSignerRole.ts index 9bebd958f..db260e8ec 100644 --- a/sdks/node/model/templateResponseSignerRole.ts +++ b/sdks/node/model/templateResponseSignerRole.ts @@ -26,11 +26,11 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class TemplateResponseSignerRole { /** - * The name of the Role. + * _t__TemplateResponseSignerRole::NAME */ "name"?: string; /** - * If signer order is assigned this is the 0-based index for this role. + * _t__TemplateResponseSignerRole::ORDER */ "order"?: number; diff --git a/sdks/node/model/templateUpdateFilesResponseTemplate.ts b/sdks/node/model/templateUpdateFilesResponseTemplate.ts index 2d32cb3b0..bbd95e935 100644 --- a/sdks/node/model/templateUpdateFilesResponseTemplate.ts +++ b/sdks/node/model/templateUpdateFilesResponseTemplate.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { WarningResponse } from "./warningResponse"; /** - * Contains template id + * _t__TemplateUpdateFilesResponseTemplate::DESCRIPTION */ export class TemplateUpdateFilesResponseTemplate { /** - * The id of the Template. + * _t__TemplateResponse::TEMPLATE_ID */ "templateId"?: string; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION * * @deprecated */ diff --git a/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts b/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts index 950f3c5c1..d5dc78c1a 100644 --- a/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts +++ b/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts @@ -61,12 +61,16 @@ export class UnclaimedDraftCreateEmbeddedRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ "allowDecline"?: boolean = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ "allowReassign"?: boolean = false; /** - * A list describing the attachments + * _t__SubAttachment::LIST_DESCRIPTION */ "attachments"?: Array; /** @@ -116,7 +120,7 @@ export class UnclaimedDraftCreateEmbeddedRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; /** @@ -132,7 +136,7 @@ export class UnclaimedDraftCreateEmbeddedRequest { */ "showProgressStepper"?: boolean = true; /** - * Add Signers to your Unclaimed Draft Signature Request. + * _t__Sub::UnclaimedDraftSigner::DESCRIPTION */ "signers"?: Array; "signingOptions"?: SubSigningOptions; @@ -207,6 +211,11 @@ export class UnclaimedDraftCreateEmbeddedRequest { baseName: "allow_decline", type: "boolean", }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean", + }, { name: "allowReassign", baseName: "allow_reassign", diff --git a/sdks/node/model/unclaimedDraftCreateEmbeddedWithTemplateRequest.ts b/sdks/node/model/unclaimedDraftCreateEmbeddedWithTemplateRequest.ts index d9d70068e..43b3186a7 100644 --- a/sdks/node/model/unclaimedDraftCreateEmbeddedWithTemplateRequest.ts +++ b/sdks/node/model/unclaimedDraftCreateEmbeddedWithTemplateRequest.ts @@ -90,7 +90,7 @@ export class UnclaimedDraftCreateEmbeddedWithTemplateRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; /** @@ -110,7 +110,7 @@ export class UnclaimedDraftCreateEmbeddedWithTemplateRequest { */ "showProgressStepper"?: boolean = true; /** - * Add Signers to your Templated-based Signature Request. + * _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION */ "signers"?: Array; "signingOptions"?: SubSigningOptions; diff --git a/sdks/node/model/unclaimedDraftCreateRequest.ts b/sdks/node/model/unclaimedDraftCreateRequest.ts index cac96a626..b239e340f 100644 --- a/sdks/node/model/unclaimedDraftCreateRequest.ts +++ b/sdks/node/model/unclaimedDraftCreateRequest.ts @@ -53,7 +53,11 @@ export class UnclaimedDraftCreateRequest { */ "allowDecline"?: boolean = false; /** - * A list describing the attachments + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; + /** + * _t__SubAttachment::LIST_DESCRIPTION */ "attachments"?: Array; /** @@ -90,7 +94,7 @@ export class UnclaimedDraftCreateRequest { */ "message"?: string; /** - * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer\'s order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * _t__Sub::Metadata::DESCRIPTION */ "metadata"?: { [key: string]: any }; /** @@ -98,7 +102,7 @@ export class UnclaimedDraftCreateRequest { */ "showProgressStepper"?: boolean = true; /** - * Add Signers to your Unclaimed Draft Signature Request. + * _t__Sub::UnclaimedDraftSigner::DESCRIPTION */ "signers"?: Array; "signingOptions"?: SubSigningOptions; @@ -150,6 +154,11 @@ export class UnclaimedDraftCreateRequest { baseName: "allow_decline", type: "boolean", }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean", + }, { name: "attachments", baseName: "attachments", diff --git a/sdks/node/model/unclaimedDraftCreateResponse.ts b/sdks/node/model/unclaimedDraftCreateResponse.ts index 101aca017..419f1117a 100644 --- a/sdks/node/model/unclaimedDraftCreateResponse.ts +++ b/sdks/node/model/unclaimedDraftCreateResponse.ts @@ -29,7 +29,7 @@ import { WarningResponse } from "./warningResponse"; export class UnclaimedDraftCreateResponse { "unclaimedDraft": UnclaimedDraftResponse; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ "warnings"?: Array; diff --git a/sdks/node/model/unclaimedDraftResponse.ts b/sdks/node/model/unclaimedDraftResponse.ts index 9a635ffc6..4263fcbdb 100644 --- a/sdks/node/model/unclaimedDraftResponse.ts +++ b/sdks/node/model/unclaimedDraftResponse.ts @@ -25,31 +25,31 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * A group of documents that a user can take ownership of via the claim URL. + * _t__UnclaimedDraftResponse::DESCRIPTION */ export class UnclaimedDraftResponse { /** - * The ID of the signature request that is represented by this UnclaimedDraft. + * _t__UnclaimedDraft::SIGNATURE_REQUEST_ID */ "signatureRequestId"?: string | null; /** - * The URL to be used to claim this UnclaimedDraft. + * _t__UnclaimedDraft::CLAIM_URL */ "claimUrl"?: string; /** - * The URL you want signers redirected to after they successfully sign. + * _t__UnclaimedDraft::SIGNING_REDIRECT_URL */ "signingRedirectUrl"?: string | null; /** - * The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). + * _t__UnclaimedDraft::REQUESTING_REDIRECT_URL */ "requestingRedirectUrl"?: string | null; /** - * When the link expires. + * _t__UnclaimedDraft::EXPIRES_AT */ "expiresAt"?: number | null; /** - * Whether this is a test draft. Signature requests made from test drafts have no legal value. + * _t__UnclaimedDraft::TEST_MODE */ "testMode"?: boolean; diff --git a/sdks/node/model/warningResponse.ts b/sdks/node/model/warningResponse.ts index 579a4cbd8..593f8c0a2 100644 --- a/sdks/node/model/warningResponse.ts +++ b/sdks/node/model/warningResponse.ts @@ -25,15 +25,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * A list of warnings. + * _t__WarningResponse::LIST_DESCRIPTION */ export class WarningResponse { /** - * Warning message + * _t__WarningResponse::WARNING_MSG */ "warningMsg": string; /** - * Warning name + * _t__WarningResponse::WARNING_NAME */ "warningName": string; diff --git a/sdks/node/types/model/embeddedEditUrlRequest.d.ts b/sdks/node/types/model/embeddedEditUrlRequest.d.ts index ddab09a6a..5a4614a93 100644 --- a/sdks/node/types/model/embeddedEditUrlRequest.d.ts +++ b/sdks/node/types/model/embeddedEditUrlRequest.d.ts @@ -3,6 +3,7 @@ import { SubEditorOptions } from "./subEditorOptions"; import { SubMergeField } from "./subMergeField"; export declare class EmbeddedEditUrlRequest { "allowEditCcs"?: boolean; + "allowFormView"?: boolean; "ccRoles"?: Array; "editorOptions"?: SubEditorOptions; "forceSignerRoles"?: boolean; diff --git a/sdks/node/types/model/reportCreateRequest.d.ts b/sdks/node/types/model/reportCreateRequest.d.ts index 7ccc67a50..4bdd1f595 100644 --- a/sdks/node/types/model/reportCreateRequest.d.ts +++ b/sdks/node/types/model/reportCreateRequest.d.ts @@ -11,6 +11,7 @@ export declare class ReportCreateRequest { export declare namespace ReportCreateRequest { enum ReportTypeEnum { UserActivity = "user_activity", - DocumentStatus = "document_status" + DocumentStatus = "document_status", + SmsActivity = "sms_activity" } } diff --git a/sdks/node/types/model/reportResponse.d.ts b/sdks/node/types/model/reportResponse.d.ts index 88546b695..1490e79e9 100644 --- a/sdks/node/types/model/reportResponse.d.ts +++ b/sdks/node/types/model/reportResponse.d.ts @@ -12,6 +12,7 @@ export declare class ReportResponse { export declare namespace ReportResponse { enum ReportTypeEnum { UserActivity = "user_activity", - DocumentStatus = "document_status" + DocumentStatus = "document_status", + SmsActivity = "sms_activity" } } diff --git a/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts b/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts index a26931cca..3c3f58e05 100644 --- a/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts +++ b/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts @@ -15,6 +15,7 @@ export declare class SignatureRequestCreateEmbeddedRequest { "signers"?: Array; "groupedSigners"?: Array; "allowDecline"?: boolean; + "allowFormView"?: boolean; "allowReassign"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; diff --git a/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts b/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts index 6c2691435..84d7c3e60 100644 --- a/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts +++ b/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts @@ -15,6 +15,7 @@ export declare class SignatureRequestEditEmbeddedRequest { "signers"?: Array; "groupedSigners"?: Array; "allowDecline"?: boolean; + "allowFormView"?: boolean; "allowReassign"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; diff --git a/sdks/node/types/model/signatureRequestEditRequest.d.ts b/sdks/node/types/model/signatureRequestEditRequest.d.ts index 91a01f76c..d80059a14 100644 --- a/sdks/node/types/model/signatureRequestEditRequest.d.ts +++ b/sdks/node/types/model/signatureRequestEditRequest.d.ts @@ -14,6 +14,7 @@ export declare class SignatureRequestEditRequest { "signers"?: Array; "groupedSigners"?: Array; "allowDecline"?: boolean; + "allowFormView"?: boolean; "allowReassign"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; diff --git a/sdks/node/types/model/signatureRequestSendRequest.d.ts b/sdks/node/types/model/signatureRequestSendRequest.d.ts index cd862694b..0f26f0697 100644 --- a/sdks/node/types/model/signatureRequestSendRequest.d.ts +++ b/sdks/node/types/model/signatureRequestSendRequest.d.ts @@ -15,6 +15,7 @@ export declare class SignatureRequestSendRequest { "groupedSigners"?: Array; "allowDecline"?: boolean; "allowReassign"?: boolean; + "allowFormView"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; "clientId"?: string; diff --git a/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts b/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts index a527c0e84..d6165569c 100644 --- a/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts +++ b/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts @@ -13,6 +13,7 @@ export declare class TemplateCreateEmbeddedDraftRequest { "fileUrls"?: Array; "allowCcs"?: boolean; "allowReassign"?: boolean; + "allowFormView"?: boolean; "attachments"?: Array; "ccRoles"?: Array; "editorOptions"?: SubEditorOptions; diff --git a/sdks/node/types/model/templateCreateRequest.d.ts b/sdks/node/types/model/templateCreateRequest.d.ts index b81d319ea..f198ea8de 100644 --- a/sdks/node/types/model/templateCreateRequest.d.ts +++ b/sdks/node/types/model/templateCreateRequest.d.ts @@ -12,6 +12,7 @@ export declare class TemplateCreateRequest { "files"?: Array; "fileUrls"?: Array; "allowReassign"?: boolean; + "allowFormView"?: boolean; "attachments"?: Array; "ccRoles"?: Array; "clientId"?: string; diff --git a/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts b/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts index 1b48b08e1..3867d6dbc 100644 --- a/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts +++ b/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts @@ -15,6 +15,7 @@ export declare class UnclaimedDraftCreateEmbeddedRequest { "fileUrls"?: Array; "allowCcs"?: boolean; "allowDecline"?: boolean; + "allowFormView"?: boolean; "allowReassign"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; diff --git a/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts b/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts index fd54bdc79..7dc8008db 100644 --- a/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts +++ b/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts @@ -12,6 +12,7 @@ export declare class UnclaimedDraftCreateRequest { "files"?: Array; "fileUrls"?: Array; "allowDecline"?: boolean; + "allowFormView"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; "clientId"?: string; diff --git a/sdks/php/docs/Model/AccountCreateResponse.md b/sdks/php/docs/Model/AccountCreateResponse.md index bf38de482..d8464e2df 100644 --- a/sdks/php/docs/Model/AccountCreateResponse.md +++ b/sdks/php/docs/Model/AccountCreateResponse.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | | | | `oauth_data` | [```\Dropbox\Sign\Model\OAuthTokenResponse```](OAuthTokenResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountGetResponse.md b/sdks/php/docs/Model/AccountGetResponse.md index e7cecaf5d..5c6298343 100644 --- a/sdks/php/docs/Model/AccountGetResponse.md +++ b/sdks/php/docs/Model/AccountGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `account`*_required_ | [```\Dropbox\Sign\Model\AccountResponse```](AccountResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponse.md b/sdks/php/docs/Model/AccountResponse.md index 3121826ba..09ee81786 100644 --- a/sdks/php/docs/Model/AccountResponse.md +++ b/sdks/php/docs/Model/AccountResponse.md @@ -6,16 +6,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The ID of the Account | | -| `email_address` | ```string``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `account_id` | ```string``` | _t__Account::ACCOUNT_ID | | +| `email_address` | ```string``` | _t__Account::EMAIL_ADDRESS | | +| `is_locked` | ```bool``` | _t__Account::IS_LOCKED | | +| `is_paid_hs` | ```bool``` | _t__Account::IS_PAID_HS | | +| `is_paid_hf` | ```bool``` | _t__Account::IS_PAID_HF | | | `quotas` | [```\Dropbox\Sign\Model\AccountResponseQuotas```](AccountResponseQuotas.md) | | | -| `callback_url` | ```string``` | The URL that Dropbox Sign events will `POST` to. | | -| `role_code` | ```string``` | The membership role for the team. | | -| `team_id` | ```string``` | The id of the team account belongs to. | | -| `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. | | +| `callback_url` | ```string``` | _t__Account::CALLBACK_URL | | +| `role_code` | ```string``` | _t__Account::ROLE_CODE | | +| `team_id` | ```string``` | _t__Account::TEAM_ID | | +| `locale` | ```string``` | _t__Account::LOCALE | | | `usage` | [```\Dropbox\Sign\Model\AccountResponseUsage```](AccountResponseUsage.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponseQuotas.md b/sdks/php/docs/Model/AccountResponseQuotas.md index 96399403d..44c4e2cc0 100644 --- a/sdks/php/docs/Model/AccountResponseQuotas.md +++ b/sdks/php/docs/Model/AccountResponseQuotas.md @@ -1,16 +1,16 @@ # # AccountResponseQuotas -Details concerning remaining monthly quotas. +_t__Account::QUOTA ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `templates_total` | ```int``` | Total API templates allowed. | | -| `templates_left` | ```int``` | API templates remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```int``` | Number of fax pages left | | +| `api_signature_requests_left` | ```int``` | _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documents_left` | ```int``` | _t__AccountQuota::DOCUMENTS_LEFT | | +| `templates_total` | ```int``` | _t__AccountQuota::TEMPLATES_TOTAL | | +| `templates_left` | ```int``` | _t__AccountQuota::TEMPLATES_LEFT | | +| `sms_verifications_left` | ```int``` | _t__AccountQuota::SMS_VERIFICATIONS_LEFT | | +| `num_fax_pages_left` | ```int``` | _t__AccountQuota::NUM_FAX_PAGES_LEFT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountResponseUsage.md b/sdks/php/docs/Model/AccountResponseUsage.md index 3d8c992c2..7b51ee68c 100644 --- a/sdks/php/docs/Model/AccountResponseUsage.md +++ b/sdks/php/docs/Model/AccountResponseUsage.md @@ -1,11 +1,11 @@ # # AccountResponseUsage -Details concerning monthly usage +_t__Account::USAGE ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_pages_sent` | ```int``` | Number of fax pages sent | | +| `fax_pages_sent` | ```int``` | _t__AccountUsage::FAX_PAGES_SENT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountVerifyResponse.md b/sdks/php/docs/Model/AccountVerifyResponse.md index 6e7849d15..03b3c2e83 100644 --- a/sdks/php/docs/Model/AccountVerifyResponse.md +++ b/sdks/php/docs/Model/AccountVerifyResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `account` | [```\Dropbox\Sign\Model\AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/AccountVerifyResponseAccount.md b/sdks/php/docs/Model/AccountVerifyResponseAccount.md index ce3508004..526c56409 100644 --- a/sdks/php/docs/Model/AccountVerifyResponseAccount.md +++ b/sdks/php/docs/Model/AccountVerifyResponseAccount.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address` | ```string``` | The email address associated with the Account. | | +| `email_address` | ```string``` | _t__Account::EMAIL_ADDRESS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppGetResponse.md b/sdks/php/docs/Model/ApiAppGetResponse.md index b47e35c20..c55d18cbf 100644 --- a/sdks/php/docs/Model/ApiAppGetResponse.md +++ b/sdks/php/docs/Model/ApiAppGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `api_app`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse```](ApiAppResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppListResponse.md b/sdks/php/docs/Model/ApiAppListResponse.md index 2eb8ae3c9..591d8c00c 100644 --- a/sdks/php/docs/Model/ApiAppListResponse.md +++ b/sdks/php/docs/Model/ApiAppListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_apps`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse[]```](ApiAppResponse.md) | Contains information about API Apps. | | +| `api_apps`*_required_ | [```\Dropbox\Sign\Model\ApiAppResponse[]```](ApiAppResponse.md) | _t__ApiAppListResponse::DESCRIPTION | | | `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponse.md b/sdks/php/docs/Model/ApiAppResponse.md index 975df4b5c..3a16b3d04 100644 --- a/sdks/php/docs/Model/ApiAppResponse.md +++ b/sdks/php/docs/Model/ApiAppResponse.md @@ -1,17 +1,17 @@ # # ApiAppResponse -Contains information about an API App. +_t__ApiAppResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | The app's callback URL (for events) | | -| `client_id` | ```string``` | The app's client id | | -| `created_at` | ```int``` | The time that the app was created | | -| `domains` | ```string[]``` | The domain name(s) associated with the app | | -| `name` | ```string``` | The name of the app | | -| `is_approved` | ```bool``` | Boolean to indicate if the app has been approved | | +| `callback_url` | ```string``` | _t__ApiAppResponse::CALLBACK_URL | | +| `client_id` | ```string``` | _t__ApiAppResponse::CLIENT_ID | | +| `created_at` | ```int``` | _t__ApiAppResponse::CREATED_AT | | +| `domains` | ```string[]``` | _t__ApiAppResponse::DOMAINS | | +| `name` | ```string``` | _t__ApiAppResponse::NAME | | +| `is_approved` | ```bool``` | _t__ApiAppResponse::IS_APPROVED | | | `oauth` | [```\Dropbox\Sign\Model\ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | | `options` | [```\Dropbox\Sign\Model\ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | | `owner_account` | [```\Dropbox\Sign\Model\ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | diff --git a/sdks/php/docs/Model/ApiAppResponseOAuth.md b/sdks/php/docs/Model/ApiAppResponseOAuth.md index f6010fe20..c4fe0d3c6 100644 --- a/sdks/php/docs/Model/ApiAppResponseOAuth.md +++ b/sdks/php/docs/Model/ApiAppResponseOAuth.md @@ -1,14 +1,14 @@ # # ApiAppResponseOAuth -An object describing the app's OAuth properties, or null if OAuth is not configured for the app. +_t__ApiAppResponseOAuth::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | The app's OAuth callback URL. | | -| `secret` | ```string``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```string[]``` | Array of OAuth scopes used by the app. | | -| `charges_users` | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callback_url` | ```string``` | _t__ApiAppResponseOAuth::CALLBACK_URL | | +| `secret` | ```string``` | _t__ApiAppResponseOAuth::SECRET | | +| `scopes` | ```string[]``` | _t__ApiAppResponseOAuth::SCOPES | | +| `charges_users` | ```bool``` | _t__ApiAppResponseOAuth::CHARGES_USERS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseOptions.md b/sdks/php/docs/Model/ApiAppResponseOptions.md index 872e8ed0f..8b6db16cc 100644 --- a/sdks/php/docs/Model/ApiAppResponseOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseOptions.md @@ -1,11 +1,11 @@ # # ApiAppResponseOptions -An object with options that override account settings. +_t__ApiAppResponseOptions::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere` | ```bool``` | _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md index 8f1ce1963..a4c65fd10 100644 --- a/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md +++ b/sdks/php/docs/Model/ApiAppResponseOwnerAccount.md @@ -1,12 +1,12 @@ # # ApiAppResponseOwnerAccount -An object describing the app's owner +_t__ApiAppResponseOwnerAccount::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The owner account's ID | | -| `email_address` | ```string``` | The owner account's email address | | +| `account_id` | ```string``` | _t__ApiAppResponseOwnerAccount::ACCOUNT_ID | | +| `email_address` | ```string``` | _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md index 6e963383c..6e997d45a 100644 --- a/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/php/docs/Model/ApiAppResponseWhiteLabelingOptions.md @@ -1,6 +1,6 @@ # # ApiAppResponseWhiteLabelingOptions -An object with options to customize the app's signer page +_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION ## Properties diff --git a/sdks/php/docs/Model/BulkSendJobGetResponse.md b/sdks/php/docs/Model/BulkSendJobGetResponse.md index ec44f5b9a..eeef80632 100644 --- a/sdks/php/docs/Model/BulkSendJobGetResponse.md +++ b/sdks/php/docs/Model/BulkSendJobGetResponse.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | | | | `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[]```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobGetResponseSignatureRequests[]```](BulkSendJobGetResponseSignatureRequests.md) | _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md b/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md index 247951d28..b0b8349aa 100644 --- a/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md @@ -6,30 +6,30 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `test_mode` | ```bool``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | -| `signature_request_id` | ```string``` | The id of the SignatureRequest. | | -| `requester_email_address` | ```string``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```string``` | The title the specified Account uses for the SignatureRequest. | | -| `original_title` | ```string``` | Default Label for account. | | -| `subject` | ```string``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```string``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```array``` | The metadata attached to the signature request. | | -| `created_at` | ```int``` | Time the signature request was created. | | -| `expires_at` | ```int``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `is_complete` | ```bool``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `is_declined` | ```bool``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `has_error` | ```bool``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `files_url` | ```string``` | The URL where a copy of the request's documents can be downloaded. | | -| `signing_url` | ```string``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `details_url` | ```string``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `cc_email_addresses` | ```string[]``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signing_redirect_url` | ```string``` | The URL you want the signer redirected to after they successfully sign. | | -| `final_copy_uri` | ```string``` | The path where the completed document can be downloaded | | -| `template_ids` | ```string[]``` | Templates IDs used in this SignatureRequest (if any). | | -| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | | +| `test_mode` | ```bool``` | _t__SignatureRequestResponse::TEST_MODE | [default to false] | +| `signature_request_id` | ```string``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requester_email_address` | ```string``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```string``` | _t__SignatureRequestResponse::TITLE | | +| `original_title` | ```string``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```string``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```string``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```array``` | _t__SignatureRequestResponse::METADATA | | +| `created_at` | ```int``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expires_at` | ```int``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `is_complete` | ```bool``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `is_declined` | ```bool``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `has_error` | ```bool``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `files_url` | ```string``` | _t__SignatureRequestResponse::FILES_URL | | +| `signing_url` | ```string``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `details_url` | ```string``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `cc_email_addresses` | ```string[]``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signing_redirect_url` | ```string``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `final_copy_uri` | ```string``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `template_ids` | ```string[]``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulk_send_job_id` | ```string``` | _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobListResponse.md b/sdks/php/docs/Model/BulkSendJobListResponse.md index 470448cd9..5f2abb504 100644 --- a/sdks/php/docs/Model/BulkSendJobListResponse.md +++ b/sdks/php/docs/Model/BulkSendJobListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_jobs`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse[]```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | +| `bulk_send_jobs`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse[]```](BulkSendJobResponse.md) | _t__BulkSendJobListResponse::BULK_SEND_JOBS | | | `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobResponse.md b/sdks/php/docs/Model/BulkSendJobResponse.md index 16194fdd3..bf3ceef02 100644 --- a/sdks/php/docs/Model/BulkSendJobResponse.md +++ b/sdks/php/docs/Model/BulkSendJobResponse.md @@ -1,14 +1,14 @@ # # BulkSendJobResponse -Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. +_t__BulkSendJobResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | | -| `total` | ```int``` | The total amount of Signature Requests queued for sending. | | -| `is_creator` | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at` | ```int``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id` | ```string``` | _t__BulkSendJobResponse::BULK_SEND_JOB_ID | | +| `total` | ```int``` | _t__BulkSendJobResponse::TOTAL | | +| `is_creator` | ```bool``` | _t__BulkSendJobResponse::IS_CREATOR | | +| `created_at` | ```int``` | _t__BulkSendJobResponse::CREATED_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/BulkSendJobSendResponse.md b/sdks/php/docs/Model/BulkSendJobSendResponse.md index 83f1c7f8b..aa2be51c7 100644 --- a/sdks/php/docs/Model/BulkSendJobSendResponse.md +++ b/sdks/php/docs/Model/BulkSendJobSendResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `bulk_send_job`*_required_ | [```\Dropbox\Sign\Model\BulkSendJobResponse```](BulkSendJobResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedEditUrlRequest.md b/sdks/php/docs/Model/EmbeddedEditUrlRequest.md index ad008f66e..c3af7257f 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlRequest.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlRequest.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `allow_edit_ccs` | ```bool``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to false] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | | `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to false] | diff --git a/sdks/php/docs/Model/EmbeddedEditUrlResponse.md b/sdks/php/docs/Model/EmbeddedEditUrlResponse.md index 75b539197..84c22640d 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlResponse.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md b/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md index 03d32b4ef..f3037395e 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlResponseEmbedded.md @@ -1,12 +1,12 @@ # # EmbeddedEditUrlResponseEmbedded -An embedded template object. +_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `edit_url` | ```string``` | A template url that can be opened in an iFrame. | | -| `expires_at` | ```int``` | The specific time that the the `edit_url` link expires, in epoch. | | +| `edit_url` | ```string``` | _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL | | +| `expires_at` | ```int``` | _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedSignUrlResponse.md b/sdks/php/docs/Model/EmbeddedSignUrlResponse.md index bbf44ed90..0b3ce0819 100644 --- a/sdks/php/docs/Model/EmbeddedSignUrlResponse.md +++ b/sdks/php/docs/Model/EmbeddedSignUrlResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `embedded`*_required_ | [```\Dropbox\Sign\Model\EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md b/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md index a3794eb9e..8e37d6c37 100644 --- a/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/php/docs/Model/EmbeddedSignUrlResponseEmbedded.md @@ -1,12 +1,12 @@ # # EmbeddedSignUrlResponseEmbedded -An object that contains necessary information to set up embedded signing. +_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `sign_url` | ```string``` | A signature url that can be opened in an iFrame. | | -| `expires_at` | ```int``` | The specific time that the the `sign_url` link expires, in epoch. | | +| `sign_url` | ```string``` | _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL | | +| `expires_at` | ```int``` | _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ErrorResponseError.md b/sdks/php/docs/Model/ErrorResponseError.md index b600e94c8..96f06b277 100644 --- a/sdks/php/docs/Model/ErrorResponseError.md +++ b/sdks/php/docs/Model/ErrorResponseError.md @@ -1,13 +1,13 @@ # # ErrorResponseError -Contains information about an error that occurred. +_t__ErrorResponseError::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `error_msg`*_required_ | ```string``` | Message describing an error. | | -| `error_name`*_required_ | ```string``` | Name of the error. | | -| `error_path` | ```string``` | Path at which an error occurred. | | +| `error_msg`*_required_ | ```string``` | _t__ErrorResponseError::ERROR_MSG | | +| `error_name`*_required_ | ```string``` | _t__ErrorResponseError::ERROR_NAME | | +| `error_path` | ```string``` | _t__ErrorResponseError::ERROR_PATH | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EventCallbackRequestEvent.md b/sdks/php/docs/Model/EventCallbackRequestEvent.md index 84a3f872f..5fe941426 100644 --- a/sdks/php/docs/Model/EventCallbackRequestEvent.md +++ b/sdks/php/docs/Model/EventCallbackRequestEvent.md @@ -1,14 +1,14 @@ # # EventCallbackRequestEvent -Basic information about the event that occurred. +_t__EventCallbackRequestEvent::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `event_time`*_required_ | ```string``` | Time the event was created (using Unix time). | | -| `event_type`*_required_ | ```string``` | Type of callback event that was triggered. | | -| `event_hash`*_required_ | ```string``` | Generated hash used to verify source of event data. | | +| `event_time`*_required_ | ```string``` | _t__EventCallbackRequestEvent::EVENT_TIME | | +| `event_type`*_required_ | ```string``` | _t__EventCallbackRequestEvent::EVENT_TYPE | | +| `event_hash`*_required_ | ```string``` | _t__EventCallbackRequestEvent::EVENT_HASH | | | `event_metadata` | [```\Dropbox\Sign\Model\EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md b/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md index 1b7e08e01..b4e5dd3ea 100644 --- a/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md +++ b/sdks/php/docs/Model/EventCallbackRequestEventMetadata.md @@ -1,14 +1,14 @@ # # EventCallbackRequestEventMetadata -Specific metadata about the event. +_t__EventCallbackRequestEventMetadata::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `related_signature_id` | ```string``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | -| `reported_for_account_id` | ```string``` | Account ID the event was reported for. | | -| `reported_for_app_id` | ```string``` | App ID the event was reported for. | | -| `event_message` | ```string``` | Message about a declined or failed (due to error) signature flow. | | +| `related_signature_id` | ```string``` | _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID | | +| `reported_for_account_id` | ```string``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID | | +| `reported_for_app_id` | ```string``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID | | +| `event_message` | ```string``` | _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxGetResponse.md b/sdks/php/docs/Model/FaxGetResponse.md index 59bea7dc3..925926114 100644 --- a/sdks/php/docs/Model/FaxGetResponse.md +++ b/sdks/php/docs/Model/FaxGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `fax`*_required_ | [```\Dropbox\Sign\Model\FaxResponse```](FaxResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FileResponse.md b/sdks/php/docs/Model/FileResponse.md index 5803b6565..3dc2aef17 100644 --- a/sdks/php/docs/Model/FileResponse.md +++ b/sdks/php/docs/Model/FileResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `file_url`*_required_ | ```string``` | URL to the file. | | -| `expires_at`*_required_ | ```int``` | When the link expires. | | +| `file_url`*_required_ | ```string``` | _t__FileResponse::FILE_URL | | +| `expires_at`*_required_ | ```int``` | _t__FileResponse::EXPIRES_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FileResponseDataUri.md b/sdks/php/docs/Model/FileResponseDataUri.md index dbead09b0..f0cd81137 100644 --- a/sdks/php/docs/Model/FileResponseDataUri.md +++ b/sdks/php/docs/Model/FileResponseDataUri.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `data_uri`*_required_ | ```string``` | File as base64 encoded string. | | +| `data_uri`*_required_ | ```string``` | _t__FileResponse::DATA_URI | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ListInfoResponse.md b/sdks/php/docs/Model/ListInfoResponse.md index 872ace684..c4444e6e0 100644 --- a/sdks/php/docs/Model/ListInfoResponse.md +++ b/sdks/php/docs/Model/ListInfoResponse.md @@ -1,14 +1,14 @@ # # ListInfoResponse -Contains pagination information about the data returned. +_t__ListInfoResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_pages` | ```int``` | Total number of pages available. | | -| `num_results` | ```int``` | Total number of objects available. | | -| `page` | ```int``` | Number of the page being returned. | | -| `page_size` | ```int``` | Objects returned per page. | | +| `num_pages` | ```int``` | _t__ListInfoResponse::NUM_PAGES | | +| `num_results` | ```int``` | _t__ListInfoResponse::NUM_RESULTS | | +| `page` | ```int``` | _t__ListInfoResponse::PAGE | | +| `page_size` | ```int``` | _t__ListInfoResponse::PAGE_SIZE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/OAuthTokenResponse.md b/sdks/php/docs/Model/OAuthTokenResponse.md index 016f00e9b..919db1a69 100644 --- a/sdks/php/docs/Model/OAuthTokenResponse.md +++ b/sdks/php/docs/Model/OAuthTokenResponse.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes | `access_token` | ```string``` | | | | `token_type` | ```string``` | | | | `refresh_token` | ```string``` | | | -| `expires_in` | ```int``` | Number of seconds until the `access_token` expires. Uses epoch time. | | +| `expires_in` | ```int``` | _t__OAuthTokenResponse::EXPIRES_IN | | | `state` | ```string``` | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ReportCreateResponse.md b/sdks/php/docs/Model/ReportCreateResponse.md index 335d94a47..1fdbdf897 100644 --- a/sdks/php/docs/Model/ReportCreateResponse.md +++ b/sdks/php/docs/Model/ReportCreateResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `report`*_required_ | [```\Dropbox\Sign\Model\ReportResponse```](ReportResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/ReportResponse.md b/sdks/php/docs/Model/ReportResponse.md index 3b253ce4e..fd6429d1c 100644 --- a/sdks/php/docs/Model/ReportResponse.md +++ b/sdks/php/docs/Model/ReportResponse.md @@ -1,14 +1,14 @@ # # ReportResponse -Contains information about the report request. +_t__ReportResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `success` | ```string``` | A message indicating the requested operation's success | | -| `start_date` | ```string``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | | -| `end_date` | ```string``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | | -| `report_type` | ```string[]``` | 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). | | +| `success` | ```string``` | _t__ReportResponse::SUCCESS | | +| `start_date` | ```string``` | _t__ReportResponse::START_DATE | | +| `end_date` | ```string``` | _t__ReportResponse::END_DATE | | +| `report_type` | ```string[]``` | _t__ReportResponse::REPORT_TYPE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index 53be15f83..a2da6515b 100644 --- a/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes | `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md index 10d93b867..aecb4ba69 100644 --- a/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestBulkSendWithTemplateRequest.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes | `client_id` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md index a953bcbc2..0c3e80938 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md @@ -9,11 +9,12 @@ Name | Type | Description | Notes | `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | @@ -22,7 +23,7 @@ Name | Type | Description | Notes | `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md index b41a8e311..b65039bb3 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -8,14 +8,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md index b2567ac3f..3bee7d695 100644 --- a/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md @@ -9,11 +9,12 @@ Name | Type | Description | Notes | `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | @@ -22,7 +23,7 @@ Name | Type | Description | Notes | `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md index 3b9df4cac..8af01de74 100644 --- a/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -8,14 +8,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `client_id`*_required_ | ```string``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/php/docs/Model/SignatureRequestEditRequest.md b/sdks/php/docs/Model/SignatureRequestEditRequest.md index 0d3ca23ce..1ce97f7cc 100644 --- a/sdks/php/docs/Model/SignatureRequestEditRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditRequest.md @@ -8,11 +8,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | | `client_id` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -23,7 +24,7 @@ Name | Type | Description | Notes | `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | | `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md index 072fdc080..35580eb1f 100644 --- a/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `client_id` | ```string``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -16,7 +16,7 @@ Name | Type | Description | Notes | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/php/docs/Model/SignatureRequestGetResponse.md b/sdks/php/docs/Model/SignatureRequestGetResponse.md index c2f3c97b7..2247610b5 100644 --- a/sdks/php/docs/Model/SignatureRequestGetResponse.md +++ b/sdks/php/docs/Model/SignatureRequestGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `signature_request`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse```](SignatureRequestResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestListResponse.md b/sdks/php/docs/Model/SignatureRequestListResponse.md index c0aae36cd..e5ebf2a6c 100644 --- a/sdks/php/docs/Model/SignatureRequestListResponse.md +++ b/sdks/php/docs/Model/SignatureRequestListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse[]```](SignatureRequestResponse.md) | Contains information about signature requests. | | +| `signature_requests`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponse[]```](SignatureRequestResponse.md) | _t__SignatureRequestListResponse::DESCRIPTION | | | `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponse.md b/sdks/php/docs/Model/SignatureRequestResponse.md index bb04b5d30..4d1f55e00 100644 --- a/sdks/php/docs/Model/SignatureRequestResponse.md +++ b/sdks/php/docs/Model/SignatureRequestResponse.md @@ -1,35 +1,35 @@ # # SignatureRequestResponse -Contains information about a signature request. +_t__SignatureRequestResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `test_mode` | ```bool``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | -| `signature_request_id` | ```string``` | The id of the SignatureRequest. | | -| `requester_email_address` | ```string``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```string``` | The title the specified Account uses for the SignatureRequest. | | -| `original_title` | ```string``` | Default Label for account. | | -| `subject` | ```string``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```string``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```array``` | The metadata attached to the signature request. | | -| `created_at` | ```int``` | Time the signature request was created. | | -| `expires_at` | ```int``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `is_complete` | ```bool``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `is_declined` | ```bool``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `has_error` | ```bool``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `files_url` | ```string``` | The URL where a copy of the request's documents can be downloaded. | | -| `signing_url` | ```string``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `details_url` | ```string``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `cc_email_addresses` | ```string[]``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signing_redirect_url` | ```string``` | The URL you want the signer redirected to after they successfully sign. | | -| `final_copy_uri` | ```string``` | The path where the completed document can be downloaded | | -| `template_ids` | ```string[]``` | Templates IDs used in this SignatureRequest (if any). | | -| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulk_send_job_id` | ```string``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `test_mode` | ```bool``` | _t__SignatureRequestResponse::TEST_MODE | [default to false] | +| `signature_request_id` | ```string``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requester_email_address` | ```string``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```string``` | _t__SignatureRequestResponse::TITLE | | +| `original_title` | ```string``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```string``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```string``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```array``` | _t__SignatureRequestResponse::METADATA | | +| `created_at` | ```int``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expires_at` | ```int``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `is_complete` | ```bool``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `is_declined` | ```bool``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `has_error` | ```bool``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `files_url` | ```string``` | _t__SignatureRequestResponse::FILES_URL | | +| `signing_url` | ```string``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `details_url` | ```string``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `cc_email_addresses` | ```string[]``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signing_redirect_url` | ```string``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `final_copy_uri` | ```string``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `template_ids` | ```string[]``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `custom_fields` | [```\Dropbox\Sign\Model\SignatureRequestResponseCustomFieldBase[]```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulk_send_job_id` | ```string``` | _t__SignatureRequestResponse::BULK_SEND_JOB_ID | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseAttachment.md b/sdks/php/docs/Model/SignatureRequestResponseAttachment.md index 6e84393ae..773320974 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseAttachment.md +++ b/sdks/php/docs/Model/SignatureRequestResponseAttachment.md @@ -1,16 +1,16 @@ # # SignatureRequestResponseAttachment -Signer attachments. +_t__SignatureRequestResponseAttachment::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `id`*_required_ | ```string``` | The unique ID for this attachment. | | -| `signer`*_required_ | ```string``` | The Signer this attachment is assigned to. | | -| `name`*_required_ | ```string``` | The name of this attachment. | | -| `required`*_required_ | ```bool``` | A boolean value denoting if this attachment is required. | | -| `instructions` | ```string``` | Instructions for Signer. | | -| `uploaded_at` | ```int``` | Timestamp when attachment was uploaded by Signer. | | +| `id`*_required_ | ```string``` | _t__SignatureRequestResponseAttachment::ID | | +| `signer`*_required_ | ```string``` | _t__SignatureRequestResponseAttachment::SIGNER | | +| `name`*_required_ | ```string``` | _t__SignatureRequestResponseAttachment::NAME | | +| `required`*_required_ | ```bool``` | _t__SignatureRequestResponseAttachment::REQUIRED | | +| `instructions` | ```string``` | _t__SignatureRequestResponseAttachment::INSTRUCTIONS | | +| `uploaded_at` | ```int``` | _t__SignatureRequestResponseAttachment::UPLOADED_AT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md index 40685da58..1823c8d04 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldBase.md @@ -1,18 +1,15 @@ # # SignatureRequestResponseCustomFieldBase -An array of Custom Field objects containing the name and type of each custom field. - -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` +_t__SignatureRequestResponseCustomField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `name`*_required_ | ```string``` | The name of the Custom Field. | | -| `required` | ```bool``` | A boolean value denoting if this field is required. | | -| `api_id` | ```string``` | The unique ID for this field. | | -| `editor` | ```string``` | The name of the Role that is able to edit this field. | | +| `type`*_required_ | ```string``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `name`*_required_ | ```string``` | _t__SignatureRequestResponseCustomField::NAME | | +| `required` | ```bool``` | _t__SignatureRequestResponseCustomField::REQUIRED | | +| `api_id` | ```string``` | _t__SignatureRequestResponseCustomField::API_ID | | +| `editor` | ```string``` | _t__SignatureRequestResponseCustomField::EDITOR | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md index 08c64f658..1a952036e 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldCheckbox.md @@ -1,12 +1,12 @@ # # SignatureRequestResponseCustomFieldCheckbox -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'checkbox'] | -| `value` | ```bool``` | A true/false for checkbox fields | | +| `type`*_required_ | ```string``` | _t__SignatureRequestResponseCustomField::TYPE | [default to 'checkbox'] | +| `value` | ```bool``` | _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md index 38486e804..825730495 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md +++ b/sdks/php/docs/Model/SignatureRequestResponseCustomFieldText.md @@ -1,12 +1,12 @@ # # SignatureRequestResponseCustomFieldText -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'text'] | -| `value` | ```string``` | A text string for text fields | | +| `type`*_required_ | ```string``` | _t__SignatureRequestResponseCustomField::TYPE | [default to 'text'] | +| `value` | ```string``` | _t__SignatureRequestResponseCustomField::VALUE_TEXT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataBase.md b/sdks/php/docs/Model/SignatureRequestResponseDataBase.md index 7a1f3ef03..28552459f 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataBase.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataBase.md @@ -1,15 +1,15 @@ # # SignatureRequestResponseDataBase -An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. +_t__SignatureRequestResponseData::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id` | ```string``` | The unique ID for this field. | | -| `signature_id` | ```string``` | The ID of the signature to which this response is linked. | | -| `name` | ```string``` | The name of the form field. | | -| `required` | ```bool``` | A boolean value denoting if this field is required. | | +| `api_id` | ```string``` | _t__SignatureRequestResponseData::API_ID | | +| `signature_id` | ```string``` | _t__SignatureRequestResponseData::SIGNATURE_ID | | +| `name` | ```string``` | _t__SignatureRequestResponseData::NAME | | +| `required` | ```bool``` | _t__SignatureRequestResponseData::REQUIRED | | | `type` | ```string``` | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md index dfdc66f06..796ef685e 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckbox.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A yes/no checkbox | [default to 'checkbox'] | -| `value` | ```bool``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE | [default to 'checkbox'] | +| `value` | ```bool``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md index 00475b7bd..d059a9e2d 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueCheckboxMerge.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A checkbox field that has default value set by the api | [default to 'checkbox-merge'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE | [default to 'checkbox-merge'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md index 56a613c94..1423bb4e6 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueDateSigned.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A date | [default to 'date_signed'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE | [default to 'date_signed'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md index 61ddaae67..48ff79580 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueDropdown.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | An input field for dropdowns | [default to 'dropdown'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE | [default to 'dropdown'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md index f4bf660f6..93f4cc20e 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueInitials.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | An input field for initials | [default to 'initials'] | -| `value` | ```string``` | The value of the form field. | | -| `is_signed` | ```bool``` | This field contains the boolean true if the field is signed. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::INITIAL_TYPE | [default to 'initials'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `is_signed` | ```bool``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md index e5de3e9af..146dcd43c 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueRadio.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | An input field for radios | [default to 'radio'] | -| `value` | ```bool``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::RADIO_TYPE | [default to 'radio'] | +| `value` | ```bool``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md index 877febbcd..15bf2a473 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueSignature.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A signature input field | [default to 'signature'] | -| `value` | ```string``` | The value of the form field. | | -| `is_signed` | ```bool``` | This field contains the boolean true if the field is signed. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE | [default to 'signature'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `is_signed` | ```bool``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md index 6058f2017..921d0ecbe 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueText.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A text input field | [default to 'text'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::TEXT_TYPE | [default to 'text'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md b/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md index e1b140727..6009c6212 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/php/docs/Model/SignatureRequestResponseDataValueTextMerge.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```string``` | A text field that has default text set by the api | [default to 'text-merge'] | -| `value` | ```string``` | The value of the form field. | | +| `type` | ```string``` | _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE | [default to 'text-merge'] | +| `value` | ```string``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponseSignatures.md b/sdks/php/docs/Model/SignatureRequestResponseSignatures.md index 6d49a3089..5fb56c5e9 100644 --- a/sdks/php/docs/Model/SignatureRequestResponseSignatures.md +++ b/sdks/php/docs/Model/SignatureRequestResponseSignatures.md @@ -1,29 +1,29 @@ # # SignatureRequestResponseSignatures -An array of signature objects, 1 for each signer. +_t__SignatureRequestResponseSignatures::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_id` | ```string``` | Signature identifier. | | -| `signer_group_guid` | ```string``` | Signer Group GUID | | -| `signer_email_address` | ```string``` | The email address of the signer. | | -| `signer_name` | ```string``` | The name of the signer. | | -| `signer_role` | ```string``` | The role of the signer. | | -| `order` | ```int``` | If signer order is assigned this is the 0-based index for this signer. | | -| `status_code` | ```string``` | The current status of the signature. eg: awaiting_signature, signed, declined. | | -| `decline_reason` | ```string``` | The reason provided by the signer for declining the request. | | -| `signed_at` | ```int``` | Time that the document was signed or null. | | -| `last_viewed_at` | ```int``` | The time that the document was last viewed by this signer or null. | | -| `last_reminded_at` | ```int``` | The time the last reminder email was sent to the signer or null. | | -| `has_pin` | ```bool``` | Boolean to indicate whether this signature requires a PIN to access. | | -| `has_sms_auth` | ```bool``` | Boolean to indicate whether this signature has SMS authentication enabled. | | -| `has_sms_delivery` | ```bool``` | Boolean to indicate whether this signature has SMS delivery enabled. | | -| `sms_phone_number` | ```string``` | The SMS phone number used for authentication or signature request delivery. | | -| `reassigned_by` | ```string``` | Email address of original signer who reassigned to this signer. | | -| `reassignment_reason` | ```string``` | Reason provided by original signer who reassigned to this signer. | | -| `reassigned_from` | ```string``` | Previous signature identifier. | | -| `error` | ```string``` | Error message pertaining to this signer, or null. | | +| `signature_id` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNATURE_ID | | +| `signer_group_guid` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID | | +| `signer_email_address` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS | | +| `signer_name` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNER_NAME | | +| `signer_role` | ```string``` | _t__SignatureRequestResponseSignatures::SIGNER_ROLE | | +| `order` | ```int``` | _t__SignatureRequestResponseSignatures::ORDER | | +| `status_code` | ```string``` | _t__SignatureRequestResponseSignatures::STATUS_CODE | | +| `decline_reason` | ```string``` | _t__SignatureRequestResponseSignatures::DECLINE_REASON | | +| `signed_at` | ```int``` | _t__SignatureRequestResponseSignatures::SIGNED_AT | | +| `last_viewed_at` | ```int``` | _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT | | +| `last_reminded_at` | ```int``` | _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT | | +| `has_pin` | ```bool``` | _t__SignatureRequestResponseSignatures::HAS_PIN | | +| `has_sms_auth` | ```bool``` | _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH | | +| `has_sms_delivery` | ```bool``` | _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY | | +| `sms_phone_number` | ```string``` | _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER | | +| `reassigned_by` | ```string``` | _t__SignatureRequestResponseSignatures::REASSIGNED_BY | | +| `reassignment_reason` | ```string``` | _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON | | +| `reassigned_from` | ```string``` | _t__SignatureRequestResponseSignatures::REASSIGNED_FROM | | +| `error` | ```string``` | _t__SignatureRequestResponseSignatures::ERROR | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendRequest.md b/sdks/php/docs/Model/SignatureRequestSendRequest.md index 65d3a7d91..aa4714bf0 100644 --- a/sdks/php/docs/Model/SignatureRequestSendRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendRequest.md @@ -8,11 +8,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | | `client_id` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -24,7 +25,7 @@ Name | Type | Description | Notes | `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md index cbfaeb338..32445c731 100644 --- a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```string[]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestTemplateSigner[]```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```\Dropbox\Sign\Model\SubCC[]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `client_id` | ```string``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -17,7 +17,7 @@ Name | Type | Description | Notes | `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md index 7c7f4c293..a5b4715ad 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentBase.md @@ -25,9 +25,9 @@ Name | Type | Description | Notes | `required`*_required_ | ```bool``` | Whether this field is required. | | | `signer`*_required_ | ```string``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | | | `type`*_required_ | ```string``` | | | -| `width`*_required_ | ```int``` | Size of the field in pixels. | | -| `x`*_required_ | ```int``` | Location coordinates of the field in pixels. | | -| `y`*_required_ | ```int``` | Location coordinates of the field in pixels. | | +| `width`*_required_ | ```int``` | _t__Sub::FormFieldsPerDocument::WIDTH | | +| `x`*_required_ | ```int``` | _t__Sub::FormFieldsPerDocument::X | | +| `y`*_required_ | ```int``` | _t__Sub::FormFieldsPerDocument::Y | | | `name` | ```string``` | Display name for the field. | | | `page` | ```int``` | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | | diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md index c41a60817..983385200 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentText.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes | `auto_fill_type` | ```string``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | | | `link_id` | ```string``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | | | `masked` | ```bool``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | | -| `validation_type` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.

**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | | +| `validation_type` | ```string``` | _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE | | | `validation_custom_regex` | ```string``` | | | | `validation_custom_regex_format_label` | ```string``` | | | | `content` | ```string``` | Content of a `me_now` text field | | diff --git a/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md b/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md index 40c07308f..e23bd4fed 100644 --- a/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/php/docs/Model/SubFormFieldsPerDocumentTextMerge.md @@ -6,7 +6,7 @@ This class extends `SubFormFieldsPerDocumentBase`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] | +| `type`*_required_ | ```string``` | _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE | [default to 'text-merge'] | | `font_family` | ```string``` | Font family for the field. | | | `font_size` | ```int``` | 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] | diff --git a/sdks/php/docs/Model/SubMergeField.md b/sdks/php/docs/Model/SubMergeField.md index 1114a084b..9751add42 100644 --- a/sdks/php/docs/Model/SubMergeField.md +++ b/sdks/php/docs/Model/SubMergeField.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the merge field. Must be unique. | | -| `type`*_required_ | ```string``` | The type of merge field. | | +| `name`*_required_ | ```string``` | _t__Sub::MergeField::NAME | | +| `type`*_required_ | ```string``` | _t__Sub::MergeField::TYPE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubOAuth.md b/sdks/php/docs/Model/SubOAuth.md index 26088e668..19e883eb5 100644 --- a/sdks/php/docs/Model/SubOAuth.md +++ b/sdks/php/docs/Model/SubOAuth.md @@ -1,12 +1,12 @@ # # SubOAuth -OAuth related parameters. +_t__Sub::OAuth::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```string``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | -| `scopes` | ```string[]``` | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | +| `callback_url` | ```string``` | _t__Sub::OAuth::CALLBACK_URL | | +| `scopes` | ```string[]``` | _t__Sub::OAuth::SCOPES | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubOptions.md b/sdks/php/docs/Model/SubOptions.md index 926c89eab..72da87da4 100644 --- a/sdks/php/docs/Model/SubOptions.md +++ b/sdks/php/docs/Model/SubOptions.md @@ -1,11 +1,11 @@ # # SubOptions -Additional options supported by API App. +_t__Sub::Options::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | Determines if signers can use "Insert Everywhere" when signing a document. | [default to false] | +| `can_insert_everywhere` | ```bool``` | _t__Sub::Options::CAN_INSERT_EVERYWHERE | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md b/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md index 69275147a..bf160452a 100644 --- a/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md +++ b/sdks/php/docs/Model/SubSignatureRequestGroupedSigners.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `group`*_required_ | ```string``` | The name of the group. | | -| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](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. | | -| `order` | ```int``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | +| `group`*_required_ | ```string``` | _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME | | +| `signers`*_required_ | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestGroupedSigners::SIGNERS | | +| `order` | ```int``` | _t__Sub::SignatureRequestGroupedSigners::ORDER | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignatureRequestSigner.md b/sdks/php/docs/Model/SubSignatureRequestSigner.md index 8ba880dd0..3964955ac 100644 --- a/sdks/php/docs/Model/SubSignatureRequestSigner.md +++ b/sdks/php/docs/Model/SubSignatureRequestSigner.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```string``` | The name of the signer. | | -| `email_address`*_required_ | ```string``` | The email address of the signer. | | -| `order` | ```int``` | The order the signer is required to sign in. | | -| `pin` | ```string``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `sms_phone_number` | ```string``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `sms_phone_number_type` | ```string``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `name`*_required_ | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_NAME | | +| `email_address`*_required_ | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS | | +| `order` | ```int``` | _t__Sub::SignatureRequestSigner::SIGNER_ORDER | | +| `pin` | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_PIN | | +| `sms_phone_number` | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER | | +| `sms_phone_number_type` | ```string``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md b/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md index 5b1995c0b..5387bc137 100644 --- a/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md +++ b/sdks/php/docs/Model/SubSignatureRequestTemplateSigner.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | Must match an existing role in chosen Template(s). It's case-sensitive. | | -| `name`*_required_ | ```string``` | The name of the signer. | | -| `email_address`*_required_ | ```string``` | The email address of the signer. | | -| `pin` | ```string``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `sms_phone_number` | ```string``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `sms_phone_number_type` | ```string``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `role`*_required_ | ```string``` | _t__Sub::SignatureRequestTemplateSigner::ROLE | | +| `name`*_required_ | ```string``` | _t__Sub::SignatureRequestTemplateSigner::NAME | | +| `email_address`*_required_ | ```string``` | _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS | | +| `pin` | ```string``` | _t__Sub::SignatureRequestTemplateSigner::PIN | | +| `sms_phone_number` | ```string``` | _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER | | +| `sms_phone_number_type` | ```string``` | _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSigningOptions.md b/sdks/php/docs/Model/SubSigningOptions.md index e2a1b1660..86d1ddbdb 100644 --- a/sdks/php/docs/Model/SubSigningOptions.md +++ b/sdks/php/docs/Model/SubSigningOptions.md @@ -1,17 +1,15 @@ # # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. - -**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +_t__Sub::SigningOptions::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `default_type`*_required_ | ```string``` | The default type shown (limited to the listed types) | | -| `draw` | ```bool``` | Allows drawing the signature | [default to false] | -| `phone` | ```bool``` | Allows using a smartphone to email the signature | [default to false] | -| `type` | ```bool``` | Allows typing the signature | [default to false] | -| `upload` | ```bool``` | Allows uploading the signature | [default to false] | +| `default_type`*_required_ | ```string``` | _t__Sub::SigningOptions::DEFAULT | | +| `draw` | ```bool``` | _t__Sub::SigningOptions::DRAW | [default to false] | +| `phone` | ```bool``` | _t__Sub::SigningOptions::PHONE | [default to false] | +| `type` | ```bool``` | _t__Sub::SigningOptions::TYPE | [default to false] | +| `upload` | ```bool``` | _t__Sub::SigningOptions::UPLOAD | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubTeamResponse.md b/sdks/php/docs/Model/SubTeamResponse.md index e0c954d29..1eed291ca 100644 --- a/sdks/php/docs/Model/SubTeamResponse.md +++ b/sdks/php/docs/Model/SubTeamResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```string``` | The id of a team | | -| `name` | ```string``` | The name of a team | | +| `team_id` | ```string``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```string``` | _t__TeamGeneral::NAME | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubTemplateRole.md b/sdks/php/docs/Model/SubTemplateRole.md index 062527156..cec85d312 100644 --- a/sdks/php/docs/Model/SubTemplateRole.md +++ b/sdks/php/docs/Model/SubTemplateRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | -| `order` | ```int``` | The order in which this signer role is required to sign. | | +| `name` | ```string``` | _t__Sub::SignerRole::NAME | | +| `order` | ```int``` | _t__Sub::SignerRole::ORDER | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubUnclaimedDraftSigner.md b/sdks/php/docs/Model/SubUnclaimedDraftSigner.md index d5849d712..2a26ed522 100644 --- a/sdks/php/docs/Model/SubUnclaimedDraftSigner.md +++ b/sdks/php/docs/Model/SubUnclaimedDraftSigner.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```string``` | The email address of the signer. | | -| `name`*_required_ | ```string``` | The name of the signer. | | -| `order` | ```int``` | The order the signer is required to sign in. | | +| `email_address`*_required_ | ```string``` | _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS | | +| `name`*_required_ | ```string``` | _t__Sub::UnclaimedDraftSigner::NAME | | +| `order` | ```int``` | _t__Sub::UnclaimedDraftSigner::ORDER | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md b/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md index 3c20fd2e7..e0046abb4 100644 --- a/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/php/docs/Model/SubUnclaimedDraftTemplateSigner.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```string``` | Must match an existing role in chosen Template(s). | | -| `name`*_required_ | ```string``` | The name of the signer filling the role of `role`. | | -| `email_address`*_required_ | ```string``` | The email address of the signer filling the role of `role`. | | +| `role`*_required_ | ```string``` | _t__Sub::UnclaimedDraftTemplateSigner::ROLE | | +| `name`*_required_ | ```string``` | _t__Sub::UnclaimedDraftTemplateSigner::NAME | | +| `email_address`*_required_ | ```string``` | _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubWhiteLabelingOptions.md b/sdks/php/docs/Model/SubWhiteLabelingOptions.md index 976f55aaa..afaa5d2c0 100644 --- a/sdks/php/docs/Model/SubWhiteLabelingOptions.md +++ b/sdks/php/docs/Model/SubWhiteLabelingOptions.md @@ -1,8 +1,6 @@ # # SubWhiteLabelingOptions -An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) - -Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. +_t__Sub::WhiteLabelingOptions::DESCRIPTION ## Properties @@ -22,6 +20,6 @@ Name | Type | Description | Notes | `secondary_button_text_color_hover` | ```string``` | | [default to '#0061FE'] | | `text_color1` | ```string``` | | [default to '#808080'] | | `text_color2` | ```string``` | | [default to '#ffffff'] | -| `reset_to_default` | ```bool``` | Resets white labeling options to defaults. Only useful when updating an API App. | | +| `reset_to_default` | ```bool``` | _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamGetInfoResponse.md b/sdks/php/docs/Model/TeamGetInfoResponse.md index 6250ae721..180f90b4c 100644 --- a/sdks/php/docs/Model/TeamGetInfoResponse.md +++ b/sdks/php/docs/Model/TeamGetInfoResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `team`*_required_ | [```\Dropbox\Sign\Model\TeamInfoResponse```](TeamInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamGetResponse.md b/sdks/php/docs/Model/TeamGetResponse.md index 0d65f9000..36c4b0d6c 100644 --- a/sdks/php/docs/Model/TeamGetResponse.md +++ b/sdks/php/docs/Model/TeamGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `team`*_required_ | [```\Dropbox\Sign\Model\TeamResponse```](TeamResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamInfoResponse.md b/sdks/php/docs/Model/TeamInfoResponse.md index 6db4a64c2..44532ddb8 100644 --- a/sdks/php/docs/Model/TeamInfoResponse.md +++ b/sdks/php/docs/Model/TeamInfoResponse.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```string``` | The id of a team | | +| `team_id` | ```string``` | _t__TeamGeneral::TEAM_ID | | | `team_parent` | [```\Dropbox\Sign\Model\TeamParentResponse```](TeamParentResponse.md) | | | -| `name` | ```string``` | The name of a team | | -| `num_members` | ```int``` | Number of members within a team | | -| `num_sub_teams` | ```int``` | Number of sub teams within a team | | +| `name` | ```string``` | _t__TeamGeneral::NAME | | +| `num_members` | ```int``` | _t__TeamGeneral::NUM_MEMBERS | | +| `num_sub_teams` | ```int``` | _t__TeamGeneral::NUM_SUB_TEAMS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamParentResponse.md b/sdks/php/docs/Model/TeamParentResponse.md index 376880069..737e25d6b 100644 --- a/sdks/php/docs/Model/TeamParentResponse.md +++ b/sdks/php/docs/Model/TeamParentResponse.md @@ -6,7 +6,7 @@ Information about the parent team if a team has one, set to `null` otherwise. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```string``` | The id of a team | | -| `name` | ```string``` | The name of a team | | +| `team_id` | ```string``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```string``` | _t__TeamGeneral::NAME | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TeamResponse.md b/sdks/php/docs/Model/TeamResponse.md index 4aea582c9..b4a504363 100644 --- a/sdks/php/docs/Model/TeamResponse.md +++ b/sdks/php/docs/Model/TeamResponse.md @@ -1,14 +1,14 @@ # # TeamResponse -Contains information about your team and its members +_t__TeamResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of your Team | | +| `name` | ```string``` | _t__Team::NAME | | | `accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | | | -| `invited_accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](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`. | | -| `invited_emails` | ```string[]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `invited_accounts` | [```\Dropbox\Sign\Model\AccountResponse[]```](AccountResponse.md) | _t__Team::INVITED_ACCOUNTS | | +| `invited_emails` | ```string[]``` | _t__Team::INVITED_EMAILS | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md index d9ef188de..67c0a3108 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md @@ -11,7 +11,8 @@ Name | Type | Description | Notes | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to true] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request | | | `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | | `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | @@ -22,7 +23,7 @@ Name | Type | Description | Notes | `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```string``` | The default template email message. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | | `signer_roles` | [```\Dropbox\Sign\Model\SubTemplateRole[]```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md index 439aa708e..fa47a9733 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md index 7604fd299..1b9197618 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -1,14 +1,14 @@ # # TemplateCreateEmbeddedDraftResponseTemplate -Template object with parameters: `template_id`, `edit_url`, `expires_at`. +_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `edit_url` | ```string``` | Link to edit the template. | | -| `expires_at` | ```int``` | When the link expires. | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `template_id` | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | +| `edit_url` | ```string``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL | | +| `expires_at` | ```int``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateRequest.md b/sdks/php/docs/Model/TemplateCreateRequest.md index 1a4b677f1..03f87720e 100644 --- a/sdks/php/docs/Model/TemplateCreateRequest.md +++ b/sdks/php/docs/Model/TemplateCreateRequest.md @@ -11,7 +11,8 @@ Name | Type | Description | Notes | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request | | | `client_id` | ```string``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | | `field_options` | [```\Dropbox\Sign\Model\SubFieldOptions```](SubFieldOptions.md) | | | @@ -19,7 +20,7 @@ Name | Type | Description | Notes | `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | | `merge_fields` | [```\Dropbox\Sign\Model\SubMergeField[]```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```string``` | The default template email message. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `subject` | ```string``` | The template title (alias). | | | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | diff --git a/sdks/php/docs/Model/TemplateCreateResponse.md b/sdks/php/docs/Model/TemplateCreateResponse.md index 676d2acca..d4df3cbb2 100644 --- a/sdks/php/docs/Model/TemplateCreateResponse.md +++ b/sdks/php/docs/Model/TemplateCreateResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template`*_required_ | [```\Dropbox\Sign\Model\TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md index 0f25586c5..5b5c7dddc 100644 --- a/sdks/php/docs/Model/TemplateCreateResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md @@ -1,11 +1,11 @@ # # TemplateCreateResponseTemplate -Template object with parameters: `template_id`. +_t__TemplateCreateResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | +| `template_id` | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateEditResponse.md b/sdks/php/docs/Model/TemplateEditResponse.md index b343db573..5f5b04693 100644 --- a/sdks/php/docs/Model/TemplateEditResponse.md +++ b/sdks/php/docs/Model/TemplateEditResponse.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```string``` | The id of the Template. | | +| `template_id`*_required_ | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateGetResponse.md b/sdks/php/docs/Model/TemplateGetResponse.md index 0aba7b381..6d5d873ef 100644 --- a/sdks/php/docs/Model/TemplateGetResponse.md +++ b/sdks/php/docs/Model/TemplateGetResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse```](TemplateResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateListResponse.md b/sdks/php/docs/Model/TemplateListResponse.md index 9723b1385..8af84267f 100644 --- a/sdks/php/docs/Model/TemplateListResponse.md +++ b/sdks/php/docs/Model/TemplateListResponse.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse[]```](TemplateResponse.md) | List of templates that the API caller has access to. | | +| `templates`*_required_ | [```\Dropbox\Sign\Model\TemplateResponse[]```](TemplateResponse.md) | _t__TemplateListResponse::DESCRIPTION | | | `list_info`*_required_ | [```\Dropbox\Sign\Model\ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponse.md b/sdks/php/docs/Model/TemplateResponse.md index 3a7dc2f03..d469b5bd6 100644 --- a/sdks/php/docs/Model/TemplateResponse.md +++ b/sdks/php/docs/Model/TemplateResponse.md @@ -1,26 +1,26 @@ # # TemplateResponse -Contains information about the templates you and your team have created. +_t__TemplateResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `updated_at` | ```int``` | Time the template was last updated. | | -| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | -| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```array``` | The metadata attached to the template. | | -| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `template_id` | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | +| `title` | ```string``` | _t__TemplateResponse::TITLE | | +| `message` | ```string``` | _t__TemplateResponse::MESSAGE | | +| `updated_at` | ```int``` | _t__TemplateResponse::UPDATED_AT | | +| `is_embedded` | ```bool``` | _t__TemplateResponse::IS_EMBEDDED | | +| `is_creator` | ```bool``` | _t__TemplateResponse::IS_CREATOR | | +| `can_edit` | ```bool``` | _t__TemplateResponse::CAN_EDIT | | +| `is_locked` | ```bool``` | _t__TemplateResponse::IS_LOCKED | | +| `metadata` | ```array``` | _t__TemplateResponse::METADATA | | +| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | _t__TemplateResponse::SIGNER_ROLES | | +| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | _t__TemplateResponse::CC_ROLES | | +| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | _t__TemplateResponse::DOCUMENTS | | +| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseCustomField::DESCRIPTION | | +| `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseNamedFormField::DESCRIPTION | | +| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | _t__TemplateResponse::ACCOUNTS | | +| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseAccount.md b/sdks/php/docs/Model/TemplateResponseAccount.md index fb9563bbc..de6eaebb4 100644 --- a/sdks/php/docs/Model/TemplateResponseAccount.md +++ b/sdks/php/docs/Model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The id of the Account. | | -| `email_address` | ```string``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `account_id` | ```string``` | _t__TemplateResponseAccount::ACCOUNT_ID | | +| `email_address` | ```string``` | _t__TemplateResponseAccount::EMAIL_ADDRESS | | +| `is_locked` | ```bool``` | _t__TemplateResponseAccount::IS_LOCKED | | +| `is_paid_hs` | ```bool``` | _t__TemplateResponseAccount::IS_PAID_HS | | +| `is_paid_hf` | ```bool``` | _t__TemplateResponseAccount::IS_PAID_HF | | | `quotas` | [```\Dropbox\Sign\Model\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseAccountQuota.md b/sdks/php/docs/Model/TemplateResponseAccountQuota.md index 7b106a9ac..1f24a1cd6 100644 --- a/sdks/php/docs/Model/TemplateResponseAccountQuota.md +++ b/sdks/php/docs/Model/TemplateResponseAccountQuota.md @@ -1,14 +1,14 @@ # # TemplateResponseAccountQuota -An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. +_t__TemplateResponseAccountQuota::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left` | ```int``` | API templates remaining. | | -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `templates_left` | ```int``` | _t__TemplateResponseAccountQuota::TEMPLATES_LEFT | | +| `api_signature_requests_left` | ```int``` | _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documents_left` | ```int``` | _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT | | +| `sms_verifications_left` | ```int``` | _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseCCRole.md b/sdks/php/docs/Model/TemplateResponseCCRole.md index 32ad82ef9..b164f0409 100644 --- a/sdks/php/docs/Model/TemplateResponseCCRole.md +++ b/sdks/php/docs/Model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name` | ```string``` | _t__TemplateResponseCCRole::NAME | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocument.md b/sdks/php/docs/Model/TemplateResponseDocument.md index ab0518d3a..5a30961cb 100644 --- a/sdks/php/docs/Model/TemplateResponseDocument.md +++ b/sdks/php/docs/Model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | Name of the associated file. | | -| `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```string``` | _t__TemplateResponseDocument::NAME | | +| `index` | ```int``` | _t__TemplateResponseDocument::INDEX | | +| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | _t__TemplateResponseDocument::FIELD_GROUPS | | +| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseDocumentFormField::DESCRIPTION | | +| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseDocumentCustomField::DESCRIPTION | | +| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | _t__TemplateResponseDocumentStaticField::DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md index 47b5bad52..86c862234 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md @@ -1,20 +1,20 @@ # # TemplateResponseDocumentCustomFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentCustomField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | The unique ID for this field. | | -| `name` | ```string``` | The name of the Custom Field. | | -| `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `api_id` | ```string``` | _t__TemplateResponseDocumentCustomField::API_ID | | +| `name` | ```string``` | _t__TemplateResponseDocumentCustomField::NAME | | +| `signer` | ```string``` | _t__TemplateResponseDocumentCustomField::SIGNER | | +| `x` | ```int``` | _t__TemplateResponseDocumentCustomField::X | | +| `y` | ```int``` | _t__TemplateResponseDocumentCustomField::Y | | +| `width` | ```int``` | _t__TemplateResponseDocumentCustomField::WIDTH | | +| `height` | ```int``` | _t__TemplateResponseDocumentCustomField::HEIGHT | | +| `required` | ```bool``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```string``` | _t__TemplateResponseDocumentCustomField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md index 4b1e53fb0..20f3deca0 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldCheckbox.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentCustomFieldCheckbox -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `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'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentCustomField::TYPE | [default to 'checkbox'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md index 68e40af6b..ba23e1d1d 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md @@ -1,15 +1,15 @@ # # TemplateResponseDocumentCustomFieldText -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentCustomField::TYPE | [default to 'text'] | | `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | +| `is_multiline` | ```bool``` | _t__TemplateResponseDocumentCustomField::IS_MULTILINE | | +| `original_font_size` | ```int``` | _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE | | +| `font_family` | ```string``` | _t__TemplateResponseDocumentCustomField::FONT_FAMILY | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md index 233352654..2e0f6cb3a 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the form field group. | | +| `name` | ```string``` | _t__TemplateResponseDocumentFieldGroup::NAME | | | `rule` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md index ad79e834e..a1220b3a5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFieldGroupRule -The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). +_t__TemplateResponseDocumentFieldGroup::RULE ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `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. | | -| `group_label` | ```string``` | Name of the group | | +| `requirement` | ```string``` | _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT | | +| `group_label` | ```string``` | _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md index f792fdfed..d0aefd0db 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md @@ -1,19 +1,19 @@ # # TemplateResponseDocumentFormFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentFormField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | A unique id for the form field. | | -| `name` | ```string``` | The name of the form field. | | -| `signer` | ```string``` | The signer of the Form Field. | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```string``` | _t__TemplateResponseDocumentFormField::API_ID | | +| `name` | ```string``` | _t__TemplateResponseDocumentFormField::NAME | | +| `signer` | ```string``` | _t__TemplateResponseDocumentFormField::SIGNER | | +| `x` | ```int``` | _t__TemplateResponseDocumentFormField::X | | +| `y` | ```int``` | _t__TemplateResponseDocumentFormField::Y | | +| `width` | ```int``` | _t__TemplateResponseDocumentFormField::WIDTH | | +| `height` | ```int``` | _t__TemplateResponseDocumentFormField::HEIGHT | | +| `required` | ```bool``` | _t__TemplateResponseDocumentFormField::REQUIRED | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md index 2ee1b9e5e..eb129d01a 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldCheckbox -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'checkbox'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md index 8996ce7a3..1d8dab153 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldDateSigned -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'date_signed'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md index 35cadabb5..826798d61 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldDropdown -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'dropdown'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md index ce0ff23b5..0a4fc7ed5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md @@ -1,16 +1,16 @@ # # TemplateResponseDocumentFormFieldHyperlink -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'hyperlink'] | | `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `is_multiline` | ```bool``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `original_font_size` | ```int``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `font_family` | ```string``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md index ab0ccda06..3c5eb1601 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldInitials -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'initials'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md index 3b888caf7..e0955dd1a 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldRadio -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | -| `group`*_required_ | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'radio'] | +| `group`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md index b46f1d963..5fcba3ee9 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md @@ -1,12 +1,12 @@ # # TemplateResponseDocumentFormFieldSignature -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'signature'] | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md index 630c7a032..5e49f6062 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md @@ -1,19 +1,19 @@ # # TemplateResponseDocumentFormFieldText -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'text'] | | `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | -| `validation_type` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | -| `validation_custom_regex` | ```string``` | When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. | | -| `validation_custom_regex_format_label` | ```string``` | When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `is_multiline` | ```bool``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `original_font_size` | ```int``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `font_family` | ```string``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `validation_type` | ```string``` | _t__TemplateResponseDocumentFormField::VALIDATION_TYPE | | +| `validation_custom_regex` | ```string``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX | | +| `validation_custom_regex_format_label` | ```string``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL | | +| `group` | ```string``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md index 3a7a044a4..ab1fdad44 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md @@ -1,20 +1,20 @@ # # TemplateResponseDocumentStaticFieldBase -An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. +_t__TemplateResponseDocumentStaticField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | A unique id for the static field. | | -| `name` | ```string``` | The name of the static field. | | -| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```int``` | The horizontal offset in pixels for this static field. | | -| `y` | ```int``` | The vertical offset in pixels for this static field. | | -| `width` | ```int``` | The width in pixels of this static field. | | -| `height` | ```int``` | The height in pixels of this static field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `api_id` | ```string``` | _t__TemplateResponseDocumentStaticField::API_ID | | +| `name` | ```string``` | _t__TemplateResponseDocumentStaticField::NAME | | +| `signer` | ```string``` | _t__TemplateResponseDocumentStaticField::SIGNER | [default to 'me_now'] | +| `x` | ```int``` | _t__TemplateResponseDocumentStaticField::X | | +| `y` | ```int``` | _t__TemplateResponseDocumentStaticField::Y | | +| `width` | ```int``` | _t__TemplateResponseDocumentStaticField::WIDTH | | +| `height` | ```int``` | _t__TemplateResponseDocumentStaticField::HEIGHT | | +| `required` | ```bool``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```string``` | _t__TemplateResponseDocumentStaticField::GROUP | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md index 4a23cb66b..10a815b37 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldCheckbox.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldCheckbox -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'checkbox'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'checkbox'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md index 9c9d86fb4..d61a4af2b 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDateSigned.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldDateSigned -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'date_signed'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'date_signed'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md index d5cdc36da..337592144 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldDropdown.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldDropdown -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'dropdown'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'dropdown'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md index 304d2e082..99953b4a6 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldHyperlink.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldHyperlink -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'hyperlink'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'hyperlink'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md index 9f112d1f3..044caca87 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldInitials.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldInitials -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'initials'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'initials'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md index 1225138aa..b210f3134 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldRadio.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldRadio -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'radio'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'radio'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md index 661b84cfd..76637edc9 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldSignature.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldSignature -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'signature'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'signature'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md index fa528fb68..be321f68d 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldText.md @@ -1,11 +1,11 @@ # # TemplateResponseDocumentStaticFieldText -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```string``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'text'] | +| `type`*_required_ | ```string``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'text'] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md index b9db83c57..00c2db091 100644 --- a/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md @@ -1,12 +1,12 @@ # # TemplateResponseFieldAvgTextLength -Average text length in this field. +_t__TemplateResponseFieldAvgTextLength::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines` | ```int``` | Number of lines. | | -| `num_chars_per_line` | ```int``` | Number of characters per line. | | +| `num_lines` | ```int``` | _t__TemplateResponseFieldAvgTextLength::NUM_LINES | | +| `num_chars_per_line` | ```int``` | _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseSignerRole.md b/sdks/php/docs/Model/TemplateResponseSignerRole.md index fdf2f15d0..cb84f3016 100644 --- a/sdks/php/docs/Model/TemplateResponseSignerRole.md +++ b/sdks/php/docs/Model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | -| `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | +| `name` | ```string``` | _t__TemplateResponseSignerRole::NAME | | +| `order` | ```int``` | _t__TemplateResponseSignerRole::ORDER | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md index b8fb3f5c2..e9bb38d74 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md @@ -1,12 +1,12 @@ # # TemplateUpdateFilesResponseTemplate -Contains template id +_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `template_id` | ```string``` | _t__TemplateResponse::TEMPLATE_ID | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md index 4d9b2c5c4..1401095e6 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md @@ -12,8 +12,9 @@ Name | Type | Description | Notes | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to true] | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | @@ -27,11 +28,11 @@ Name | Type | Description | Notes | `hold_request` | ```bool``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | | `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | | `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index 1d09deee9..80e3d63e5 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -22,12 +22,12 @@ Name | Type | Description | Notes | `hold_request` | ```bool``` | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | | `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `preview_only` | ```bool``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | [default to false] | | `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature. | | | `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]```](SubUnclaimedDraftTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner[]```](SubUnclaimedDraftTemplateSigner.md) | _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md index afcb4a779..53a88771c 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md @@ -10,7 +10,8 @@ Name | Type | Description | Notes | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | | `client_id` | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -20,9 +21,9 @@ Name | Type | Description | Notes | `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hide_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] | | `message` | ```string``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```array``` | _t__Sub::Metadata::DESCRIPTION | | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```\Dropbox\Sign\Model\SubUnclaimedDraftSigner[]```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md b/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md index 666b4ae1f..9ec4e1d16 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateResponse.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `unclaimed_draft`*_required_ | [```\Dropbox\Sign\Model\UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | -| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftResponse.md b/sdks/php/docs/Model/UnclaimedDraftResponse.md index 36989223b..648942290 100644 --- a/sdks/php/docs/Model/UnclaimedDraftResponse.md +++ b/sdks/php/docs/Model/UnclaimedDraftResponse.md @@ -1,16 +1,16 @@ # # UnclaimedDraftResponse -A group of documents that a user can take ownership of via the claim URL. +_t__UnclaimedDraftResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_request_id` | ```string``` | The ID of the signature request that is represented by this UnclaimedDraft. | | -| `claim_url` | ```string``` | The URL to be used to claim this UnclaimedDraft. | | -| `signing_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully sign. | | -| `requesting_redirect_url` | ```string``` | The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). | | -| `expires_at` | ```int``` | When the link expires. | | -| `test_mode` | ```bool``` | Whether this is a test draft. Signature requests made from test drafts have no legal value. | | +| `signature_request_id` | ```string``` | _t__UnclaimedDraft::SIGNATURE_REQUEST_ID | | +| `claim_url` | ```string``` | _t__UnclaimedDraft::CLAIM_URL | | +| `signing_redirect_url` | ```string``` | _t__UnclaimedDraft::SIGNING_REDIRECT_URL | | +| `requesting_redirect_url` | ```string``` | _t__UnclaimedDraft::REQUESTING_REDIRECT_URL | | +| `expires_at` | ```int``` | _t__UnclaimedDraft::EXPIRES_AT | | +| `test_mode` | ```bool``` | _t__UnclaimedDraft::TEST_MODE | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/WarningResponse.md b/sdks/php/docs/Model/WarningResponse.md index 8bec8a324..fd0d000a0 100644 --- a/sdks/php/docs/Model/WarningResponse.md +++ b/sdks/php/docs/Model/WarningResponse.md @@ -1,12 +1,12 @@ # # WarningResponse -A list of warnings. +_t__WarningResponse::LIST_DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `warning_msg`*_required_ | ```string``` | Warning message | | -| `warning_name`*_required_ | ```string``` | Warning name | | +| `warning_msg`*_required_ | ```string``` | _t__WarningResponse::WARNING_MSG | | +| `warning_name`*_required_ | ```string``` | _t__WarningResponse::WARNING_NAME | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Model/AccountCreateResponse.php b/sdks/php/src/Model/AccountCreateResponse.php index 619bf49a3..2f44cc757 100644 --- a/sdks/php/src/Model/AccountCreateResponse.php +++ b/sdks/php/src/Model/AccountCreateResponse.php @@ -381,7 +381,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/AccountGetResponse.php b/sdks/php/src/Model/AccountGetResponse.php index 5005bc421..7b6a28ed8 100644 --- a/sdks/php/src/Model/AccountGetResponse.php +++ b/sdks/php/src/Model/AccountGetResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/AccountResponse.php b/sdks/php/src/Model/AccountResponse.php index 6c3370ef1..72718e650 100644 --- a/sdks/php/src/Model/AccountResponse.php +++ b/sdks/php/src/Model/AccountResponse.php @@ -378,7 +378,7 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id The ID of the Account + * @param string|null $account_id _t__Account::ACCOUNT_ID * * @return self */ @@ -405,7 +405,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address the email address associated with the Account + * @param string|null $email_address _t__Account::EMAIL_ADDRESS * * @return self */ @@ -432,7 +432,7 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked returns `true` if the user has been locked out of their account by a team admin + * @param bool|null $is_locked _t__Account::IS_LOCKED * * @return self */ @@ -459,7 +459,7 @@ public function getIsPaidHs() /** * Sets is_paid_hs * - * @param bool|null $is_paid_hs returns `true` if the user has a paid Dropbox Sign account + * @param bool|null $is_paid_hs _t__Account::IS_PAID_HS * * @return self */ @@ -486,7 +486,7 @@ public function getIsPaidHf() /** * Sets is_paid_hf * - * @param bool|null $is_paid_hf returns `true` if the user has a paid HelloFax account + * @param bool|null $is_paid_hf _t__Account::IS_PAID_HF * * @return self */ @@ -540,7 +540,7 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url the URL that Dropbox Sign events will `POST` to + * @param string|null $callback_url _t__Account::CALLBACK_URL * * @return self */ @@ -574,7 +574,7 @@ public function getRoleCode() /** * Sets role_code * - * @param string|null $role_code the membership role for the team + * @param string|null $role_code _t__Account::ROLE_CODE * * @return self */ @@ -608,7 +608,7 @@ public function getTeamId() /** * Sets team_id * - * @param string|null $team_id the id of the team account belongs to + * @param string|null $team_id _t__Account::TEAM_ID * * @return self */ @@ -642,7 +642,7 @@ public function getLocale() /** * Sets locale * - * @param string|null $locale 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. + * @param string|null $locale _t__Account::LOCALE * * @return self */ diff --git a/sdks/php/src/Model/AccountResponseQuotas.php b/sdks/php/src/Model/AccountResponseQuotas.php index 119733b99..31b93c5c4 100644 --- a/sdks/php/src/Model/AccountResponseQuotas.php +++ b/sdks/php/src/Model/AccountResponseQuotas.php @@ -36,7 +36,7 @@ * AccountResponseQuotas Class Doc Comment * * @category Class - * @description Details concerning remaining monthly quotas. + * @description _t__Account::QUOTA * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -343,7 +343,7 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining + * @param int|null $api_signature_requests_left _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT * * @return self */ @@ -377,7 +377,7 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left signature requests remaining + * @param int|null $documents_left _t__AccountQuota::DOCUMENTS_LEFT * * @return self */ @@ -411,7 +411,7 @@ public function getTemplatesTotal() /** * Sets templates_total * - * @param int|null $templates_total total API templates allowed + * @param int|null $templates_total _t__AccountQuota::TEMPLATES_TOTAL * * @return self */ @@ -445,7 +445,7 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining + * @param int|null $templates_left _t__AccountQuota::TEMPLATES_LEFT * * @return self */ @@ -479,7 +479,7 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining + * @param int|null $sms_verifications_left _t__AccountQuota::SMS_VERIFICATIONS_LEFT * * @return self */ @@ -513,7 +513,7 @@ public function getNumFaxPagesLeft() /** * Sets num_fax_pages_left * - * @param int|null $num_fax_pages_left Number of fax pages left + * @param int|null $num_fax_pages_left _t__AccountQuota::NUM_FAX_PAGES_LEFT * * @return self */ diff --git a/sdks/php/src/Model/AccountResponseUsage.php b/sdks/php/src/Model/AccountResponseUsage.php index 90cb9bb1c..463ea5814 100644 --- a/sdks/php/src/Model/AccountResponseUsage.php +++ b/sdks/php/src/Model/AccountResponseUsage.php @@ -36,7 +36,7 @@ * AccountResponseUsage Class Doc Comment * * @category Class - * @description Details concerning monthly usage + * @description _t__Account::USAGE * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -308,7 +308,7 @@ public function getFaxPagesSent() /** * Sets fax_pages_sent * - * @param int|null $fax_pages_sent Number of fax pages sent + * @param int|null $fax_pages_sent _t__AccountUsage::FAX_PAGES_SENT * * @return self */ diff --git a/sdks/php/src/Model/AccountVerifyResponse.php b/sdks/php/src/Model/AccountVerifyResponse.php index 359be63d7..1f95f0b42 100644 --- a/sdks/php/src/Model/AccountVerifyResponse.php +++ b/sdks/php/src/Model/AccountVerifyResponse.php @@ -342,7 +342,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/AccountVerifyResponseAccount.php b/sdks/php/src/Model/AccountVerifyResponseAccount.php index 2c4bf22b3..8b96867af 100644 --- a/sdks/php/src/Model/AccountVerifyResponseAccount.php +++ b/sdks/php/src/Model/AccountVerifyResponseAccount.php @@ -308,7 +308,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address the email address associated with the Account + * @param string|null $email_address _t__Account::EMAIL_ADDRESS * * @return self */ diff --git a/sdks/php/src/Model/ApiAppCreateRequest.php b/sdks/php/src/Model/ApiAppCreateRequest.php index c6d0cc9a9..39c1c9ace 100644 --- a/sdks/php/src/Model/ApiAppCreateRequest.php +++ b/sdks/php/src/Model/ApiAppCreateRequest.php @@ -329,8 +329,8 @@ public function listInvalidProperties() if ($this->container['domains'] === null) { $invalidProperties[] = "'domains' can't be null"; } - if (count($this->container['domains']) > 2) { - $invalidProperties[] = "invalid value for 'domains', number of items must be less than or equal to 2."; + if (count($this->container['domains']) > 10) { + $invalidProperties[] = "invalid value for 'domains', number of items must be less than or equal to 10."; } if (count($this->container['domains']) < 1) { @@ -377,8 +377,8 @@ public function setDomains(array $domains) throw new InvalidArgumentException('non-nullable domains cannot be null'); } - if (count($domains) > 2) { - throw new InvalidArgumentException('invalid value for $domains when calling ApiAppCreateRequest., number of items must be less than or equal to 2.'); + if (count($domains) > 10) { + throw new InvalidArgumentException('invalid value for $domains when calling ApiAppCreateRequest., number of items must be less than or equal to 10.'); } if (count($domains) < 1) { throw new InvalidArgumentException('invalid length for $domains when calling ApiAppCreateRequest., number of items must be greater than or equal to 1.'); diff --git a/sdks/php/src/Model/ApiAppGetResponse.php b/sdks/php/src/Model/ApiAppGetResponse.php index 3d9dc5d0a..b15fcfcec 100644 --- a/sdks/php/src/Model/ApiAppGetResponse.php +++ b/sdks/php/src/Model/ApiAppGetResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/ApiAppListResponse.php b/sdks/php/src/Model/ApiAppListResponse.php index 02e2483e9..54617655c 100644 --- a/sdks/php/src/Model/ApiAppListResponse.php +++ b/sdks/php/src/Model/ApiAppListResponse.php @@ -330,7 +330,7 @@ public function getApiApps() /** * Sets api_apps * - * @param ApiAppResponse[] $api_apps contains information about API Apps + * @param ApiAppResponse[] $api_apps _t__ApiAppListResponse::DESCRIPTION * * @return self */ @@ -384,7 +384,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/ApiAppResponse.php b/sdks/php/src/Model/ApiAppResponse.php index c283d86fb..cc1f9b62e 100644 --- a/sdks/php/src/Model/ApiAppResponse.php +++ b/sdks/php/src/Model/ApiAppResponse.php @@ -37,7 +37,7 @@ * ApiAppResponse Class Doc Comment * * @category Class - * @description Contains information about an API App. + * @description _t__ApiAppResponse::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -372,7 +372,7 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url The app's callback URL (for events) + * @param string|null $callback_url _t__ApiAppResponse::CALLBACK_URL * * @return self */ @@ -406,7 +406,7 @@ public function getClientId() /** * Sets client_id * - * @param string|null $client_id The app's client id + * @param string|null $client_id _t__ApiAppResponse::CLIENT_ID * * @return self */ @@ -433,7 +433,7 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at The time that the app was created + * @param int|null $created_at _t__ApiAppResponse::CREATED_AT * * @return self */ @@ -460,7 +460,7 @@ public function getDomains() /** * Sets domains * - * @param string[]|null $domains The domain name(s) associated with the app + * @param string[]|null $domains _t__ApiAppResponse::DOMAINS * * @return self */ @@ -487,7 +487,7 @@ public function getName() /** * Sets name * - * @param string|null $name The name of the app + * @param string|null $name _t__ApiAppResponse::NAME * * @return self */ @@ -514,7 +514,7 @@ public function getIsApproved() /** * Sets is_approved * - * @param bool|null $is_approved Boolean to indicate if the app has been approved + * @param bool|null $is_approved _t__ApiAppResponse::IS_APPROVED * * @return self */ diff --git a/sdks/php/src/Model/ApiAppResponseOAuth.php b/sdks/php/src/Model/ApiAppResponseOAuth.php index 6c84b43c6..557d634f5 100644 --- a/sdks/php/src/Model/ApiAppResponseOAuth.php +++ b/sdks/php/src/Model/ApiAppResponseOAuth.php @@ -37,7 +37,7 @@ * ApiAppResponseOAuth Class Doc Comment * * @category Class - * @description An object describing the app's OAuth properties, or null if OAuth is not configured for the app. + * @description _t__ApiAppResponseOAuth::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -330,7 +330,7 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url the app's OAuth callback URL + * @param string|null $callback_url _t__ApiAppResponseOAuth::CALLBACK_URL * * @return self */ @@ -357,7 +357,7 @@ public function getSecret() /** * Sets secret * - * @param string|null $secret the app's OAuth secret, or null if the app does not belong to user + * @param string|null $secret _t__ApiAppResponseOAuth::SECRET * * @return self */ @@ -391,7 +391,7 @@ public function getScopes() /** * Sets scopes * - * @param string[]|null $scopes array of OAuth scopes used by the app + * @param string[]|null $scopes _t__ApiAppResponseOAuth::SCOPES * * @return self */ @@ -418,7 +418,7 @@ public function getChargesUsers() /** * Sets charges_users * - * @param bool|null $charges_users boolean indicating whether the app owner or the account granting permission is billed for OAuth requests + * @param bool|null $charges_users _t__ApiAppResponseOAuth::CHARGES_USERS * * @return self */ diff --git a/sdks/php/src/Model/ApiAppResponseOptions.php b/sdks/php/src/Model/ApiAppResponseOptions.php index 46466cb77..37c4ed46d 100644 --- a/sdks/php/src/Model/ApiAppResponseOptions.php +++ b/sdks/php/src/Model/ApiAppResponseOptions.php @@ -37,7 +37,7 @@ * ApiAppResponseOptions Class Doc Comment * * @category Class - * @description An object with options that override account settings. + * @description _t__ApiAppResponseOptions::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -309,7 +309,7 @@ public function getCanInsertEverywhere() /** * Sets can_insert_everywhere * - * @param bool|null $can_insert_everywhere Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document + * @param bool|null $can_insert_everywhere _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE * * @return self */ diff --git a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php index db9e8e0a0..c5233e0a5 100644 --- a/sdks/php/src/Model/ApiAppResponseOwnerAccount.php +++ b/sdks/php/src/Model/ApiAppResponseOwnerAccount.php @@ -37,7 +37,7 @@ * ApiAppResponseOwnerAccount Class Doc Comment * * @category Class - * @description An object describing the app's owner + * @description _t__ApiAppResponseOwnerAccount::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -316,7 +316,7 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id The owner account's ID + * @param string|null $account_id _t__ApiAppResponseOwnerAccount::ACCOUNT_ID * * @return self */ @@ -343,7 +343,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address The owner account's email address + * @param string|null $email_address _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS * * @return self */ diff --git a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php index b010c59f0..d61f9c57d 100644 --- a/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php +++ b/sdks/php/src/Model/ApiAppResponseWhiteLabelingOptions.php @@ -37,7 +37,7 @@ * ApiAppResponseWhiteLabelingOptions Class Doc Comment * * @category Class - * @description An object with options to customize the app's signer page + * @description _t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ diff --git a/sdks/php/src/Model/ApiAppUpdateRequest.php b/sdks/php/src/Model/ApiAppUpdateRequest.php index 323f28d52..54f0a8c4e 100644 --- a/sdks/php/src/Model/ApiAppUpdateRequest.php +++ b/sdks/php/src/Model/ApiAppUpdateRequest.php @@ -326,8 +326,8 @@ public function listInvalidProperties() { $invalidProperties = []; - if (!is_null($this->container['domains']) && (count($this->container['domains']) > 2)) { - $invalidProperties[] = "invalid value for 'domains', number of items must be less than or equal to 2."; + if (!is_null($this->container['domains']) && (count($this->container['domains']) > 10)) { + $invalidProperties[] = "invalid value for 'domains', number of items must be less than or equal to 10."; } return $invalidProperties; @@ -421,8 +421,8 @@ public function setDomains(?array $domains) throw new InvalidArgumentException('non-nullable domains cannot be null'); } - if (count($domains) > 2) { - throw new InvalidArgumentException('invalid value for $domains when calling ApiAppUpdateRequest., number of items must be less than or equal to 2.'); + if (count($domains) > 10) { + throw new InvalidArgumentException('invalid value for $domains when calling ApiAppUpdateRequest., number of items must be less than or equal to 10.'); } $this->container['domains'] = $domains; diff --git a/sdks/php/src/Model/BulkSendJobGetResponse.php b/sdks/php/src/Model/BulkSendJobGetResponse.php index a0699b46f..bcaf2d6fb 100644 --- a/sdks/php/src/Model/BulkSendJobGetResponse.php +++ b/sdks/php/src/Model/BulkSendJobGetResponse.php @@ -394,7 +394,7 @@ public function getSignatureRequests() /** * Sets signature_requests * - * @param BulkSendJobGetResponseSignatureRequests[] $signature_requests contains information about the Signature Requests sent in bulk + * @param BulkSendJobGetResponseSignatureRequests[] $signature_requests _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS * * @return self */ @@ -421,7 +421,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php b/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php index a68be1c16..0dd98b0bf 100644 --- a/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php +++ b/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php @@ -476,7 +476,7 @@ public function getTestMode() /** * Sets test_mode * - * @param bool|null $test_mode Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + * @param bool|null $test_mode _t__SignatureRequestResponse::TEST_MODE * * @return self */ @@ -503,7 +503,7 @@ public function getSignatureRequestId() /** * Sets signature_request_id * - * @param string|null $signature_request_id the id of the SignatureRequest + * @param string|null $signature_request_id _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID * * @return self */ @@ -530,7 +530,7 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string|null $requester_email_address the email address of the initiator of the SignatureRequest + * @param string|null $requester_email_address _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS * * @return self */ @@ -564,7 +564,7 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title the specified Account uses for the SignatureRequest + * @param string|null $title _t__SignatureRequestResponse::TITLE * * @return self */ @@ -591,7 +591,7 @@ public function getOriginalTitle() /** * Sets original_title * - * @param string|null $original_title default Label for account + * @param string|null $original_title _t__SignatureRequestResponse::ORIGINAL_TITLE * * @return self */ @@ -618,7 +618,7 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that was initially sent to the signers + * @param string|null $subject _t__SignatureRequestResponse::SUBJECT * * @return self */ @@ -652,7 +652,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that was initially sent to the signers + * @param string|null $message _t__SignatureRequestResponse::MESSAGE * * @return self */ @@ -686,7 +686,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata the metadata attached to the signature request + * @param array|null $metadata _t__SignatureRequestResponse::METADATA * * @return self */ @@ -713,7 +713,7 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at time the signature request was created + * @param int|null $created_at _t__SignatureRequestResponse::CREATED_AT * * @return self */ @@ -740,7 +740,7 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * @param int|null $expires_at _t__SignatureRequestResponse::EXPIRES_AT * * @return self */ @@ -774,7 +774,7 @@ public function getIsComplete() /** * Sets is_complete * - * @param bool|null $is_complete whether or not the SignatureRequest has been fully executed by all signers + * @param bool|null $is_complete _t__SignatureRequestResponse::IS_COMPLETE * * @return self */ @@ -801,7 +801,7 @@ public function getIsDeclined() /** * Sets is_declined * - * @param bool|null $is_declined whether or not the SignatureRequest has been declined by a signer + * @param bool|null $is_declined _t__SignatureRequestResponse::IS_DECLINED * * @return self */ @@ -828,7 +828,7 @@ public function getHasError() /** * Sets has_error * - * @param bool|null $has_error whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings) + * @param bool|null $has_error _t__SignatureRequestResponse::HAS_ERROR * * @return self */ @@ -855,7 +855,7 @@ public function getFilesUrl() /** * Sets files_url * - * @param string|null $files_url the URL where a copy of the request's documents can be downloaded + * @param string|null $files_url _t__SignatureRequestResponse::FILES_URL * * @return self */ @@ -882,7 +882,7 @@ public function getSigningUrl() /** * Sets signing_url * - * @param string|null $signing_url The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + * @param string|null $signing_url _t__SignatureRequestResponse::SIGNING_URL * * @return self */ @@ -916,7 +916,7 @@ public function getDetailsUrl() /** * Sets details_url * - * @param string|null $details_url the URL where the requester and the signers can view the current status of the SignatureRequest + * @param string|null $details_url _t__SignatureRequestResponse::DETAILS_URL * * @return self */ @@ -943,7 +943,7 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + * @param string[]|null $cc_email_addresses _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES * * @return self */ @@ -970,7 +970,7 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want the signer redirected to after they successfully sign + * @param string|null $signing_redirect_url _t__SignatureRequestResponse::SIGNING_REDIRECT_URL * * @return self */ @@ -1004,7 +1004,7 @@ public function getFinalCopyUri() /** * Sets final_copy_uri * - * @param string|null $final_copy_uri The path where the completed document can be downloaded + * @param string|null $final_copy_uri _t__SignatureRequestResponse::FINAL_COPY_URI * * @return self */ @@ -1038,7 +1038,7 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[]|null $template_ids templates IDs used in this SignatureRequest (if any) + * @param string[]|null $template_ids _t__SignatureRequestResponse::TEMPLATE_IDS * * @return self */ @@ -1072,7 +1072,7 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * @param SignatureRequestResponseCustomFieldBase[]|null $custom_fields _t__SignatureRequestResponseCustomField::DESCRIPTION * * @return self */ @@ -1106,7 +1106,7 @@ public function getAttachments() /** * Sets attachments * - * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments + * @param SignatureRequestResponseAttachment[]|null $attachments _t__SignatureRequestResponseAttachment::DESCRIPTION * * @return self */ @@ -1140,7 +1140,7 @@ public function getResponseData() /** * Sets response_data * - * @param SignatureRequestResponseDataBase[]|null $response_data an array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers + * @param SignatureRequestResponseDataBase[]|null $response_data _t__SignatureRequestResponseData::DESCRIPTION * * @return self */ @@ -1174,7 +1174,7 @@ public function getSignatures() /** * Sets signatures * - * @param SignatureRequestResponseSignatures[]|null $signatures an array of signature objects, 1 for each signer + * @param SignatureRequestResponseSignatures[]|null $signatures _t__SignatureRequestResponseSignatures::DESCRIPTION * * @return self */ @@ -1201,7 +1201,7 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id the id of the BulkSendJob + * @param string|null $bulk_send_job_id _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID * * @return self */ diff --git a/sdks/php/src/Model/BulkSendJobListResponse.php b/sdks/php/src/Model/BulkSendJobListResponse.php index ee12f4f40..f2fcbd823 100644 --- a/sdks/php/src/Model/BulkSendJobListResponse.php +++ b/sdks/php/src/Model/BulkSendJobListResponse.php @@ -330,7 +330,7 @@ public function getBulkSendJobs() /** * Sets bulk_send_jobs * - * @param BulkSendJobResponse[] $bulk_send_jobs contains a list of BulkSendJobs that the API caller has access to + * @param BulkSendJobResponse[] $bulk_send_jobs _t__BulkSendJobListResponse::BULK_SEND_JOBS * * @return self */ @@ -384,7 +384,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/BulkSendJobResponse.php b/sdks/php/src/Model/BulkSendJobResponse.php index 987a9bd02..d679a7179 100644 --- a/sdks/php/src/Model/BulkSendJobResponse.php +++ b/sdks/php/src/Model/BulkSendJobResponse.php @@ -37,7 +37,7 @@ * BulkSendJobResponse Class Doc Comment * * @category Class - * @description Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. + * @description _t__BulkSendJobResponse::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -330,7 +330,7 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id the id of the BulkSendJob + * @param string|null $bulk_send_job_id _t__BulkSendJobResponse::BULK_SEND_JOB_ID * * @return self */ @@ -364,7 +364,7 @@ public function getTotal() /** * Sets total * - * @param int|null $total the total amount of Signature Requests queued for sending + * @param int|null $total _t__BulkSendJobResponse::TOTAL * * @return self */ @@ -391,7 +391,7 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool|null $is_creator true if you are the owner of this BulkSendJob, false if it's been shared with you by a team member + * @param bool|null $is_creator _t__BulkSendJobResponse::IS_CREATOR * * @return self */ @@ -418,7 +418,7 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at time that the BulkSendJob was created + * @param int|null $created_at _t__BulkSendJobResponse::CREATED_AT * * @return self */ diff --git a/sdks/php/src/Model/BulkSendJobSendResponse.php b/sdks/php/src/Model/BulkSendJobSendResponse.php index 945a1a518..2f376cbb8 100644 --- a/sdks/php/src/Model/BulkSendJobSendResponse.php +++ b/sdks/php/src/Model/BulkSendJobSendResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/EmbeddedEditUrlRequest.php b/sdks/php/src/Model/EmbeddedEditUrlRequest.php index d5252f0e2..c372c822a 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlRequest.php +++ b/sdks/php/src/Model/EmbeddedEditUrlRequest.php @@ -58,6 +58,7 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali */ protected static $openAPITypes = [ 'allow_edit_ccs' => 'bool', + 'allow_form_view' => 'bool', 'cc_roles' => 'string[]', 'editor_options' => '\Dropbox\Sign\Model\SubEditorOptions', 'force_signer_roles' => 'bool', @@ -78,6 +79,7 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali */ protected static $openAPIFormats = [ 'allow_edit_ccs' => null, + 'allow_form_view' => null, 'cc_roles' => null, 'editor_options' => null, 'force_signer_roles' => null, @@ -96,6 +98,7 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali */ protected static array $openAPINullables = [ 'allow_edit_ccs' => false, + 'allow_form_view' => false, 'cc_roles' => false, 'editor_options' => false, 'force_signer_roles' => false, @@ -186,6 +189,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'allow_edit_ccs' => 'allow_edit_ccs', + 'allow_form_view' => 'allow_form_view', 'cc_roles' => 'cc_roles', 'editor_options' => 'editor_options', 'force_signer_roles' => 'force_signer_roles', @@ -204,6 +208,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'allow_edit_ccs' => 'setAllowEditCcs', + 'allow_form_view' => 'setAllowFormView', 'cc_roles' => 'setCcRoles', 'editor_options' => 'setEditorOptions', 'force_signer_roles' => 'setForceSignerRoles', @@ -222,6 +227,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'allow_edit_ccs' => 'getAllowEditCcs', + 'allow_form_view' => 'getAllowFormView', 'cc_roles' => 'getCcRoles', 'editor_options' => 'getEditorOptions', 'force_signer_roles' => 'getForceSignerRoles', @@ -290,6 +296,7 @@ public function getModelName() public function __construct(?array $data = null) { $this->setIfExists('allow_edit_ccs', $data ?? [], false); + $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('editor_options', $data ?? [], null); $this->setIfExists('force_signer_roles', $data ?? [], false); @@ -385,6 +392,33 @@ public function setAllowEditCcs(?bool $allow_edit_ccs) return $this; } + /** + * Gets allow_form_view + * + * @return bool|null + */ + public function getAllowFormView() + { + return $this->container['allow_form_view']; + } + + /** + * Sets allow_form_view + * + * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowFormView(?bool $allow_form_view) + { + if (is_null($allow_form_view)) { + throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + } + $this->container['allow_form_view'] = $allow_form_view; + + return $this; + } + /** * Gets cc_roles * diff --git a/sdks/php/src/Model/EmbeddedEditUrlResponse.php b/sdks/php/src/Model/EmbeddedEditUrlResponse.php index 865768dd7..5ed2f8aaa 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlResponse.php +++ b/sdks/php/src/Model/EmbeddedEditUrlResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php b/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php index bda80cfb8..261ba0b77 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php +++ b/sdks/php/src/Model/EmbeddedEditUrlResponseEmbedded.php @@ -37,7 +37,7 @@ * EmbeddedEditUrlResponseEmbedded Class Doc Comment * * @category Class - * @description An embedded template object. + * @description _t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -316,7 +316,7 @@ public function getEditUrl() /** * Sets edit_url * - * @param string|null $edit_url a template url that can be opened in an iFrame + * @param string|null $edit_url _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL * * @return self */ @@ -343,7 +343,7 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at the specific time that the the `edit_url` link expires, in epoch + * @param int|null $expires_at _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT * * @return self */ diff --git a/sdks/php/src/Model/EmbeddedSignUrlResponse.php b/sdks/php/src/Model/EmbeddedSignUrlResponse.php index 8b2c9af81..d9612059b 100644 --- a/sdks/php/src/Model/EmbeddedSignUrlResponse.php +++ b/sdks/php/src/Model/EmbeddedSignUrlResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php b/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php index 54fffcbc2..ef5c7e5c4 100644 --- a/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php +++ b/sdks/php/src/Model/EmbeddedSignUrlResponseEmbedded.php @@ -37,7 +37,7 @@ * EmbeddedSignUrlResponseEmbedded Class Doc Comment * * @category Class - * @description An object that contains necessary information to set up embedded signing. + * @description _t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -316,7 +316,7 @@ public function getSignUrl() /** * Sets sign_url * - * @param string|null $sign_url a signature url that can be opened in an iFrame + * @param string|null $sign_url _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL * * @return self */ @@ -343,7 +343,7 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at the specific time that the the `sign_url` link expires, in epoch + * @param int|null $expires_at _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT * * @return self */ diff --git a/sdks/php/src/Model/ErrorResponseError.php b/sdks/php/src/Model/ErrorResponseError.php index 6bb4b8620..1e4be8e80 100644 --- a/sdks/php/src/Model/ErrorResponseError.php +++ b/sdks/php/src/Model/ErrorResponseError.php @@ -37,7 +37,7 @@ * ErrorResponseError Class Doc Comment * * @category Class - * @description Contains information about an error that occurred. + * @description _t__ErrorResponseError::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -331,7 +331,7 @@ public function getErrorMsg() /** * Sets error_msg * - * @param string $error_msg message describing an error + * @param string $error_msg _t__ErrorResponseError::ERROR_MSG * * @return self */ @@ -358,7 +358,7 @@ public function getErrorName() /** * Sets error_name * - * @param string $error_name name of the error + * @param string $error_name _t__ErrorResponseError::ERROR_NAME * * @return self */ @@ -385,7 +385,7 @@ public function getErrorPath() /** * Sets error_path * - * @param string|null $error_path path at which an error occurred + * @param string|null $error_path _t__ErrorResponseError::ERROR_PATH * * @return self */ diff --git a/sdks/php/src/Model/EventCallbackRequestEvent.php b/sdks/php/src/Model/EventCallbackRequestEvent.php index 2501307ce..e86a987fa 100644 --- a/sdks/php/src/Model/EventCallbackRequestEvent.php +++ b/sdks/php/src/Model/EventCallbackRequestEvent.php @@ -37,7 +37,7 @@ * EventCallbackRequestEvent Class Doc Comment * * @category Class - * @description Basic information about the event that occurred. + * @description _t__EventCallbackRequestEvent::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -408,7 +408,7 @@ public function getEventTime() /** * Sets event_time * - * @param string $event_time time the event was created (using Unix time) + * @param string $event_time _t__EventCallbackRequestEvent::EVENT_TIME * * @return self */ @@ -435,7 +435,7 @@ public function getEventType() /** * Sets event_type * - * @param string $event_type type of callback event that was triggered + * @param string $event_type _t__EventCallbackRequestEvent::EVENT_TYPE * * @return self */ @@ -472,7 +472,7 @@ public function getEventHash() /** * Sets event_hash * - * @param string $event_hash generated hash used to verify source of event data + * @param string $event_hash _t__EventCallbackRequestEvent::EVENT_HASH * * @return self */ diff --git a/sdks/php/src/Model/EventCallbackRequestEventMetadata.php b/sdks/php/src/Model/EventCallbackRequestEventMetadata.php index 9116a543c..fd0a7ee51 100644 --- a/sdks/php/src/Model/EventCallbackRequestEventMetadata.php +++ b/sdks/php/src/Model/EventCallbackRequestEventMetadata.php @@ -36,7 +36,7 @@ * EventCallbackRequestEventMetadata Class Doc Comment * * @category Class - * @description Specific metadata about the event. + * @description _t__EventCallbackRequestEventMetadata::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -329,7 +329,7 @@ public function getRelatedSignatureId() /** * Sets related_signature_id * - * @param string|null $related_signature_id Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. + * @param string|null $related_signature_id _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID * * @return self */ @@ -363,7 +363,7 @@ public function getReportedForAccountId() /** * Sets reported_for_account_id * - * @param string|null $reported_for_account_id account ID the event was reported for + * @param string|null $reported_for_account_id _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID * * @return self */ @@ -397,7 +397,7 @@ public function getReportedForAppId() /** * Sets reported_for_app_id * - * @param string|null $reported_for_app_id app ID the event was reported for + * @param string|null $reported_for_app_id _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID * * @return self */ @@ -431,7 +431,7 @@ public function getEventMessage() /** * Sets event_message * - * @param string|null $event_message message about a declined or failed (due to error) signature flow + * @param string|null $event_message _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE * * @return self */ diff --git a/sdks/php/src/Model/FaxGetResponse.php b/sdks/php/src/Model/FaxGetResponse.php index ee85f3d1d..4e056c14f 100644 --- a/sdks/php/src/Model/FaxGetResponse.php +++ b/sdks/php/src/Model/FaxGetResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/FileResponse.php b/sdks/php/src/Model/FileResponse.php index 82f84a632..ab0ce8c67 100644 --- a/sdks/php/src/Model/FileResponse.php +++ b/sdks/php/src/Model/FileResponse.php @@ -323,7 +323,7 @@ public function getFileUrl() /** * Sets file_url * - * @param string $file_url URL to the file + * @param string $file_url _t__FileResponse::FILE_URL * * @return self */ @@ -350,7 +350,7 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int $expires_at when the link expires + * @param int $expires_at _t__FileResponse::EXPIRES_AT * * @return self */ diff --git a/sdks/php/src/Model/FileResponseDataUri.php b/sdks/php/src/Model/FileResponseDataUri.php index 98e37dda6..148ef7896 100644 --- a/sdks/php/src/Model/FileResponseDataUri.php +++ b/sdks/php/src/Model/FileResponseDataUri.php @@ -313,7 +313,7 @@ public function getDataUri() /** * Sets data_uri * - * @param string $data_uri file as base64 encoded string + * @param string $data_uri _t__FileResponse::DATA_URI * * @return self */ diff --git a/sdks/php/src/Model/ListInfoResponse.php b/sdks/php/src/Model/ListInfoResponse.php index a036c6d06..06c575fc9 100644 --- a/sdks/php/src/Model/ListInfoResponse.php +++ b/sdks/php/src/Model/ListInfoResponse.php @@ -37,7 +37,7 @@ * ListInfoResponse Class Doc Comment * * @category Class - * @description Contains pagination information about the data returned. + * @description _t__ListInfoResponse::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -330,7 +330,7 @@ public function getNumPages() /** * Sets num_pages * - * @param int|null $num_pages total number of pages available + * @param int|null $num_pages _t__ListInfoResponse::NUM_PAGES * * @return self */ @@ -357,7 +357,7 @@ public function getNumResults() /** * Sets num_results * - * @param int|null $num_results total number of objects available + * @param int|null $num_results _t__ListInfoResponse::NUM_RESULTS * * @return self */ @@ -391,7 +391,7 @@ public function getPage() /** * Sets page * - * @param int|null $page number of the page being returned + * @param int|null $page _t__ListInfoResponse::PAGE * * @return self */ @@ -418,7 +418,7 @@ public function getPageSize() /** * Sets page_size * - * @param int|null $page_size objects returned per page + * @param int|null $page_size _t__ListInfoResponse::PAGE_SIZE * * @return self */ diff --git a/sdks/php/src/Model/OAuthTokenResponse.php b/sdks/php/src/Model/OAuthTokenResponse.php index 72b899309..87f23fb4d 100644 --- a/sdks/php/src/Model/OAuthTokenResponse.php +++ b/sdks/php/src/Model/OAuthTokenResponse.php @@ -417,7 +417,7 @@ public function getExpiresIn() /** * Sets expires_in * - * @param int|null $expires_in Number of seconds until the `access_token` expires. Uses epoch time. + * @param int|null $expires_in _t__OAuthTokenResponse::EXPIRES_IN * * @return self */ diff --git a/sdks/php/src/Model/ReportCreateRequest.php b/sdks/php/src/Model/ReportCreateRequest.php index f2aefab1b..58af6688d 100644 --- a/sdks/php/src/Model/ReportCreateRequest.php +++ b/sdks/php/src/Model/ReportCreateRequest.php @@ -234,6 +234,7 @@ public function getModelName() public const REPORT_TYPE_USER_ACTIVITY = 'user_activity'; public const REPORT_TYPE_DOCUMENT_STATUS = 'document_status'; + public const REPORT_TYPE_SMS_ACTIVITY = 'sms_activity'; /** * Gets allowable values of the enum @@ -245,6 +246,7 @@ public function getReportTypeAllowableValues() return [ self::REPORT_TYPE_USER_ACTIVITY, self::REPORT_TYPE_DOCUMENT_STATUS, + self::REPORT_TYPE_SMS_ACTIVITY, ]; } diff --git a/sdks/php/src/Model/ReportCreateResponse.php b/sdks/php/src/Model/ReportCreateResponse.php index bc712c962..1850b1644 100644 --- a/sdks/php/src/Model/ReportCreateResponse.php +++ b/sdks/php/src/Model/ReportCreateResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/ReportResponse.php b/sdks/php/src/Model/ReportResponse.php index 537eb9293..438bb3475 100644 --- a/sdks/php/src/Model/ReportResponse.php +++ b/sdks/php/src/Model/ReportResponse.php @@ -37,7 +37,7 @@ * ReportResponse Class Doc Comment * * @category Class - * @description Contains information about the report request. + * @description _t__ReportResponse::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -241,6 +241,7 @@ public function getModelName() public const REPORT_TYPE_USER_ACTIVITY = 'user_activity'; public const REPORT_TYPE_DOCUMENT_STATUS = 'document_status'; + public const REPORT_TYPE_SMS_ACTIVITY = 'sms_activity'; /** * Gets allowable values of the enum @@ -252,6 +253,7 @@ public function getReportTypeAllowableValues() return [ self::REPORT_TYPE_USER_ACTIVITY, self::REPORT_TYPE_DOCUMENT_STATUS, + self::REPORT_TYPE_SMS_ACTIVITY, ]; } @@ -346,7 +348,7 @@ public function getSuccess() /** * Sets success * - * @param string|null $success A message indicating the requested operation's success + * @param string|null $success _t__ReportResponse::SUCCESS * * @return self */ @@ -373,7 +375,7 @@ public function getStartDate() /** * Sets start_date * - * @param string|null $start_date the (inclusive) start date for the report data in MM/DD/YYYY format + * @param string|null $start_date _t__ReportResponse::START_DATE * * @return self */ @@ -400,7 +402,7 @@ public function getEndDate() /** * Sets end_date * - * @param string|null $end_date the (inclusive) end date for the report data in MM/DD/YYYY format + * @param string|null $end_date _t__ReportResponse::END_DATE * * @return self */ @@ -427,7 +429,7 @@ public function getReportType() /** * Sets report_type * - * @param string[]|null $report_type 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). + * @param string[]|null $report_type _t__ReportResponse::REPORT_TYPE * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php index 1874fd232..754290e41 100644 --- a/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.php @@ -633,7 +633,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php index 1e85b4445..6b9e2f683 100644 --- a/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestBulkSendWithTemplateRequest.php @@ -630,7 +630,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php index badc3ea00..61c89e717 100644 --- a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php @@ -64,6 +64,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', 'allow_decline' => 'bool', + 'allow_form_view' => 'bool', 'allow_reassign' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', @@ -98,6 +99,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'signers' => null, 'grouped_signers' => null, 'allow_decline' => null, + 'allow_form_view' => null, 'allow_reassign' => null, 'attachments' => null, 'cc_email_addresses' => 'email', @@ -130,6 +132,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'signers' => false, 'grouped_signers' => false, 'allow_decline' => false, + 'allow_form_view' => false, 'allow_reassign' => false, 'attachments' => false, 'cc_email_addresses' => false, @@ -234,6 +237,7 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'signers', 'grouped_signers' => 'grouped_signers', 'allow_decline' => 'allow_decline', + 'allow_form_view' => 'allow_form_view', 'allow_reassign' => 'allow_reassign', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', @@ -266,6 +270,7 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'setSigners', 'grouped_signers' => 'setGroupedSigners', 'allow_decline' => 'setAllowDecline', + 'allow_form_view' => 'setAllowFormView', 'allow_reassign' => 'setAllowReassign', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', @@ -298,6 +303,7 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'getSigners', 'grouped_signers' => 'getGroupedSigners', 'allow_decline' => 'getAllowDecline', + 'allow_form_view' => 'getAllowFormView', 'allow_reassign' => 'getAllowReassign', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', @@ -380,6 +386,7 @@ public function __construct(?array $data = null) $this->setIfExists('signers', $data ?? [], null); $this->setIfExists('grouped_signers', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); + $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); @@ -568,7 +575,7 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestSigner[]|null $signers _t__Sub::SignatureRequestSigner::DESCRIPTION * * @return self */ @@ -595,7 +602,7 @@ public function getGroupedSigners() /** * Sets grouped_signers * - * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * * @return self */ @@ -636,6 +643,33 @@ public function setAllowDecline(?bool $allow_decline) return $this; } + /** + * Gets allow_form_view + * + * @return bool|null + */ + public function getAllowFormView() + { + return $this->container['allow_form_view']; + } + + /** + * Sets allow_form_view + * + * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowFormView(?bool $allow_form_view) + { + if (is_null($allow_form_view)) { + throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + } + $this->container['allow_form_view'] = $allow_form_view; + + return $this; + } + /** * Gets allow_reassign * @@ -676,7 +710,7 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments _t__SubAttachment::LIST_DESCRIPTION * * @return self */ @@ -923,7 +957,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php index 4f5b84e26..64ed0aeca 100644 --- a/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php @@ -484,7 +484,7 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request + * @param SubSignatureRequestTemplateSigner[] $signers _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * * @return self */ @@ -677,7 +677,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php index cb0190f9c..f020bcd8a 100644 --- a/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php @@ -64,6 +64,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', 'allow_decline' => 'bool', + 'allow_form_view' => 'bool', 'allow_reassign' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', @@ -98,6 +99,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'signers' => null, 'grouped_signers' => null, 'allow_decline' => null, + 'allow_form_view' => null, 'allow_reassign' => null, 'attachments' => null, 'cc_email_addresses' => 'email', @@ -130,6 +132,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'signers' => false, 'grouped_signers' => false, 'allow_decline' => false, + 'allow_form_view' => false, 'allow_reassign' => false, 'attachments' => false, 'cc_email_addresses' => false, @@ -234,6 +237,7 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'signers', 'grouped_signers' => 'grouped_signers', 'allow_decline' => 'allow_decline', + 'allow_form_view' => 'allow_form_view', 'allow_reassign' => 'allow_reassign', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', @@ -266,6 +270,7 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'setSigners', 'grouped_signers' => 'setGroupedSigners', 'allow_decline' => 'setAllowDecline', + 'allow_form_view' => 'setAllowFormView', 'allow_reassign' => 'setAllowReassign', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', @@ -298,6 +303,7 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'getSigners', 'grouped_signers' => 'getGroupedSigners', 'allow_decline' => 'getAllowDecline', + 'allow_form_view' => 'getAllowFormView', 'allow_reassign' => 'getAllowReassign', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', @@ -380,6 +386,7 @@ public function __construct(?array $data = null) $this->setIfExists('signers', $data ?? [], null); $this->setIfExists('grouped_signers', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); + $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); @@ -568,7 +575,7 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestSigner[]|null $signers _t__Sub::SignatureRequestSigner::DESCRIPTION * * @return self */ @@ -595,7 +602,7 @@ public function getGroupedSigners() /** * Sets grouped_signers * - * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * * @return self */ @@ -636,6 +643,33 @@ public function setAllowDecline(?bool $allow_decline) return $this; } + /** + * Gets allow_form_view + * + * @return bool|null + */ + public function getAllowFormView() + { + return $this->container['allow_form_view']; + } + + /** + * Sets allow_form_view + * + * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowFormView(?bool $allow_form_view) + { + if (is_null($allow_form_view)) { + throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + } + $this->container['allow_form_view'] = $allow_form_view; + + return $this; + } + /** * Gets allow_reassign * @@ -676,7 +710,7 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments _t__SubAttachment::LIST_DESCRIPTION * * @return self */ @@ -923,7 +957,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php index ac58ec089..b9b93a3ba 100644 --- a/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php @@ -484,7 +484,7 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request + * @param SubSignatureRequestTemplateSigner[] $signers _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * * @return self */ @@ -677,7 +677,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestEditRequest.php b/sdks/php/src/Model/SignatureRequestEditRequest.php index 131a3e4c4..8011208e7 100644 --- a/sdks/php/src/Model/SignatureRequestEditRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditRequest.php @@ -63,6 +63,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', 'allow_decline' => 'bool', + 'allow_form_view' => 'bool', 'allow_reassign' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', @@ -98,6 +99,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'signers' => null, 'grouped_signers' => null, 'allow_decline' => null, + 'allow_form_view' => null, 'allow_reassign' => null, 'attachments' => null, 'cc_email_addresses' => 'email', @@ -131,6 +133,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'signers' => false, 'grouped_signers' => false, 'allow_decline' => false, + 'allow_form_view' => false, 'allow_reassign' => false, 'attachments' => false, 'cc_email_addresses' => false, @@ -236,6 +239,7 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'signers', 'grouped_signers' => 'grouped_signers', 'allow_decline' => 'allow_decline', + 'allow_form_view' => 'allow_form_view', 'allow_reassign' => 'allow_reassign', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', @@ -269,6 +273,7 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'setSigners', 'grouped_signers' => 'setGroupedSigners', 'allow_decline' => 'setAllowDecline', + 'allow_form_view' => 'setAllowFormView', 'allow_reassign' => 'setAllowReassign', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', @@ -302,6 +307,7 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'getSigners', 'grouped_signers' => 'getGroupedSigners', 'allow_decline' => 'getAllowDecline', + 'allow_form_view' => 'getAllowFormView', 'allow_reassign' => 'getAllowReassign', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', @@ -385,6 +391,7 @@ public function __construct(?array $data = null) $this->setIfExists('signers', $data ?? [], null); $this->setIfExists('grouped_signers', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); + $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); @@ -545,7 +552,7 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestSigner[]|null $signers _t__Sub::SignatureRequestSigner::DESCRIPTION * * @return self */ @@ -572,7 +579,7 @@ public function getGroupedSigners() /** * Sets grouped_signers * - * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * * @return self */ @@ -613,6 +620,33 @@ public function setAllowDecline(?bool $allow_decline) return $this; } + /** + * Gets allow_form_view + * + * @return bool|null + */ + public function getAllowFormView() + { + return $this->container['allow_form_view']; + } + + /** + * Sets allow_form_view + * + * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowFormView(?bool $allow_form_view) + { + if (is_null($allow_form_view)) { + throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + } + $this->container['allow_form_view'] = $allow_form_view; + + return $this; + } + /** * Gets allow_reassign * @@ -653,7 +687,7 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments _t__SubAttachment::LIST_DESCRIPTION * * @return self */ @@ -954,7 +988,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php index c7f839f75..0d23452e6 100644 --- a/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php @@ -462,7 +462,7 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request + * @param SubSignatureRequestTemplateSigner[] $signers _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * * @return self */ @@ -709,7 +709,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestGetResponse.php b/sdks/php/src/Model/SignatureRequestGetResponse.php index d976e4932..0048781fc 100644 --- a/sdks/php/src/Model/SignatureRequestGetResponse.php +++ b/sdks/php/src/Model/SignatureRequestGetResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestListResponse.php b/sdks/php/src/Model/SignatureRequestListResponse.php index 5d9a26926..7200137cc 100644 --- a/sdks/php/src/Model/SignatureRequestListResponse.php +++ b/sdks/php/src/Model/SignatureRequestListResponse.php @@ -330,7 +330,7 @@ public function getSignatureRequests() /** * Sets signature_requests * - * @param SignatureRequestResponse[] $signature_requests contains information about signature requests + * @param SignatureRequestResponse[] $signature_requests _t__SignatureRequestListResponse::DESCRIPTION * * @return self */ @@ -384,7 +384,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponse.php b/sdks/php/src/Model/SignatureRequestResponse.php index 16a8fccf3..30d8544f6 100644 --- a/sdks/php/src/Model/SignatureRequestResponse.php +++ b/sdks/php/src/Model/SignatureRequestResponse.php @@ -37,7 +37,7 @@ * SignatureRequestResponse Class Doc Comment * * @category Class - * @description Contains information about a signature request. + * @description _t__SignatureRequestResponse::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -477,7 +477,7 @@ public function getTestMode() /** * Sets test_mode * - * @param bool|null $test_mode Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + * @param bool|null $test_mode _t__SignatureRequestResponse::TEST_MODE * * @return self */ @@ -504,7 +504,7 @@ public function getSignatureRequestId() /** * Sets signature_request_id * - * @param string|null $signature_request_id the id of the SignatureRequest + * @param string|null $signature_request_id _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID * * @return self */ @@ -531,7 +531,7 @@ public function getRequesterEmailAddress() /** * Sets requester_email_address * - * @param string|null $requester_email_address the email address of the initiator of the SignatureRequest + * @param string|null $requester_email_address _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS * * @return self */ @@ -565,7 +565,7 @@ public function getTitle() /** * Sets title * - * @param string|null $title the title the specified Account uses for the SignatureRequest + * @param string|null $title _t__SignatureRequestResponse::TITLE * * @return self */ @@ -592,7 +592,7 @@ public function getOriginalTitle() /** * Sets original_title * - * @param string|null $original_title default Label for account + * @param string|null $original_title _t__SignatureRequestResponse::ORIGINAL_TITLE * * @return self */ @@ -619,7 +619,7 @@ public function getSubject() /** * Sets subject * - * @param string|null $subject the subject in the email that was initially sent to the signers + * @param string|null $subject _t__SignatureRequestResponse::SUBJECT * * @return self */ @@ -653,7 +653,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message the custom message in the email that was initially sent to the signers + * @param string|null $message _t__SignatureRequestResponse::MESSAGE * * @return self */ @@ -687,7 +687,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata the metadata attached to the signature request + * @param array|null $metadata _t__SignatureRequestResponse::METADATA * * @return self */ @@ -714,7 +714,7 @@ public function getCreatedAt() /** * Sets created_at * - * @param int|null $created_at time the signature request was created + * @param int|null $created_at _t__SignatureRequestResponse::CREATED_AT * * @return self */ @@ -741,7 +741,7 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + * @param int|null $expires_at _t__SignatureRequestResponse::EXPIRES_AT * * @return self */ @@ -775,7 +775,7 @@ public function getIsComplete() /** * Sets is_complete * - * @param bool|null $is_complete whether or not the SignatureRequest has been fully executed by all signers + * @param bool|null $is_complete _t__SignatureRequestResponse::IS_COMPLETE * * @return self */ @@ -802,7 +802,7 @@ public function getIsDeclined() /** * Sets is_declined * - * @param bool|null $is_declined whether or not the SignatureRequest has been declined by a signer + * @param bool|null $is_declined _t__SignatureRequestResponse::IS_DECLINED * * @return self */ @@ -829,7 +829,7 @@ public function getHasError() /** * Sets has_error * - * @param bool|null $has_error whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings) + * @param bool|null $has_error _t__SignatureRequestResponse::HAS_ERROR * * @return self */ @@ -856,7 +856,7 @@ public function getFilesUrl() /** * Sets files_url * - * @param string|null $files_url the URL where a copy of the request's documents can be downloaded + * @param string|null $files_url _t__SignatureRequestResponse::FILES_URL * * @return self */ @@ -883,7 +883,7 @@ public function getSigningUrl() /** * Sets signing_url * - * @param string|null $signing_url The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + * @param string|null $signing_url _t__SignatureRequestResponse::SIGNING_URL * * @return self */ @@ -917,7 +917,7 @@ public function getDetailsUrl() /** * Sets details_url * - * @param string|null $details_url the URL where the requester and the signers can view the current status of the SignatureRequest + * @param string|null $details_url _t__SignatureRequestResponse::DETAILS_URL * * @return self */ @@ -944,7 +944,7 @@ public function getCcEmailAddresses() /** * Sets cc_email_addresses * - * @param string[]|null $cc_email_addresses A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + * @param string[]|null $cc_email_addresses _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES * * @return self */ @@ -971,7 +971,7 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want the signer redirected to after they successfully sign + * @param string|null $signing_redirect_url _t__SignatureRequestResponse::SIGNING_REDIRECT_URL * * @return self */ @@ -1005,7 +1005,7 @@ public function getFinalCopyUri() /** * Sets final_copy_uri * - * @param string|null $final_copy_uri The path where the completed document can be downloaded + * @param string|null $final_copy_uri _t__SignatureRequestResponse::FINAL_COPY_URI * * @return self */ @@ -1039,7 +1039,7 @@ public function getTemplateIds() /** * Sets template_ids * - * @param string[]|null $template_ids templates IDs used in this SignatureRequest (if any) + * @param string[]|null $template_ids _t__SignatureRequestResponse::TEMPLATE_IDS * * @return self */ @@ -1073,7 +1073,7 @@ public function getCustomFields() /** * Sets custom_fields * - * @param SignatureRequestResponseCustomFieldBase[]|null $custom_fields An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * @param SignatureRequestResponseCustomFieldBase[]|null $custom_fields _t__SignatureRequestResponseCustomField::DESCRIPTION * * @return self */ @@ -1107,7 +1107,7 @@ public function getAttachments() /** * Sets attachments * - * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments + * @param SignatureRequestResponseAttachment[]|null $attachments _t__SignatureRequestResponseAttachment::DESCRIPTION * * @return self */ @@ -1141,7 +1141,7 @@ public function getResponseData() /** * Sets response_data * - * @param SignatureRequestResponseDataBase[]|null $response_data an array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers + * @param SignatureRequestResponseDataBase[]|null $response_data _t__SignatureRequestResponseData::DESCRIPTION * * @return self */ @@ -1175,7 +1175,7 @@ public function getSignatures() /** * Sets signatures * - * @param SignatureRequestResponseSignatures[]|null $signatures an array of signature objects, 1 for each signer + * @param SignatureRequestResponseSignatures[]|null $signatures _t__SignatureRequestResponseSignatures::DESCRIPTION * * @return self */ @@ -1202,7 +1202,7 @@ public function getBulkSendJobId() /** * Sets bulk_send_job_id * - * @param string|null $bulk_send_job_id the ID of the Bulk Send job which sent the signature request, if applicable + * @param string|null $bulk_send_job_id _t__SignatureRequestResponse::BULK_SEND_JOB_ID * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseAttachment.php b/sdks/php/src/Model/SignatureRequestResponseAttachment.php index 8a91a0b96..6bc4a767f 100644 --- a/sdks/php/src/Model/SignatureRequestResponseAttachment.php +++ b/sdks/php/src/Model/SignatureRequestResponseAttachment.php @@ -37,7 +37,7 @@ * SignatureRequestResponseAttachment Class Doc Comment * * @category Class - * @description Signer attachments. + * @description _t__SignatureRequestResponseAttachment::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -358,7 +358,7 @@ public function getId() /** * Sets id * - * @param string $id the unique ID for this attachment + * @param string $id _t__SignatureRequestResponseAttachment::ID * * @return self */ @@ -385,7 +385,7 @@ public function getSigner() /** * Sets signer * - * @param string $signer the Signer this attachment is assigned to + * @param string $signer _t__SignatureRequestResponseAttachment::SIGNER * * @return self */ @@ -412,7 +412,7 @@ public function getName() /** * Sets name * - * @param string $name the name of this attachment + * @param string $name _t__SignatureRequestResponseAttachment::NAME * * @return self */ @@ -439,7 +439,7 @@ public function getRequired() /** * Sets required * - * @param bool $required a boolean value denoting if this attachment is required + * @param bool $required _t__SignatureRequestResponseAttachment::REQUIRED * * @return self */ @@ -466,7 +466,7 @@ public function getInstructions() /** * Sets instructions * - * @param string|null $instructions instructions for Signer + * @param string|null $instructions _t__SignatureRequestResponseAttachment::INSTRUCTIONS * * @return self */ @@ -500,7 +500,7 @@ public function getUploadedAt() /** * Sets uploaded_at * - * @param int|null $uploaded_at timestamp when attachment was uploaded by Signer + * @param int|null $uploaded_at _t__SignatureRequestResponseAttachment::UPLOADED_AT * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php index 9d88d03f9..bdb147bd3 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldBase.php @@ -37,7 +37,7 @@ * SignatureRequestResponseCustomFieldBase Class Doc Comment * * @category Class - * @description An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + * @description _t__SignatureRequestResponseCustomField::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -344,7 +344,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + * @param string $type _t__SignatureRequestResponseCustomField::TYPE * * @return self */ @@ -371,7 +371,7 @@ public function getName() /** * Sets name * - * @param string $name the name of the Custom Field + * @param string $name _t__SignatureRequestResponseCustomField::NAME * * @return self */ @@ -398,7 +398,7 @@ public function getRequired() /** * Sets required * - * @param bool|null $required a boolean value denoting if this field is required + * @param bool|null $required _t__SignatureRequestResponseCustomField::REQUIRED * * @return self */ @@ -425,7 +425,7 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id the unique ID for this field + * @param string|null $api_id _t__SignatureRequestResponseCustomField::API_ID * * @return self */ @@ -452,7 +452,7 @@ public function getEditor() /** * Sets editor * - * @param string|null $editor the name of the Role that is able to edit this field + * @param string|null $editor _t__SignatureRequestResponseCustomField::EDITOR * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php index 983134b39..fe0f11463 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldCheckbox.php @@ -35,7 +35,7 @@ * SignatureRequestResponseCustomFieldCheckbox Class Doc Comment * * @category Class - * @description This class extends `SignatureRequestResponseCustomFieldBase`. + * @description _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -314,7 +314,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + * @param string $type _t__SignatureRequestResponseCustomField::TYPE * * @return self */ @@ -341,7 +341,7 @@ public function getValue() /** * Sets value * - * @param bool|null $value A true/false for checkbox fields + * @param bool|null $value _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php b/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php index 6c4a94396..63358fb8b 100644 --- a/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php +++ b/sdks/php/src/Model/SignatureRequestResponseCustomFieldText.php @@ -35,7 +35,7 @@ * SignatureRequestResponseCustomFieldText Class Doc Comment * * @category Class - * @description This class extends `SignatureRequestResponseCustomFieldBase`. + * @description _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -314,7 +314,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + * @param string $type _t__SignatureRequestResponseCustomField::TYPE * * @return self */ @@ -341,7 +341,7 @@ public function getValue() /** * Sets value * - * @param string|null $value A text string for text fields + * @param string|null $value _t__SignatureRequestResponseCustomField::VALUE_TEXT * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataBase.php b/sdks/php/src/Model/SignatureRequestResponseDataBase.php index 063b8a164..bb6781348 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataBase.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataBase.php @@ -37,7 +37,7 @@ * SignatureRequestResponseDataBase Class Doc Comment * * @category Class - * @description An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + * @description _t__SignatureRequestResponseData::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -357,7 +357,7 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id the unique ID for this field + * @param string|null $api_id _t__SignatureRequestResponseData::API_ID * * @return self */ @@ -384,7 +384,7 @@ public function getSignatureId() /** * Sets signature_id * - * @param string|null $signature_id the ID of the signature to which this response is linked + * @param string|null $signature_id _t__SignatureRequestResponseData::SIGNATURE_ID * * @return self */ @@ -411,7 +411,7 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the form field + * @param string|null $name _t__SignatureRequestResponseData::NAME * * @return self */ @@ -438,7 +438,7 @@ public function getRequired() /** * Sets required * - * @param bool|null $required a boolean value denoting if this field is required + * @param bool|null $required _t__SignatureRequestResponseData::REQUIRED * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php index e295a3a78..9edece62c 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckbox.php @@ -308,7 +308,7 @@ public function getType() /** * Sets type * - * @param string|null $type A yes/no checkbox + * @param string|null $type _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE * * @return self */ @@ -335,7 +335,7 @@ public function getValue() /** * Sets value * - * @param bool|null $value the value of the form field + * @param bool|null $value _t__SignatureRequestResponseDataValue::VALUE * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php index bb808a601..9f3d4ab84 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueCheckboxMerge.php @@ -308,7 +308,7 @@ public function getType() /** * Sets type * - * @param string|null $type A checkbox field that has default value set by the api + * @param string|null $type _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE * * @return self */ @@ -335,7 +335,7 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value _t__SignatureRequestResponseDataValue::VALUE * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php b/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php index b422b6f5f..6a81f18e0 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueDateSigned.php @@ -308,7 +308,7 @@ public function getType() /** * Sets type * - * @param string|null $type A date + * @param string|null $type _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE * * @return self */ @@ -335,7 +335,7 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value _t__SignatureRequestResponseDataValue::VALUE * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php b/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php index e91201360..a78626f12 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueDropdown.php @@ -308,7 +308,7 @@ public function getType() /** * Sets type * - * @param string|null $type An input field for dropdowns + * @param string|null $type _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE * * @return self */ @@ -335,7 +335,7 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value _t__SignatureRequestResponseDataValue::VALUE * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php b/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php index 9cd07e08b..b9ca7ef5f 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueInitials.php @@ -315,7 +315,7 @@ public function getType() /** * Sets type * - * @param string|null $type An input field for initials + * @param string|null $type _t__SignatureRequestResponseDataValue::INITIAL_TYPE * * @return self */ @@ -342,7 +342,7 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value _t__SignatureRequestResponseDataValue::VALUE * * @return self */ @@ -369,7 +369,7 @@ public function getIsSigned() /** * Sets is_signed * - * @param bool|null $is_signed this field contains the boolean true if the field is signed + * @param bool|null $is_signed _t__SignatureRequestResponseDataValue::IS_SIGNED * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php b/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php index fcd4570eb..78ad1b218 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueRadio.php @@ -308,7 +308,7 @@ public function getType() /** * Sets type * - * @param string|null $type An input field for radios + * @param string|null $type _t__SignatureRequestResponseDataValue::RADIO_TYPE * * @return self */ @@ -335,7 +335,7 @@ public function getValue() /** * Sets value * - * @param bool|null $value the value of the form field + * @param bool|null $value _t__SignatureRequestResponseDataValue::VALUE * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php b/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php index 223ca960f..ef3acb419 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueSignature.php @@ -315,7 +315,7 @@ public function getType() /** * Sets type * - * @param string|null $type A signature input field + * @param string|null $type _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE * * @return self */ @@ -342,7 +342,7 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value _t__SignatureRequestResponseDataValue::VALUE * * @return self */ @@ -369,7 +369,7 @@ public function getIsSigned() /** * Sets is_signed * - * @param bool|null $is_signed this field contains the boolean true if the field is signed + * @param bool|null $is_signed _t__SignatureRequestResponseDataValue::IS_SIGNED * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueText.php b/sdks/php/src/Model/SignatureRequestResponseDataValueText.php index 7c1c97b22..f8f3e6394 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueText.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueText.php @@ -308,7 +308,7 @@ public function getType() /** * Sets type * - * @param string|null $type A text input field + * @param string|null $type _t__SignatureRequestResponseDataValue::TEXT_TYPE * * @return self */ @@ -335,7 +335,7 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value _t__SignatureRequestResponseDataValue::VALUE * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php b/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php index d8ea246f6..85f931fe2 100644 --- a/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php +++ b/sdks/php/src/Model/SignatureRequestResponseDataValueTextMerge.php @@ -308,7 +308,7 @@ public function getType() /** * Sets type * - * @param string|null $type A text field that has default text set by the api + * @param string|null $type _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE * * @return self */ @@ -335,7 +335,7 @@ public function getValue() /** * Sets value * - * @param string|null $value the value of the form field + * @param string|null $value _t__SignatureRequestResponseDataValue::VALUE * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestResponseSignatures.php b/sdks/php/src/Model/SignatureRequestResponseSignatures.php index fa7653fa2..46062a975 100644 --- a/sdks/php/src/Model/SignatureRequestResponseSignatures.php +++ b/sdks/php/src/Model/SignatureRequestResponseSignatures.php @@ -37,7 +37,7 @@ * SignatureRequestResponseSignatures Class Doc Comment * * @category Class - * @description An array of signature objects, 1 for each signer. + * @description _t__SignatureRequestResponseSignatures::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -435,7 +435,7 @@ public function getSignatureId() /** * Sets signature_id * - * @param string|null $signature_id signature identifier + * @param string|null $signature_id _t__SignatureRequestResponseSignatures::SIGNATURE_ID * * @return self */ @@ -462,7 +462,7 @@ public function getSignerGroupGuid() /** * Sets signer_group_guid * - * @param string|null $signer_group_guid Signer Group GUID + * @param string|null $signer_group_guid _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID * * @return self */ @@ -496,7 +496,7 @@ public function getSignerEmailAddress() /** * Sets signer_email_address * - * @param string|null $signer_email_address the email address of the signer + * @param string|null $signer_email_address _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS * * @return self */ @@ -523,7 +523,7 @@ public function getSignerName() /** * Sets signer_name * - * @param string|null $signer_name the name of the signer + * @param string|null $signer_name _t__SignatureRequestResponseSignatures::SIGNER_NAME * * @return self */ @@ -557,7 +557,7 @@ public function getSignerRole() /** * Sets signer_role * - * @param string|null $signer_role the role of the signer + * @param string|null $signer_role _t__SignatureRequestResponseSignatures::SIGNER_ROLE * * @return self */ @@ -591,7 +591,7 @@ public function getOrder() /** * Sets order * - * @param int|null $order if signer order is assigned this is the 0-based index for this signer + * @param int|null $order _t__SignatureRequestResponseSignatures::ORDER * * @return self */ @@ -625,7 +625,7 @@ public function getStatusCode() /** * Sets status_code * - * @param string|null $status_code The current status of the signature. eg: awaiting_signature, signed, declined. + * @param string|null $status_code _t__SignatureRequestResponseSignatures::STATUS_CODE * * @return self */ @@ -652,7 +652,7 @@ public function getDeclineReason() /** * Sets decline_reason * - * @param string|null $decline_reason the reason provided by the signer for declining the request + * @param string|null $decline_reason _t__SignatureRequestResponseSignatures::DECLINE_REASON * * @return self */ @@ -686,7 +686,7 @@ public function getSignedAt() /** * Sets signed_at * - * @param int|null $signed_at time that the document was signed or null + * @param int|null $signed_at _t__SignatureRequestResponseSignatures::SIGNED_AT * * @return self */ @@ -720,7 +720,7 @@ public function getLastViewedAt() /** * Sets last_viewed_at * - * @param int|null $last_viewed_at the time that the document was last viewed by this signer or null + * @param int|null $last_viewed_at _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT * * @return self */ @@ -754,7 +754,7 @@ public function getLastRemindedAt() /** * Sets last_reminded_at * - * @param int|null $last_reminded_at the time the last reminder email was sent to the signer or null + * @param int|null $last_reminded_at _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT * * @return self */ @@ -788,7 +788,7 @@ public function getHasPin() /** * Sets has_pin * - * @param bool|null $has_pin boolean to indicate whether this signature requires a PIN to access + * @param bool|null $has_pin _t__SignatureRequestResponseSignatures::HAS_PIN * * @return self */ @@ -815,7 +815,7 @@ public function getHasSmsAuth() /** * Sets has_sms_auth * - * @param bool|null $has_sms_auth boolean to indicate whether this signature has SMS authentication enabled + * @param bool|null $has_sms_auth _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH * * @return self */ @@ -849,7 +849,7 @@ public function getHasSmsDelivery() /** * Sets has_sms_delivery * - * @param bool|null $has_sms_delivery boolean to indicate whether this signature has SMS delivery enabled + * @param bool|null $has_sms_delivery _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY * * @return self */ @@ -883,7 +883,7 @@ public function getSmsPhoneNumber() /** * Sets sms_phone_number * - * @param string|null $sms_phone_number the SMS phone number used for authentication or signature request delivery + * @param string|null $sms_phone_number _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER * * @return self */ @@ -917,7 +917,7 @@ public function getReassignedBy() /** * Sets reassigned_by * - * @param string|null $reassigned_by email address of original signer who reassigned to this signer + * @param string|null $reassigned_by _t__SignatureRequestResponseSignatures::REASSIGNED_BY * * @return self */ @@ -951,7 +951,7 @@ public function getReassignmentReason() /** * Sets reassignment_reason * - * @param string|null $reassignment_reason reason provided by original signer who reassigned to this signer + * @param string|null $reassignment_reason _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON * * @return self */ @@ -985,7 +985,7 @@ public function getReassignedFrom() /** * Sets reassigned_from * - * @param string|null $reassigned_from previous signature identifier + * @param string|null $reassigned_from _t__SignatureRequestResponseSignatures::REASSIGNED_FROM * * @return self */ @@ -1019,7 +1019,7 @@ public function getError() /** * Sets error * - * @param string|null $error error message pertaining to this signer, or null + * @param string|null $error _t__SignatureRequestResponseSignatures::ERROR * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestSendRequest.php b/sdks/php/src/Model/SignatureRequestSendRequest.php index f381a8d85..d22a69162 100644 --- a/sdks/php/src/Model/SignatureRequestSendRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendRequest.php @@ -64,6 +64,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', 'allow_decline' => 'bool', 'allow_reassign' => 'bool', + 'allow_form_view' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', 'client_id' => 'string', @@ -100,6 +101,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'grouped_signers' => null, 'allow_decline' => null, 'allow_reassign' => null, + 'allow_form_view' => null, 'attachments' => null, 'cc_email_addresses' => 'email', 'client_id' => null, @@ -134,6 +136,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'grouped_signers' => false, 'allow_decline' => false, 'allow_reassign' => false, + 'allow_form_view' => false, 'attachments' => false, 'cc_email_addresses' => false, 'client_id' => false, @@ -240,6 +243,7 @@ public function isNullableSetToNull(string $property): bool 'grouped_signers' => 'grouped_signers', 'allow_decline' => 'allow_decline', 'allow_reassign' => 'allow_reassign', + 'allow_form_view' => 'allow_form_view', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', 'client_id' => 'client_id', @@ -274,6 +278,7 @@ public function isNullableSetToNull(string $property): bool 'grouped_signers' => 'setGroupedSigners', 'allow_decline' => 'setAllowDecline', 'allow_reassign' => 'setAllowReassign', + 'allow_form_view' => 'setAllowFormView', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', 'client_id' => 'setClientId', @@ -308,6 +313,7 @@ public function isNullableSetToNull(string $property): bool 'grouped_signers' => 'getGroupedSigners', 'allow_decline' => 'getAllowDecline', 'allow_reassign' => 'getAllowReassign', + 'allow_form_view' => 'getAllowFormView', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', 'client_id' => 'getClientId', @@ -392,6 +398,7 @@ public function __construct(?array $data = null) $this->setIfExists('grouped_signers', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); + $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); $this->setIfExists('client_id', $data ?? [], null); @@ -552,7 +559,7 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestSigner[]|null $signers Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestSigner[]|null $signers _t__Sub::SignatureRequestSigner::DESCRIPTION * * @return self */ @@ -579,7 +586,7 @@ public function getGroupedSigners() /** * Sets grouped_signers * - * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @param SubSignatureRequestGroupedSigners[]|null $grouped_signers _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION * * @return self */ @@ -647,6 +654,33 @@ public function setAllowReassign(?bool $allow_reassign) return $this; } + /** + * Gets allow_form_view + * + * @return bool|null + */ + public function getAllowFormView() + { + return $this->container['allow_form_view']; + } + + /** + * Sets allow_form_view + * + * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowFormView(?bool $allow_form_view) + { + if (is_null($allow_form_view)) { + throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + } + $this->container['allow_form_view'] = $allow_form_view; + + return $this; + } + /** * Gets attachments * @@ -660,7 +694,7 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments _t__SubAttachment::LIST_DESCRIPTION * * @return self */ @@ -990,7 +1024,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php index 6f4cd28ff..cc0bc09ab 100644 --- a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php @@ -469,7 +469,7 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestTemplateSigner[] $signers add Signers to your Templated-based Signature Request + * @param SubSignatureRequestTemplateSigner[] $signers _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION * * @return self */ @@ -745,7 +745,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php b/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php index 085791ea9..1e2e25d27 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentBase.php @@ -593,7 +593,7 @@ public function getWidth() /** * Sets width * - * @param int $width size of the field in pixels + * @param int $width _t__Sub::FormFieldsPerDocument::WIDTH * * @return self */ @@ -620,7 +620,7 @@ public function getX() /** * Sets x * - * @param int $x location coordinates of the field in pixels + * @param int $x _t__Sub::FormFieldsPerDocument::X * * @return self */ @@ -647,7 +647,7 @@ public function getY() /** * Sets y * - * @param int $y location coordinates of the field in pixels + * @param int $y _t__Sub::FormFieldsPerDocument::Y * * @return self */ diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentText.php b/sdks/php/src/Model/SubFormFieldsPerDocumentText.php index 1cb1f6e8f..a109bea02 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentText.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentText.php @@ -605,7 +605,7 @@ public function getValidationType() /** * Sets validation_type * - * @param string|null $validation_type Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + * @param string|null $validation_type _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE * * @return self */ diff --git a/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php b/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php index 2f1fb28c4..2f27c9ec0 100644 --- a/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php +++ b/sdks/php/src/Model/SubFormFieldsPerDocumentTextMerge.php @@ -374,7 +374,7 @@ public function getType() /** * Sets type * - * @param string $type A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. + * @param string $type _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE * * @return self */ diff --git a/sdks/php/src/Model/SubMergeField.php b/sdks/php/src/Model/SubMergeField.php index 3b72a78ab..f18b98513 100644 --- a/sdks/php/src/Model/SubMergeField.php +++ b/sdks/php/src/Model/SubMergeField.php @@ -348,7 +348,7 @@ public function getName() /** * Sets name * - * @param string $name The name of the merge field. Must be unique. + * @param string $name _t__Sub::MergeField::NAME * * @return self */ @@ -375,7 +375,7 @@ public function getType() /** * Sets type * - * @param string $type the type of merge field + * @param string $type _t__Sub::MergeField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/SubOAuth.php b/sdks/php/src/Model/SubOAuth.php index 39c24d80e..6262242ca 100644 --- a/sdks/php/src/Model/SubOAuth.php +++ b/sdks/php/src/Model/SubOAuth.php @@ -37,7 +37,7 @@ * SubOAuth Class Doc Comment * * @category Class - * @description OAuth related parameters. + * @description _t__Sub::OAuth::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -344,7 +344,7 @@ public function getCallbackUrl() /** * Sets callback_url * - * @param string|null $callback_url The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) + * @param string|null $callback_url _t__Sub::OAuth::CALLBACK_URL * * @return self */ @@ -371,7 +371,7 @@ public function getScopes() /** * Sets scopes * - * @param string[]|null $scopes A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). + * @param string[]|null $scopes _t__Sub::OAuth::SCOPES * * @return self */ diff --git a/sdks/php/src/Model/SubOptions.php b/sdks/php/src/Model/SubOptions.php index 4493687d0..bc0628dde 100644 --- a/sdks/php/src/Model/SubOptions.php +++ b/sdks/php/src/Model/SubOptions.php @@ -37,7 +37,7 @@ * SubOptions Class Doc Comment * * @category Class - * @description Additional options supported by API App. + * @description _t__Sub::Options::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -309,7 +309,7 @@ public function getCanInsertEverywhere() /** * Sets can_insert_everywhere * - * @param bool|null $can_insert_everywhere determines if signers can use \"Insert Everywhere\" when signing a document + * @param bool|null $can_insert_everywhere _t__Sub::Options::CAN_INSERT_EVERYWHERE * * @return self */ diff --git a/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php b/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php index 5405a1142..a556597e0 100644 --- a/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php +++ b/sdks/php/src/Model/SubSignatureRequestGroupedSigners.php @@ -330,7 +330,7 @@ public function getGroup() /** * Sets group * - * @param string $group the name of the group + * @param string $group _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME * * @return self */ @@ -357,7 +357,7 @@ public function getSigners() /** * Sets signers * - * @param SubSignatureRequestSigner[] $signers 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. + * @param SubSignatureRequestSigner[] $signers _t__Sub::SignatureRequestGroupedSigners::SIGNERS * * @return self */ @@ -384,7 +384,7 @@ public function getOrder() /** * Sets order * - * @param int|null $order The order the group is required to sign in. Use this instead of Signer-level `order`. + * @param int|null $order _t__Sub::SignatureRequestGroupedSigners::ORDER * * @return self */ diff --git a/sdks/php/src/Model/SubSignatureRequestSigner.php b/sdks/php/src/Model/SubSignatureRequestSigner.php index 23043b15a..5eac62ac8 100644 --- a/sdks/php/src/Model/SubSignatureRequestSigner.php +++ b/sdks/php/src/Model/SubSignatureRequestSigner.php @@ -384,7 +384,7 @@ public function getName() /** * Sets name * - * @param string $name the name of the signer + * @param string $name _t__Sub::SignatureRequestSigner::SIGNER_NAME * * @return self */ @@ -411,7 +411,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the signer + * @param string $email_address _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS * * @return self */ @@ -438,7 +438,7 @@ public function getOrder() /** * Sets order * - * @param int|null $order the order the signer is required to sign in + * @param int|null $order _t__Sub::SignatureRequestSigner::SIGNER_ORDER * * @return self */ @@ -472,7 +472,7 @@ public function getPin() /** * Sets pin * - * @param string|null $pin the 4- to 12-character access code that will secure this signer's signature page + * @param string|null $pin _t__Sub::SignatureRequestSigner::SIGNER_PIN * * @return self */ @@ -506,7 +506,7 @@ public function getSmsPhoneNumber() /** * Sets sms_phone_number * - * @param string|null $sms_phone_number An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + * @param string|null $sms_phone_number _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER * * @return self */ @@ -533,7 +533,7 @@ public function getSmsPhoneNumberType() /** * Sets sms_phone_number_type * - * @param string|null $sms_phone_number_type Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + * @param string|null $sms_phone_number_type _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE * * @return self */ diff --git a/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php b/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php index caf7d9078..54c0e3e26 100644 --- a/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php +++ b/sdks/php/src/Model/SubSignatureRequestTemplateSigner.php @@ -387,7 +387,7 @@ public function getRole() /** * Sets role * - * @param string $role Must match an existing role in chosen Template(s). It's case-sensitive. + * @param string $role _t__Sub::SignatureRequestTemplateSigner::ROLE * * @return self */ @@ -414,7 +414,7 @@ public function getName() /** * Sets name * - * @param string $name the name of the signer + * @param string $name _t__Sub::SignatureRequestTemplateSigner::NAME * * @return self */ @@ -441,7 +441,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the signer + * @param string $email_address _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS * * @return self */ @@ -468,7 +468,7 @@ public function getPin() /** * Sets pin * - * @param string|null $pin the 4- to 12-character access code that will secure this signer's signature page + * @param string|null $pin _t__Sub::SignatureRequestTemplateSigner::PIN * * @return self */ @@ -502,7 +502,7 @@ public function getSmsPhoneNumber() /** * Sets sms_phone_number * - * @param string|null $sms_phone_number An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + * @param string|null $sms_phone_number _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER * * @return self */ @@ -529,7 +529,7 @@ public function getSmsPhoneNumberType() /** * Sets sms_phone_number_type * - * @param string|null $sms_phone_number_type Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + * @param string|null $sms_phone_number_type _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE * * @return self */ diff --git a/sdks/php/src/Model/SubSigningOptions.php b/sdks/php/src/Model/SubSigningOptions.php index bdb9f4ecf..77bf4b678 100644 --- a/sdks/php/src/Model/SubSigningOptions.php +++ b/sdks/php/src/Model/SubSigningOptions.php @@ -37,7 +37,7 @@ * SubSigningOptions Class Doc Comment * * @category Class - * @description This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + * @description _t__Sub::SigningOptions::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -371,7 +371,7 @@ public function getDefaultType() /** * Sets default_type * - * @param string $default_type The default type shown (limited to the listed types) + * @param string $default_type _t__Sub::SigningOptions::DEFAULT * * @return self */ @@ -408,7 +408,7 @@ public function getDraw() /** * Sets draw * - * @param bool|null $draw Allows drawing the signature + * @param bool|null $draw _t__Sub::SigningOptions::DRAW * * @return self */ @@ -435,7 +435,7 @@ public function getPhone() /** * Sets phone * - * @param bool|null $phone Allows using a smartphone to email the signature + * @param bool|null $phone _t__Sub::SigningOptions::PHONE * * @return self */ @@ -462,7 +462,7 @@ public function getType() /** * Sets type * - * @param bool|null $type Allows typing the signature + * @param bool|null $type _t__Sub::SigningOptions::TYPE * * @return self */ @@ -489,7 +489,7 @@ public function getUpload() /** * Sets upload * - * @param bool|null $upload Allows uploading the signature + * @param bool|null $upload _t__Sub::SigningOptions::UPLOAD * * @return self */ diff --git a/sdks/php/src/Model/SubTeamResponse.php b/sdks/php/src/Model/SubTeamResponse.php index def81afc0..5279816d4 100644 --- a/sdks/php/src/Model/SubTeamResponse.php +++ b/sdks/php/src/Model/SubTeamResponse.php @@ -315,7 +315,7 @@ public function getTeamId() /** * Sets team_id * - * @param string|null $team_id The id of a team + * @param string|null $team_id _t__TeamGeneral::TEAM_ID * * @return self */ @@ -342,7 +342,7 @@ public function getName() /** * Sets name * - * @param string|null $name The name of a team + * @param string|null $name _t__TeamGeneral::NAME * * @return self */ diff --git a/sdks/php/src/Model/SubTemplateRole.php b/sdks/php/src/Model/SubTemplateRole.php index 489a376a5..a253f0a52 100644 --- a/sdks/php/src/Model/SubTemplateRole.php +++ b/sdks/php/src/Model/SubTemplateRole.php @@ -315,7 +315,7 @@ public function getName() /** * Sets name * - * @param string|null $name the role name of the signer that will be displayed when the template is used to create a signature request + * @param string|null $name _t__Sub::SignerRole::NAME * * @return self */ @@ -342,7 +342,7 @@ public function getOrder() /** * Sets order * - * @param int|null $order the order in which this signer role is required to sign + * @param int|null $order _t__Sub::SignerRole::ORDER * * @return self */ diff --git a/sdks/php/src/Model/SubUnclaimedDraftSigner.php b/sdks/php/src/Model/SubUnclaimedDraftSigner.php index 4d9b3ec8f..bc0973882 100644 --- a/sdks/php/src/Model/SubUnclaimedDraftSigner.php +++ b/sdks/php/src/Model/SubUnclaimedDraftSigner.php @@ -330,7 +330,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the signer + * @param string $email_address _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS * * @return self */ @@ -357,7 +357,7 @@ public function getName() /** * Sets name * - * @param string $name the name of the signer + * @param string $name _t__Sub::UnclaimedDraftSigner::NAME * * @return self */ @@ -384,7 +384,7 @@ public function getOrder() /** * Sets order * - * @param int|null $order the order the signer is required to sign in + * @param int|null $order _t__Sub::UnclaimedDraftSigner::ORDER * * @return self */ diff --git a/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php b/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php index 52544c118..9e6641062 100644 --- a/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php +++ b/sdks/php/src/Model/SubUnclaimedDraftTemplateSigner.php @@ -333,7 +333,7 @@ public function getRole() /** * Sets role * - * @param string $role must match an existing role in chosen Template(s) + * @param string $role _t__Sub::UnclaimedDraftTemplateSigner::ROLE * * @return self */ @@ -360,7 +360,7 @@ public function getName() /** * Sets name * - * @param string $name the name of the signer filling the role of `role` + * @param string $name _t__Sub::UnclaimedDraftTemplateSigner::NAME * * @return self */ @@ -387,7 +387,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string $email_address the email address of the signer filling the role of `role` + * @param string $email_address _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS * * @return self */ diff --git a/sdks/php/src/Model/SubWhiteLabelingOptions.php b/sdks/php/src/Model/SubWhiteLabelingOptions.php index 5eafd34ad..d0e30d1d0 100644 --- a/sdks/php/src/Model/SubWhiteLabelingOptions.php +++ b/sdks/php/src/Model/SubWhiteLabelingOptions.php @@ -37,7 +37,7 @@ * SubWhiteLabelingOptions Class Doc Comment * * @category Class - * @description An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. + * @description _t__Sub::WhiteLabelingOptions::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -822,7 +822,7 @@ public function getResetToDefault() /** * Sets reset_to_default * - * @param bool|null $reset_to_default Resets white labeling options to defaults. Only useful when updating an API App. + * @param bool|null $reset_to_default _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT * * @return self */ diff --git a/sdks/php/src/Model/TeamGetInfoResponse.php b/sdks/php/src/Model/TeamGetInfoResponse.php index 58c58f6dd..0c9bb7b0e 100644 --- a/sdks/php/src/Model/TeamGetInfoResponse.php +++ b/sdks/php/src/Model/TeamGetInfoResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TeamGetResponse.php b/sdks/php/src/Model/TeamGetResponse.php index 05624a166..79343c014 100644 --- a/sdks/php/src/Model/TeamGetResponse.php +++ b/sdks/php/src/Model/TeamGetResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TeamInfoResponse.php b/sdks/php/src/Model/TeamInfoResponse.php index 7deb94ad8..bdd8ebf75 100644 --- a/sdks/php/src/Model/TeamInfoResponse.php +++ b/sdks/php/src/Model/TeamInfoResponse.php @@ -336,7 +336,7 @@ public function getTeamId() /** * Sets team_id * - * @param string|null $team_id The id of a team + * @param string|null $team_id _t__TeamGeneral::TEAM_ID * * @return self */ @@ -397,7 +397,7 @@ public function getName() /** * Sets name * - * @param string|null $name The name of a team + * @param string|null $name _t__TeamGeneral::NAME * * @return self */ @@ -424,7 +424,7 @@ public function getNumMembers() /** * Sets num_members * - * @param int|null $num_members Number of members within a team + * @param int|null $num_members _t__TeamGeneral::NUM_MEMBERS * * @return self */ @@ -451,7 +451,7 @@ public function getNumSubTeams() /** * Sets num_sub_teams * - * @param int|null $num_sub_teams Number of sub teams within a team + * @param int|null $num_sub_teams _t__TeamGeneral::NUM_SUB_TEAMS * * @return self */ diff --git a/sdks/php/src/Model/TeamParentResponse.php b/sdks/php/src/Model/TeamParentResponse.php index bfd6cc6f8..25393d22f 100644 --- a/sdks/php/src/Model/TeamParentResponse.php +++ b/sdks/php/src/Model/TeamParentResponse.php @@ -316,7 +316,7 @@ public function getTeamId() /** * Sets team_id * - * @param string|null $team_id The id of a team + * @param string|null $team_id _t__TeamGeneral::TEAM_ID * * @return self */ @@ -343,7 +343,7 @@ public function getName() /** * Sets name * - * @param string|null $name The name of a team + * @param string|null $name _t__TeamGeneral::NAME * * @return self */ diff --git a/sdks/php/src/Model/TeamResponse.php b/sdks/php/src/Model/TeamResponse.php index 922c408b8..90fabdf5e 100644 --- a/sdks/php/src/Model/TeamResponse.php +++ b/sdks/php/src/Model/TeamResponse.php @@ -37,7 +37,7 @@ * TeamResponse Class Doc Comment * * @category Class - * @description Contains information about your team and its members + * @description _t__TeamResponse::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -330,7 +330,7 @@ public function getName() /** * Sets name * - * @param string|null $name The name of your Team + * @param string|null $name _t__Team::NAME * * @return self */ @@ -384,7 +384,7 @@ public function getInvitedAccounts() /** * Sets invited_accounts * - * @param AccountResponse[]|null $invited_accounts 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`. + * @param AccountResponse[]|null $invited_accounts _t__Team::INVITED_ACCOUNTS * * @return self */ @@ -411,7 +411,7 @@ public function getInvitedEmails() /** * Sets invited_emails * - * @param string[]|null $invited_emails a list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account + * @param string[]|null $invited_emails _t__Team::INVITED_EMAILS * * @return self */ diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php index 79ce3b26a..90f46ac25 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php @@ -63,6 +63,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'file_urls' => 'string[]', 'allow_ccs' => 'bool', 'allow_reassign' => 'bool', + 'allow_form_view' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_roles' => 'string[]', 'editor_options' => '\Dropbox\Sign\Model\SubEditorOptions', @@ -98,6 +99,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'file_urls' => null, 'allow_ccs' => null, 'allow_reassign' => null, + 'allow_form_view' => null, 'attachments' => null, 'cc_roles' => null, 'editor_options' => null, @@ -131,6 +133,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'file_urls' => false, 'allow_ccs' => false, 'allow_reassign' => false, + 'allow_form_view' => false, 'attachments' => false, 'cc_roles' => false, 'editor_options' => false, @@ -236,6 +239,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'file_urls', 'allow_ccs' => 'allow_ccs', 'allow_reassign' => 'allow_reassign', + 'allow_form_view' => 'allow_form_view', 'attachments' => 'attachments', 'cc_roles' => 'cc_roles', 'editor_options' => 'editor_options', @@ -269,6 +273,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'setFileUrls', 'allow_ccs' => 'setAllowCcs', 'allow_reassign' => 'setAllowReassign', + 'allow_form_view' => 'setAllowFormView', 'attachments' => 'setAttachments', 'cc_roles' => 'setCcRoles', 'editor_options' => 'setEditorOptions', @@ -302,6 +307,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'getFileUrls', 'allow_ccs' => 'getAllowCcs', 'allow_reassign' => 'getAllowReassign', + 'allow_form_view' => 'getAllowFormView', 'attachments' => 'getAttachments', 'cc_roles' => 'getCcRoles', 'editor_options' => 'getEditorOptions', @@ -385,6 +391,7 @@ public function __construct(?array $data = null) $this->setIfExists('file_urls', $data ?? [], null); $this->setIfExists('allow_ccs', $data ?? [], true); $this->setIfExists('allow_reassign', $data ?? [], false); + $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('editor_options', $data ?? [], null); @@ -612,6 +619,33 @@ public function setAllowReassign(?bool $allow_reassign) return $this; } + /** + * Gets allow_form_view + * + * @return bool|null + */ + public function getAllowFormView() + { + return $this->container['allow_form_view']; + } + + /** + * Sets allow_form_view + * + * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowFormView(?bool $allow_form_view) + { + if (is_null($allow_form_view)) { + throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + } + $this->container['allow_form_view'] = $allow_form_view; + + return $this; + } + /** * Gets attachments * @@ -625,7 +659,7 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments _t__SubAttachment::LIST_DESCRIPTION * * @return self */ @@ -926,7 +960,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php index ca85bf0ad..c6629d3c1 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php index 324766d2f..6c934a558 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php @@ -37,7 +37,7 @@ * TemplateCreateEmbeddedDraftResponseTemplate Class Doc Comment * * @category Class - * @description Template object with parameters: `template_id`, `edit_url`, `expires_at`. + * @description _t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -330,7 +330,7 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string|null $template_id _t__TemplateResponse::TEMPLATE_ID * * @return self */ @@ -357,7 +357,7 @@ public function getEditUrl() /** * Sets edit_url * - * @param string|null $edit_url link to edit the template + * @param string|null $edit_url _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL * * @return self */ @@ -384,7 +384,7 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at when the link expires + * @param int|null $expires_at _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT * * @return self */ @@ -412,7 +412,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self * @deprecated diff --git a/sdks/php/src/Model/TemplateCreateRequest.php b/sdks/php/src/Model/TemplateCreateRequest.php index ddeab0295..0edea426f 100644 --- a/sdks/php/src/Model/TemplateCreateRequest.php +++ b/sdks/php/src/Model/TemplateCreateRequest.php @@ -63,6 +63,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'files' => '\SplFileObject[]', 'file_urls' => 'string[]', 'allow_reassign' => 'bool', + 'allow_form_view' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_roles' => 'string[]', 'client_id' => 'string', @@ -91,6 +92,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'files' => 'binary', 'file_urls' => null, 'allow_reassign' => null, + 'allow_form_view' => null, 'attachments' => null, 'cc_roles' => null, 'client_id' => null, @@ -117,6 +119,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'files' => false, 'file_urls' => false, 'allow_reassign' => false, + 'allow_form_view' => false, 'attachments' => false, 'cc_roles' => false, 'client_id' => false, @@ -215,6 +218,7 @@ public function isNullableSetToNull(string $property): bool 'files' => 'files', 'file_urls' => 'file_urls', 'allow_reassign' => 'allow_reassign', + 'allow_form_view' => 'allow_form_view', 'attachments' => 'attachments', 'cc_roles' => 'cc_roles', 'client_id' => 'client_id', @@ -241,6 +245,7 @@ public function isNullableSetToNull(string $property): bool 'files' => 'setFiles', 'file_urls' => 'setFileUrls', 'allow_reassign' => 'setAllowReassign', + 'allow_form_view' => 'setAllowFormView', 'attachments' => 'setAttachments', 'cc_roles' => 'setCcRoles', 'client_id' => 'setClientId', @@ -267,6 +272,7 @@ public function isNullableSetToNull(string $property): bool 'files' => 'getFiles', 'file_urls' => 'getFileUrls', 'allow_reassign' => 'getAllowReassign', + 'allow_form_view' => 'getAllowFormView', 'attachments' => 'getAttachments', 'cc_roles' => 'getCcRoles', 'client_id' => 'getClientId', @@ -343,6 +349,7 @@ public function __construct(?array $data = null) $this->setIfExists('files', $data ?? [], null); $this->setIfExists('file_urls', $data ?? [], null); $this->setIfExists('allow_reassign', $data ?? [], false); + $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('client_id', $data ?? [], null); @@ -566,6 +573,33 @@ public function setAllowReassign(?bool $allow_reassign) return $this; } + /** + * Gets allow_form_view + * + * @return bool|null + */ + public function getAllowFormView() + { + return $this->container['allow_form_view']; + } + + /** + * Sets allow_form_view + * + * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowFormView(?bool $allow_form_view) + { + if (is_null($allow_form_view)) { + throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + } + $this->container['allow_form_view'] = $allow_form_view; + + return $this; + } + /** * Gets attachments * @@ -579,7 +613,7 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments _t__SubAttachment::LIST_DESCRIPTION * * @return self */ @@ -799,7 +833,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TemplateCreateResponse.php b/sdks/php/src/Model/TemplateCreateResponse.php index 3fe65f194..77e0b81d0 100644 --- a/sdks/php/src/Model/TemplateCreateResponse.php +++ b/sdks/php/src/Model/TemplateCreateResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TemplateCreateResponseTemplate.php b/sdks/php/src/Model/TemplateCreateResponseTemplate.php index 7baaf00cb..b5759af6d 100644 --- a/sdks/php/src/Model/TemplateCreateResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateResponseTemplate.php @@ -37,7 +37,7 @@ * TemplateCreateResponseTemplate Class Doc Comment * * @category Class - * @description Template object with parameters: `template_id`. + * @description _t__TemplateCreateResponseTemplate::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -309,7 +309,7 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string|null $template_id _t__TemplateResponse::TEMPLATE_ID * * @return self */ diff --git a/sdks/php/src/Model/TemplateEditResponse.php b/sdks/php/src/Model/TemplateEditResponse.php index 3374ff2c3..d620e05be 100644 --- a/sdks/php/src/Model/TemplateEditResponse.php +++ b/sdks/php/src/Model/TemplateEditResponse.php @@ -313,7 +313,7 @@ public function getTemplateId() /** * Sets template_id * - * @param string $template_id the id of the Template + * @param string $template_id _t__TemplateResponse::TEMPLATE_ID * * @return self */ diff --git a/sdks/php/src/Model/TemplateGetResponse.php b/sdks/php/src/Model/TemplateGetResponse.php index 321b66702..7c292dfd8 100644 --- a/sdks/php/src/Model/TemplateGetResponse.php +++ b/sdks/php/src/Model/TemplateGetResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TemplateListResponse.php b/sdks/php/src/Model/TemplateListResponse.php index df656f237..af87070d0 100644 --- a/sdks/php/src/Model/TemplateListResponse.php +++ b/sdks/php/src/Model/TemplateListResponse.php @@ -330,7 +330,7 @@ public function getTemplates() /** * Sets templates * - * @param TemplateResponse[] $templates list of templates that the API caller has access to + * @param TemplateResponse[] $templates _t__TemplateListResponse::DESCRIPTION * * @return self */ @@ -384,7 +384,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponse.php b/sdks/php/src/Model/TemplateResponse.php index 69492ed9d..dd497e2ff 100644 --- a/sdks/php/src/Model/TemplateResponse.php +++ b/sdks/php/src/Model/TemplateResponse.php @@ -37,7 +37,7 @@ * TemplateResponse Class Doc Comment * * @category Class - * @description Contains information about the templates you and your team have created. + * @description _t__TemplateResponse::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -414,7 +414,7 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string|null $template_id _t__TemplateResponse::TEMPLATE_ID * * @return self */ @@ -441,7 +441,7 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * @param string|null $title _t__TemplateResponse::TITLE * * @return self */ @@ -468,7 +468,7 @@ public function getMessage() /** * Sets message * - * @param string|null $message The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * @param string|null $message _t__TemplateResponse::MESSAGE * * @return self */ @@ -495,7 +495,7 @@ public function getUpdatedAt() /** * Sets updated_at * - * @param int|null $updated_at time the template was last updated + * @param int|null $updated_at _t__TemplateResponse::UPDATED_AT * * @return self */ @@ -522,7 +522,7 @@ public function getIsEmbedded() /** * Sets is_embedded * - * @param bool|null $is_embedded `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + * @param bool|null $is_embedded _t__TemplateResponse::IS_EMBEDDED * * @return self */ @@ -556,7 +556,7 @@ public function getIsCreator() /** * Sets is_creator * - * @param bool|null $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member + * @param bool|null $is_creator _t__TemplateResponse::IS_CREATOR * * @return self */ @@ -583,7 +583,7 @@ public function getCanEdit() /** * Sets can_edit * - * @param bool|null $can_edit indicates whether edit rights have been granted to you by the owner (always `true` if that's you) + * @param bool|null $can_edit _t__TemplateResponse::CAN_EDIT * * @return self */ @@ -610,7 +610,7 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + * @param bool|null $is_locked _t__TemplateResponse::IS_LOCKED * * @return self */ @@ -637,7 +637,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata the metadata attached to the template + * @param array|null $metadata _t__TemplateResponse::METADATA * * @return self */ @@ -664,7 +664,7 @@ public function getSignerRoles() /** * Sets signer_roles * - * @param TemplateResponseSignerRole[]|null $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template + * @param TemplateResponseSignerRole[]|null $signer_roles _t__TemplateResponse::SIGNER_ROLES * * @return self */ @@ -691,7 +691,7 @@ public function getCcRoles() /** * Sets cc_roles * - * @param TemplateResponseCCRole[]|null $cc_roles an array of the designated CC roles that must be specified when sending a SignatureRequest using this Template + * @param TemplateResponseCCRole[]|null $cc_roles _t__TemplateResponse::CC_ROLES * * @return self */ @@ -718,7 +718,7 @@ public function getDocuments() /** * Sets documents * - * @param TemplateResponseDocument[]|null $documents An array describing each document associated with this Template. Includes form field data for each document. + * @param TemplateResponseDocument[]|null $documents _t__TemplateResponse::DOCUMENTS * * @return self */ @@ -746,7 +746,7 @@ public function getCustomFields() /** * Sets custom_fields * - * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields _t__TemplateResponseCustomField::DESCRIPTION * * @return self * @deprecated @@ -782,7 +782,7 @@ public function getNamedFormFields() /** * Sets named_form_fields * - * @param TemplateResponseDocumentFormFieldBase[]|null $named_form_fields Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + * @param TemplateResponseDocumentFormFieldBase[]|null $named_form_fields _t__TemplateResponseNamedFormField::DESCRIPTION * * @return self * @deprecated @@ -817,7 +817,7 @@ public function getAccounts() /** * Sets accounts * - * @param TemplateResponseAccount[]|null $accounts an array of the Accounts that can use this Template + * @param TemplateResponseAccount[]|null $accounts _t__TemplateResponse::ACCOUNTS * * @return self */ @@ -844,7 +844,7 @@ public function getAttachments() /** * Sets attachments * - * @param SignatureRequestResponseAttachment[]|null $attachments signer attachments + * @param SignatureRequestResponseAttachment[]|null $attachments _t__SignatureRequestResponseAttachment::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseAccount.php b/sdks/php/src/Model/TemplateResponseAccount.php index c2cc5fb9c..c38fb5a1c 100644 --- a/sdks/php/src/Model/TemplateResponseAccount.php +++ b/sdks/php/src/Model/TemplateResponseAccount.php @@ -343,7 +343,7 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id the id of the Account + * @param string|null $account_id _t__TemplateResponseAccount::ACCOUNT_ID * * @return self */ @@ -370,7 +370,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address the email address associated with the Account + * @param string|null $email_address _t__TemplateResponseAccount::EMAIL_ADDRESS * * @return self */ @@ -397,7 +397,7 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked returns `true` if the user has been locked out of their account by a team admin + * @param bool|null $is_locked _t__TemplateResponseAccount::IS_LOCKED * * @return self */ @@ -424,7 +424,7 @@ public function getIsPaidHs() /** * Sets is_paid_hs * - * @param bool|null $is_paid_hs returns `true` if the user has a paid Dropbox Sign account + * @param bool|null $is_paid_hs _t__TemplateResponseAccount::IS_PAID_HS * * @return self */ @@ -451,7 +451,7 @@ public function getIsPaidHf() /** * Sets is_paid_hf * - * @param bool|null $is_paid_hf returns `true` if the user has a paid HelloFax account + * @param bool|null $is_paid_hf _t__TemplateResponseAccount::IS_PAID_HF * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseAccountQuota.php b/sdks/php/src/Model/TemplateResponseAccountQuota.php index f88bd937c..b9a57c199 100644 --- a/sdks/php/src/Model/TemplateResponseAccountQuota.php +++ b/sdks/php/src/Model/TemplateResponseAccountQuota.php @@ -37,7 +37,7 @@ * TemplateResponseAccountQuota Class Doc Comment * * @category Class - * @description An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + * @description _t__TemplateResponseAccountQuota::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -330,7 +330,7 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining + * @param int|null $templates_left _t__TemplateResponseAccountQuota::TEMPLATES_LEFT * * @return self */ @@ -357,7 +357,7 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining + * @param int|null $api_signature_requests_left _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT * * @return self */ @@ -384,7 +384,7 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left signature requests remaining + * @param int|null $documents_left _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT * * @return self */ @@ -411,7 +411,7 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining + * @param int|null $sms_verifications_left _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseCCRole.php b/sdks/php/src/Model/TemplateResponseCCRole.php index a9db0181e..07f4c26fe 100644 --- a/sdks/php/src/Model/TemplateResponseCCRole.php +++ b/sdks/php/src/Model/TemplateResponseCCRole.php @@ -308,7 +308,7 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Role + * @param string|null $name _t__TemplateResponseCCRole::NAME * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocument.php b/sdks/php/src/Model/TemplateResponseDocument.php index c2f75fcf9..1f088c819 100644 --- a/sdks/php/src/Model/TemplateResponseDocument.php +++ b/sdks/php/src/Model/TemplateResponseDocument.php @@ -343,7 +343,7 @@ public function getName() /** * Sets name * - * @param string|null $name name of the associated file + * @param string|null $name _t__TemplateResponseDocument::NAME * * @return self */ @@ -370,7 +370,7 @@ public function getIndex() /** * Sets index * - * @param int|null $index document ordering, the lowest index is displayed first and the highest last (0-based indexing) + * @param int|null $index _t__TemplateResponseDocument::INDEX * * @return self */ @@ -397,7 +397,7 @@ public function getFieldGroups() /** * Sets field_groups * - * @param TemplateResponseDocumentFieldGroup[]|null $field_groups an array of Form Field Group objects + * @param TemplateResponseDocumentFieldGroup[]|null $field_groups _t__TemplateResponseDocument::FIELD_GROUPS * * @return self */ @@ -424,7 +424,7 @@ public function getFormFields() /** * Sets form_fields * - * @param TemplateResponseDocumentFormFieldBase[]|null $form_fields an array of Form Field objects containing the name and type of each named field + * @param TemplateResponseDocumentFormFieldBase[]|null $form_fields _t__TemplateResponseDocumentFormField::DESCRIPTION * * @return self */ @@ -451,7 +451,7 @@ public function getCustomFields() /** * Sets custom_fields * - * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields an array of Form Field objects containing the name and type of each named field + * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields _t__TemplateResponseDocumentCustomField::DESCRIPTION * * @return self */ @@ -478,7 +478,7 @@ public function getStaticFields() /** * Sets static_fields * - * @param TemplateResponseDocumentStaticFieldBase[]|null $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * @param TemplateResponseDocumentStaticFieldBase[]|null $static_fields _t__TemplateResponseDocumentStaticField::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php index 30dcb7f43..9c1bc954a 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php @@ -37,7 +37,7 @@ * TemplateResponseDocumentCustomFieldBase Class Doc Comment * * @category Class - * @description An array of Form Field objects containing the name and type of each named field. + * @description _t__TemplateResponseDocumentCustomField::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -403,7 +403,7 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id the unique ID for this field + * @param string|null $api_id _t__TemplateResponseDocumentCustomField::API_ID * * @return self */ @@ -430,7 +430,7 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Custom Field + * @param string|null $name _t__TemplateResponseDocumentCustomField::NAME * * @return self */ @@ -457,7 +457,7 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * @param string|null $signer _t__TemplateResponseDocumentCustomField::SIGNER * * @return self */ @@ -491,7 +491,7 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this form field + * @param int|null $x _t__TemplateResponseDocumentCustomField::X * * @return self */ @@ -518,7 +518,7 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this form field + * @param int|null $y _t__TemplateResponseDocumentCustomField::Y * * @return self */ @@ -545,7 +545,7 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this form field + * @param int|null $width _t__TemplateResponseDocumentCustomField::WIDTH * * @return self */ @@ -572,7 +572,7 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this form field + * @param int|null $height _t__TemplateResponseDocumentCustomField::HEIGHT * * @return self */ @@ -599,7 +599,7 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool|null $required _t__TemplateResponseDocumentStaticField::REQUIRED * * @return self */ @@ -626,7 +626,7 @@ public function getGroup() /** * Sets group * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null`. + * @param string|null $group _t__TemplateResponseDocumentCustomField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php index 28b195cb6..d7f0d8ce6 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldCheckbox.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentCustomFieldCheckbox Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentCustomFieldBase` + * @description _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -307,7 +307,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + * @param string $type _t__TemplateResponseDocumentCustomField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php index 84beb6eda..2335f0f3d 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentCustomFieldText Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentCustomFieldBase` + * @description _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -335,7 +335,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + * @param string $type _t__TemplateResponseDocumentCustomField::TYPE * * @return self */ @@ -389,7 +389,7 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool|null $is_multiline _t__TemplateResponseDocumentCustomField::IS_MULTILINE * * @return self */ @@ -416,7 +416,7 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int|null $original_font_size _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE * * @return self */ @@ -443,7 +443,7 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string|null $font_family _t__TemplateResponseDocumentCustomField::FONT_FAMILY * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php index b58429dca..df74f02f1 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php @@ -315,7 +315,7 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the form field group + * @param string|null $name _t__TemplateResponseDocumentFieldGroup::NAME * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php index 6c9324b54..5be5bc317 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php @@ -37,7 +37,7 @@ * TemplateResponseDocumentFieldGroupRule Class Doc Comment * * @category Class - * @description The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). + * @description _t__TemplateResponseDocumentFieldGroup::RULE * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -316,7 +316,7 @@ public function getRequirement() /** * Sets requirement * - * @param string|null $requirement 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. + * @param string|null $requirement _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT * * @return self */ @@ -343,7 +343,7 @@ public function getGroupLabel() /** * Sets group_label * - * @param string|null $group_label Name of the group + * @param string|null $group_label _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php index 2562903cf..04f50bbc7 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php @@ -37,7 +37,7 @@ * TemplateResponseDocumentFormFieldBase Class Doc Comment * * @category Class - * @description An array of Form Field objects containing the name and type of each named field. + * @description _t__TemplateResponseDocumentFormField::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -414,7 +414,7 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id a unique id for the form field + * @param string|null $api_id _t__TemplateResponseDocumentFormField::API_ID * * @return self */ @@ -441,7 +441,7 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the form field + * @param string|null $name _t__TemplateResponseDocumentFormField::NAME * * @return self */ @@ -468,7 +468,7 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer the signer of the Form Field + * @param string|null $signer _t__TemplateResponseDocumentFormField::SIGNER * * @return self */ @@ -495,7 +495,7 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this form field + * @param int|null $x _t__TemplateResponseDocumentFormField::X * * @return self */ @@ -522,7 +522,7 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this form field + * @param int|null $y _t__TemplateResponseDocumentFormField::Y * * @return self */ @@ -549,7 +549,7 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this form field + * @param int|null $width _t__TemplateResponseDocumentFormField::WIDTH * * @return self */ @@ -576,7 +576,7 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this form field + * @param int|null $height _t__TemplateResponseDocumentFormField::HEIGHT * * @return self */ @@ -603,7 +603,7 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool|null $required _t__TemplateResponseDocumentFormField::REQUIRED * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php index 3b72e3cc0..5e8b8135c 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentFormFieldCheckbox Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentFormFieldBase` + * @description _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -314,7 +314,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * @param string $type _t__TemplateResponseDocumentFormField::TYPE * * @return self */ @@ -341,7 +341,7 @@ public function getGroup() /** * Sets group * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @param string|null $group _t__TemplateResponseDocumentFormField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php index 342281d3c..ad2346cd0 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentFormFieldDateSigned Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentFormFieldBase` + * @description _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -314,7 +314,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * @param string $type _t__TemplateResponseDocumentFormField::TYPE * * @return self */ @@ -341,7 +341,7 @@ public function getGroup() /** * Sets group * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @param string|null $group _t__TemplateResponseDocumentFormField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php index dd4cfc015..569d56a99 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentFormFieldDropdown Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentFormFieldBase` + * @description _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -314,7 +314,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * @param string $type _t__TemplateResponseDocumentFormField::TYPE * * @return self */ @@ -341,7 +341,7 @@ public function getGroup() /** * Sets group * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @param string|null $group _t__TemplateResponseDocumentFormField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php index 01e3b912c..0c21164e1 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentFormFieldHyperlink Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentFormFieldBase` + * @description _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -342,7 +342,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * @param string $type _t__TemplateResponseDocumentFormField::TYPE * * @return self */ @@ -396,7 +396,7 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool|null $is_multiline _t__TemplateResponseDocumentFormField::IS_MULTILINE * * @return self */ @@ -423,7 +423,7 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int|null $original_font_size _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE * * @return self */ @@ -450,7 +450,7 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string|null $font_family _t__TemplateResponseDocumentFormField::FONT_FAMILY * * @return self */ @@ -477,7 +477,7 @@ public function getGroup() /** * Sets group * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @param string|null $group _t__TemplateResponseDocumentFormField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php index f20e10da5..3b0138cfb 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentFormFieldInitials Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentFormFieldBase` + * @description _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -314,7 +314,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * @param string $type _t__TemplateResponseDocumentFormField::TYPE * * @return self */ @@ -341,7 +341,7 @@ public function getGroup() /** * Sets group * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @param string|null $group _t__TemplateResponseDocumentFormField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php index 5052ea63d..ef8bfcda4 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentFormFieldRadio Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentFormFieldBase` + * @description _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -317,7 +317,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * @param string $type _t__TemplateResponseDocumentFormField::TYPE * * @return self */ @@ -344,7 +344,7 @@ public function getGroup() /** * Sets group * - * @param string $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @param string $group _t__TemplateResponseDocumentFormField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php index 6ba169c16..363a0e333 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentFormFieldSignature Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentFormFieldBase` + * @description _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -314,7 +314,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * @param string $type _t__TemplateResponseDocumentFormField::TYPE * * @return self */ @@ -341,7 +341,7 @@ public function getGroup() /** * Sets group * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @param string|null $group _t__TemplateResponseDocumentFormField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php index 078f5995d..22d1468a8 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentFormFieldText Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentFormFieldBase` + * @description _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -404,7 +404,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + * @param string $type _t__TemplateResponseDocumentFormField::TYPE * * @return self */ @@ -458,7 +458,7 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool|null $is_multiline _t__TemplateResponseDocumentFormField::IS_MULTILINE * * @return self */ @@ -485,7 +485,7 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int|null $original_font_size _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE * * @return self */ @@ -512,7 +512,7 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string|null $font_family _t__TemplateResponseDocumentFormField::FONT_FAMILY * * @return self */ @@ -539,7 +539,7 @@ public function getValidationType() /** * Sets validation_type * - * @param string|null $validation_type Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + * @param string|null $validation_type _t__TemplateResponseDocumentFormField::VALIDATION_TYPE * * @return self */ @@ -583,7 +583,7 @@ public function getValidationCustomRegex() /** * Sets validation_custom_regex * - * @param string|null $validation_custom_regex when `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field + * @param string|null $validation_custom_regex _t__TemplateResponseDocumentFormField::CUSTOM_REGEX * * @return self */ @@ -617,7 +617,7 @@ public function getValidationCustomRegexFormatLabel() /** * Sets validation_custom_regex_format_label * - * @param string|null $validation_custom_regex_format_label when `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern + * @param string|null $validation_custom_regex_format_label _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL * * @return self */ @@ -651,7 +651,7 @@ public function getGroup() /** * Sets group * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @param string|null $group _t__TemplateResponseDocumentFormField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php index fc632b95a..c56811a79 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php @@ -37,7 +37,7 @@ * TemplateResponseDocumentStaticFieldBase Class Doc Comment * * @category Class - * @description An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * @description _t__TemplateResponseDocumentStaticField::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -421,7 +421,7 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id a unique id for the static field + * @param string|null $api_id _t__TemplateResponseDocumentStaticField::API_ID * * @return self */ @@ -448,7 +448,7 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the static field + * @param string|null $name _t__TemplateResponseDocumentStaticField::NAME * * @return self */ @@ -475,7 +475,7 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer the signer of the Static Field + * @param string|null $signer _t__TemplateResponseDocumentStaticField::SIGNER * * @return self */ @@ -502,7 +502,7 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this static field + * @param int|null $x _t__TemplateResponseDocumentStaticField::X * * @return self */ @@ -529,7 +529,7 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this static field + * @param int|null $y _t__TemplateResponseDocumentStaticField::Y * * @return self */ @@ -556,7 +556,7 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this static field + * @param int|null $width _t__TemplateResponseDocumentStaticField::WIDTH * * @return self */ @@ -583,7 +583,7 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this static field + * @param int|null $height _t__TemplateResponseDocumentStaticField::HEIGHT * * @return self */ @@ -610,7 +610,7 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool|null $required _t__TemplateResponseDocumentStaticField::REQUIRED * * @return self */ @@ -637,7 +637,7 @@ public function getGroup() /** * Sets group * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null`. + * @param string|null $group _t__TemplateResponseDocumentStaticField::GROUP * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php index 1f583ce91..d6503d24b 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldCheckbox.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentStaticFieldCheckbox Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentStaticFieldBase` + * @description _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -307,7 +307,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * @param string $type _t__TemplateResponseDocumentStaticField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php index 5ae56b512..c8e8a3c65 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDateSigned.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentStaticFieldDateSigned Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentStaticFieldBase` + * @description _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -307,7 +307,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * @param string $type _t__TemplateResponseDocumentStaticField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php index 8c424a9b2..3c4948f08 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldDropdown.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentStaticFieldDropdown Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentStaticFieldBase` + * @description _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -307,7 +307,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * @param string $type _t__TemplateResponseDocumentStaticField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php index 218bbb068..1c3926f7c 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldHyperlink.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentStaticFieldHyperlink Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentStaticFieldBase` + * @description _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -307,7 +307,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * @param string $type _t__TemplateResponseDocumentStaticField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php index ce7701354..bfafd3965 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldInitials.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentStaticFieldInitials Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentStaticFieldBase` + * @description _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -307,7 +307,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * @param string $type _t__TemplateResponseDocumentStaticField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php index ae47e8afb..1d37d0326 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldRadio.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentStaticFieldRadio Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentStaticFieldBase` + * @description _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -307,7 +307,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * @param string $type _t__TemplateResponseDocumentStaticField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php index c0da5a2d5..041d0c456 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldSignature.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentStaticFieldSignature Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentStaticFieldBase` + * @description _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -307,7 +307,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * @param string $type _t__TemplateResponseDocumentStaticField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php index 246a22dae..c27dc216d 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldText.php @@ -35,7 +35,7 @@ * TemplateResponseDocumentStaticFieldText Class Doc Comment * * @category Class - * @description This class extends `TemplateResponseDocumentStaticFieldBase` + * @description _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -307,7 +307,7 @@ public function getType() /** * Sets type * - * @param string $type The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + * @param string $type _t__TemplateResponseDocumentStaticField::TYPE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php index 6fbb12d83..2ce8ecaa7 100644 --- a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php +++ b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php @@ -37,7 +37,7 @@ * TemplateResponseFieldAvgTextLength Class Doc Comment * * @category Class - * @description Average text length in this field. + * @description _t__TemplateResponseFieldAvgTextLength::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -316,7 +316,7 @@ public function getNumLines() /** * Sets num_lines * - * @param int|null $num_lines number of lines + * @param int|null $num_lines _t__TemplateResponseFieldAvgTextLength::NUM_LINES * * @return self */ @@ -343,7 +343,7 @@ public function getNumCharsPerLine() /** * Sets num_chars_per_line * - * @param int|null $num_chars_per_line number of characters per line + * @param int|null $num_chars_per_line _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE * * @return self */ diff --git a/sdks/php/src/Model/TemplateResponseSignerRole.php b/sdks/php/src/Model/TemplateResponseSignerRole.php index 9d62bf4c7..b13e99b7c 100644 --- a/sdks/php/src/Model/TemplateResponseSignerRole.php +++ b/sdks/php/src/Model/TemplateResponseSignerRole.php @@ -315,7 +315,7 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Role + * @param string|null $name _t__TemplateResponseSignerRole::NAME * * @return self */ @@ -342,7 +342,7 @@ public function getOrder() /** * Sets order * - * @param int|null $order if signer order is assigned this is the 0-based index for this role + * @param int|null $order _t__TemplateResponseSignerRole::ORDER * * @return self */ diff --git a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php index 4f112b637..0bba35183 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php +++ b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php @@ -37,7 +37,7 @@ * TemplateUpdateFilesResponseTemplate Class Doc Comment * * @category Class - * @description Contains template id + * @description _t__TemplateUpdateFilesResponseTemplate::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -316,7 +316,7 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string|null $template_id _t__TemplateResponse::TEMPLATE_ID * * @return self */ @@ -344,7 +344,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self * @deprecated diff --git a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php index 9d42586b0..b0b65f603 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php @@ -65,6 +65,7 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'file_urls' => 'string[]', 'allow_ccs' => 'bool', 'allow_decline' => 'bool', + 'allow_form_view' => 'bool', 'allow_reassign' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', @@ -111,6 +112,7 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'file_urls' => null, 'allow_ccs' => null, 'allow_decline' => null, + 'allow_form_view' => null, 'allow_reassign' => null, 'attachments' => null, 'cc_email_addresses' => 'email', @@ -155,6 +157,7 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'file_urls' => false, 'allow_ccs' => false, 'allow_decline' => false, + 'allow_form_view' => false, 'allow_reassign' => false, 'attachments' => false, 'cc_email_addresses' => false, @@ -271,6 +274,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'file_urls', 'allow_ccs' => 'allow_ccs', 'allow_decline' => 'allow_decline', + 'allow_form_view' => 'allow_form_view', 'allow_reassign' => 'allow_reassign', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', @@ -315,6 +319,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'setFileUrls', 'allow_ccs' => 'setAllowCcs', 'allow_decline' => 'setAllowDecline', + 'allow_form_view' => 'setAllowFormView', 'allow_reassign' => 'setAllowReassign', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', @@ -359,6 +364,7 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'getFileUrls', 'allow_ccs' => 'getAllowCcs', 'allow_decline' => 'getAllowDecline', + 'allow_form_view' => 'getAllowFormView', 'allow_reassign' => 'getAllowReassign', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', @@ -469,6 +475,7 @@ public function __construct(?array $data = null) $this->setIfExists('file_urls', $data ?? [], null); $this->setIfExists('allow_ccs', $data ?? [], true); $this->setIfExists('allow_decline', $data ?? [], false); + $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); @@ -745,6 +752,33 @@ public function setAllowDecline(?bool $allow_decline) return $this; } + /** + * Gets allow_form_view + * + * @return bool|null + */ + public function getAllowFormView() + { + return $this->container['allow_form_view']; + } + + /** + * Sets allow_form_view + * + * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowFormView(?bool $allow_form_view) + { + if (is_null($allow_form_view)) { + throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + } + $this->container['allow_form_view'] = $allow_form_view; + + return $this; + } + /** * Gets allow_reassign * @@ -785,7 +819,7 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments _t__SubAttachment::LIST_DESCRIPTION * * @return self */ @@ -1167,7 +1201,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ @@ -1276,7 +1310,7 @@ public function getSigners() /** * Sets signers * - * @param SubUnclaimedDraftSigner[]|null $signers add Signers to your Unclaimed Draft Signature Request + * @param SubUnclaimedDraftSigner[]|null $signers _t__Sub::UnclaimedDraftSigner::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php index b96ad7c30..f85c9607b 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.php @@ -971,7 +971,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ @@ -1107,7 +1107,7 @@ public function getSigners() /** * Sets signers * - * @param SubUnclaimedDraftTemplateSigner[]|null $signers add Signers to your Templated-based Signature Request + * @param SubUnclaimedDraftTemplateSigner[]|null $signers _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php index 89b665f5c..bf577a222 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php @@ -63,6 +63,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'files' => '\SplFileObject[]', 'file_urls' => 'string[]', 'allow_decline' => 'bool', + 'allow_form_view' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', 'client_id' => 'string', @@ -97,6 +98,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'files' => 'binary', 'file_urls' => null, 'allow_decline' => null, + 'allow_form_view' => null, 'attachments' => null, 'cc_email_addresses' => 'email', 'client_id' => null, @@ -129,6 +131,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'files' => false, 'file_urls' => false, 'allow_decline' => false, + 'allow_form_view' => false, 'attachments' => false, 'cc_email_addresses' => false, 'client_id' => false, @@ -233,6 +236,7 @@ public function isNullableSetToNull(string $property): bool 'files' => 'files', 'file_urls' => 'file_urls', 'allow_decline' => 'allow_decline', + 'allow_form_view' => 'allow_form_view', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', 'client_id' => 'client_id', @@ -265,6 +269,7 @@ public function isNullableSetToNull(string $property): bool 'files' => 'setFiles', 'file_urls' => 'setFileUrls', 'allow_decline' => 'setAllowDecline', + 'allow_form_view' => 'setAllowFormView', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', 'client_id' => 'setClientId', @@ -297,6 +302,7 @@ public function isNullableSetToNull(string $property): bool 'files' => 'getFiles', 'file_urls' => 'getFileUrls', 'allow_decline' => 'getAllowDecline', + 'allow_form_view' => 'getAllowFormView', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', 'client_id' => 'getClientId', @@ -395,6 +401,7 @@ public function __construct(?array $data = null) $this->setIfExists('files', $data ?? [], null); $this->setIfExists('file_urls', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); + $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); $this->setIfExists('client_id', $data ?? [], null); @@ -614,6 +621,33 @@ public function setAllowDecline(?bool $allow_decline) return $this; } + /** + * Gets allow_form_view + * + * @return bool|null + */ + public function getAllowFormView() + { + return $this->container['allow_form_view']; + } + + /** + * Sets allow_form_view + * + * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * + * @return self + */ + public function setAllowFormView(?bool $allow_form_view) + { + if (is_null($allow_form_view)) { + throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + } + $this->container['allow_form_view'] = $allow_form_view; + + return $this; + } + /** * Gets attachments * @@ -627,7 +661,7 @@ public function getAttachments() /** * Sets attachments * - * @param SubAttachment[]|null $attachments A list describing the attachments + * @param SubAttachment[]|null $attachments _t__SubAttachment::LIST_DESCRIPTION * * @return self */ @@ -901,7 +935,7 @@ public function getMetadata() /** * Sets metadata * - * @param array|null $metadata Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @param array|null $metadata _t__Sub::Metadata::DESCRIPTION * * @return self */ @@ -956,7 +990,7 @@ public function getSigners() /** * Sets signers * - * @param SubUnclaimedDraftSigner[]|null $signers add Signers to your Unclaimed Draft Signature Request + * @param SubUnclaimedDraftSigner[]|null $signers _t__Sub::UnclaimedDraftSigner::DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/UnclaimedDraftCreateResponse.php b/sdks/php/src/Model/UnclaimedDraftCreateResponse.php index d6c1043c1..d4fb2c45d 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateResponse.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateResponse.php @@ -347,7 +347,7 @@ public function getWarnings() /** * Sets warnings * - * @param WarningResponse[]|null $warnings a list of warnings + * @param WarningResponse[]|null $warnings _t__WarningResponse::LIST_DESCRIPTION * * @return self */ diff --git a/sdks/php/src/Model/UnclaimedDraftResponse.php b/sdks/php/src/Model/UnclaimedDraftResponse.php index 774aae3f7..29ba00366 100644 --- a/sdks/php/src/Model/UnclaimedDraftResponse.php +++ b/sdks/php/src/Model/UnclaimedDraftResponse.php @@ -37,7 +37,7 @@ * UnclaimedDraftResponse Class Doc Comment * * @category Class - * @description A group of documents that a user can take ownership of via the claim URL. + * @description _t__UnclaimedDraftResponse::DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -344,7 +344,7 @@ public function getSignatureRequestId() /** * Sets signature_request_id * - * @param string|null $signature_request_id the ID of the signature request that is represented by this UnclaimedDraft + * @param string|null $signature_request_id _t__UnclaimedDraft::SIGNATURE_REQUEST_ID * * @return self */ @@ -378,7 +378,7 @@ public function getClaimUrl() /** * Sets claim_url * - * @param string|null $claim_url the URL to be used to claim this UnclaimedDraft + * @param string|null $claim_url _t__UnclaimedDraft::CLAIM_URL * * @return self */ @@ -405,7 +405,7 @@ public function getSigningRedirectUrl() /** * Sets signing_redirect_url * - * @param string|null $signing_redirect_url the URL you want signers redirected to after they successfully sign + * @param string|null $signing_redirect_url _t__UnclaimedDraft::SIGNING_REDIRECT_URL * * @return self */ @@ -439,7 +439,7 @@ public function getRequestingRedirectUrl() /** * Sets requesting_redirect_url * - * @param string|null $requesting_redirect_url The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). + * @param string|null $requesting_redirect_url _t__UnclaimedDraft::REQUESTING_REDIRECT_URL * * @return self */ @@ -473,7 +473,7 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at when the link expires + * @param int|null $expires_at _t__UnclaimedDraft::EXPIRES_AT * * @return self */ @@ -507,7 +507,7 @@ public function getTestMode() /** * Sets test_mode * - * @param bool|null $test_mode Whether this is a test draft. Signature requests made from test drafts have no legal value. + * @param bool|null $test_mode _t__UnclaimedDraft::TEST_MODE * * @return self */ diff --git a/sdks/php/src/Model/WarningResponse.php b/sdks/php/src/Model/WarningResponse.php index 309277392..df3e5ff28 100644 --- a/sdks/php/src/Model/WarningResponse.php +++ b/sdks/php/src/Model/WarningResponse.php @@ -37,7 +37,7 @@ * WarningResponse Class Doc Comment * * @category Class - * @description A list of warnings. + * @description _t__WarningResponse::LIST_DESCRIPTION * @see https://openapi-generator.tech * @implements \ArrayAccess */ @@ -324,7 +324,7 @@ public function getWarningMsg() /** * Sets warning_msg * - * @param string $warning_msg Warning message + * @param string $warning_msg _t__WarningResponse::WARNING_MSG * * @return self */ @@ -351,7 +351,7 @@ public function getWarningName() /** * Sets warning_name * - * @param string $warning_name Warning name + * @param string $warning_name _t__WarningResponse::WARNING_NAME * * @return self */ diff --git a/sdks/python/docs/AccountCreateResponse.md b/sdks/python/docs/AccountCreateResponse.md index 4e24e96e3..33ea98da3 100644 --- a/sdks/python/docs/AccountCreateResponse.md +++ b/sdks/python/docs/AccountCreateResponse.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | | `oauth_data` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/AccountGetResponse.md b/sdks/python/docs/AccountGetResponse.md index 05c765487..cbff0c478 100644 --- a/sdks/python/docs/AccountGetResponse.md +++ b/sdks/python/docs/AccountGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/AccountResponse.md b/sdks/python/docs/AccountResponse.md index fe7f8da48..bfa6dfb95 100644 --- a/sdks/python/docs/AccountResponse.md +++ b/sdks/python/docs/AccountResponse.md @@ -5,16 +5,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```str``` | The ID of the Account | | -| `email_address` | ```str``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `account_id` | ```str``` | _t__Account::ACCOUNT_ID | | +| `email_address` | ```str``` | _t__Account::EMAIL_ADDRESS | | +| `is_locked` | ```bool``` | _t__Account::IS_LOCKED | | +| `is_paid_hs` | ```bool``` | _t__Account::IS_PAID_HS | | +| `is_paid_hf` | ```bool``` | _t__Account::IS_PAID_HF | | | `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | -| `callback_url` | ```str``` | The URL that Dropbox Sign events will `POST` to. | | -| `role_code` | ```str``` | The membership role for the team. | | -| `team_id` | ```str``` | The id of the team account belongs to. | | -| `locale` | ```str``` | 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. | | +| `callback_url` | ```str``` | _t__Account::CALLBACK_URL | | +| `role_code` | ```str``` | _t__Account::ROLE_CODE | | +| `team_id` | ```str``` | _t__Account::TEAM_ID | | +| `locale` | ```str``` | _t__Account::LOCALE | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/AccountResponseQuotas.md b/sdks/python/docs/AccountResponseQuotas.md index c487703cb..92cda723c 100644 --- a/sdks/python/docs/AccountResponseQuotas.md +++ b/sdks/python/docs/AccountResponseQuotas.md @@ -1,16 +1,16 @@ # AccountResponseQuotas -Details concerning remaining monthly quotas. +_t__Account::QUOTA ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `templates_total` | ```int``` | Total API templates allowed. | | -| `templates_left` | ```int``` | API templates remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```int``` | Number of fax pages left | | +| `api_signature_requests_left` | ```int``` | _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documents_left` | ```int``` | _t__AccountQuota::DOCUMENTS_LEFT | | +| `templates_total` | ```int``` | _t__AccountQuota::TEMPLATES_TOTAL | | +| `templates_left` | ```int``` | _t__AccountQuota::TEMPLATES_LEFT | | +| `sms_verifications_left` | ```int``` | _t__AccountQuota::SMS_VERIFICATIONS_LEFT | | +| `num_fax_pages_left` | ```int``` | _t__AccountQuota::NUM_FAX_PAGES_LEFT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/AccountResponseUsage.md b/sdks/python/docs/AccountResponseUsage.md index 62eba4dc0..ad937efff 100644 --- a/sdks/python/docs/AccountResponseUsage.md +++ b/sdks/python/docs/AccountResponseUsage.md @@ -1,11 +1,11 @@ # AccountResponseUsage -Details concerning monthly usage +_t__Account::USAGE ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `fax_pages_sent` | ```int``` | Number of fax pages sent | | +| `fax_pages_sent` | ```int``` | _t__AccountUsage::FAX_PAGES_SENT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/AccountVerifyResponse.md b/sdks/python/docs/AccountVerifyResponse.md index 46194d739..33c00cf96 100644 --- a/sdks/python/docs/AccountVerifyResponse.md +++ b/sdks/python/docs/AccountVerifyResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `account` | [```AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/AccountVerifyResponseAccount.md b/sdks/python/docs/AccountVerifyResponseAccount.md index b2f7d7142..4a1d66844 100644 --- a/sdks/python/docs/AccountVerifyResponseAccount.md +++ b/sdks/python/docs/AccountVerifyResponseAccount.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address` | ```str``` | The email address associated with the Account. | | +| `email_address` | ```str``` | _t__Account::EMAIL_ADDRESS | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ApiAppGetResponse.md b/sdks/python/docs/ApiAppGetResponse.md index d94e9df43..76948a8a7 100644 --- a/sdks/python/docs/ApiAppGetResponse.md +++ b/sdks/python/docs/ApiAppGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `api_app`*_required_ | [```ApiAppResponse```](ApiAppResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ApiAppListResponse.md b/sdks/python/docs/ApiAppListResponse.md index 71bdba50e..cfb53db0d 100644 --- a/sdks/python/docs/ApiAppListResponse.md +++ b/sdks/python/docs/ApiAppListResponse.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_apps`*_required_ | [```List[ApiAppResponse]```](ApiAppResponse.md) | Contains information about API Apps. | | +| `api_apps`*_required_ | [```List[ApiAppResponse]```](ApiAppResponse.md) | _t__ApiAppListResponse::DESCRIPTION | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ApiAppResponse.md b/sdks/python/docs/ApiAppResponse.md index 88660ac54..49e318c7c 100644 --- a/sdks/python/docs/ApiAppResponse.md +++ b/sdks/python/docs/ApiAppResponse.md @@ -1,16 +1,16 @@ # ApiAppResponse -Contains information about an API App. +_t__ApiAppResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```str``` | The app's callback URL (for events) | | -| `client_id` | ```str``` | The app's client id | | -| `created_at` | ```int``` | The time that the app was created | | -| `domains` | ```List[str]``` | The domain name(s) associated with the app | | -| `name` | ```str``` | The name of the app | | -| `is_approved` | ```bool``` | Boolean to indicate if the app has been approved | | +| `callback_url` | ```str``` | _t__ApiAppResponse::CALLBACK_URL | | +| `client_id` | ```str``` | _t__ApiAppResponse::CLIENT_ID | | +| `created_at` | ```int``` | _t__ApiAppResponse::CREATED_AT | | +| `domains` | ```List[str]``` | _t__ApiAppResponse::DOMAINS | | +| `name` | ```str``` | _t__ApiAppResponse::NAME | | +| `is_approved` | ```bool``` | _t__ApiAppResponse::IS_APPROVED | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | | `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | | `owner_account` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | diff --git a/sdks/python/docs/ApiAppResponseOAuth.md b/sdks/python/docs/ApiAppResponseOAuth.md index 58a6a1e16..35a8b16e7 100644 --- a/sdks/python/docs/ApiAppResponseOAuth.md +++ b/sdks/python/docs/ApiAppResponseOAuth.md @@ -1,14 +1,14 @@ # ApiAppResponseOAuth -An object describing the app's OAuth properties, or null if OAuth is not configured for the app. +_t__ApiAppResponseOAuth::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```str``` | The app's OAuth callback URL. | | -| `secret` | ```str``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```List[str]``` | Array of OAuth scopes used by the app. | | -| `charges_users` | ```bool``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callback_url` | ```str``` | _t__ApiAppResponseOAuth::CALLBACK_URL | | +| `secret` | ```str``` | _t__ApiAppResponseOAuth::SECRET | | +| `scopes` | ```List[str]``` | _t__ApiAppResponseOAuth::SCOPES | | +| `charges_users` | ```bool``` | _t__ApiAppResponseOAuth::CHARGES_USERS | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ApiAppResponseOptions.md b/sdks/python/docs/ApiAppResponseOptions.md index a96d6de0b..0c4c33fc5 100644 --- a/sdks/python/docs/ApiAppResponseOptions.md +++ b/sdks/python/docs/ApiAppResponseOptions.md @@ -1,11 +1,11 @@ # ApiAppResponseOptions -An object with options that override account settings. +_t__ApiAppResponseOptions::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere` | ```bool``` | _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ApiAppResponseOwnerAccount.md b/sdks/python/docs/ApiAppResponseOwnerAccount.md index b1cd337a1..9204a97ca 100644 --- a/sdks/python/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/python/docs/ApiAppResponseOwnerAccount.md @@ -1,12 +1,12 @@ # ApiAppResponseOwnerAccount -An object describing the app's owner +_t__ApiAppResponseOwnerAccount::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```str``` | The owner account's ID | | -| `email_address` | ```str``` | The owner account's email address | | +| `account_id` | ```str``` | _t__ApiAppResponseOwnerAccount::ACCOUNT_ID | | +| `email_address` | ```str``` | _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md index ae742c2e9..cc9b8545a 100644 --- a/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/python/docs/ApiAppResponseWhiteLabelingOptions.md @@ -1,6 +1,6 @@ # ApiAppResponseWhiteLabelingOptions -An object with options to customize the app's signer page +_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION ## Properties Name | Type | Description | Notes diff --git a/sdks/python/docs/BulkSendJobGetResponse.md b/sdks/python/docs/BulkSendJobGetResponse.md index 8f141cb2c..f8f8f0716 100644 --- a/sdks/python/docs/BulkSendJobGetResponse.md +++ b/sdks/python/docs/BulkSendJobGetResponse.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `bulk_send_job`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `signature_requests`*_required_ | [```List[BulkSendJobGetResponseSignatureRequests]```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `signature_requests`*_required_ | [```List[BulkSendJobGetResponseSignatureRequests]```](BulkSendJobGetResponseSignatureRequests.md) | _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md index b697653fd..93e0acbc7 100644 --- a/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md @@ -5,31 +5,31 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `test_mode` | ```bool``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to False] | -| `signature_request_id` | ```str``` | The id of the SignatureRequest. | | -| `requester_email_address` | ```str``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```str``` | The title the specified Account uses for the SignatureRequest. | | -| `original_title` | ```str``` | Default Label for account. | | -| `subject` | ```str``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```str``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | The metadata attached to the signature request. | | -| `created_at` | ```int``` | Time the signature request was created. | | -| `expires_at` | ```int``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `is_complete` | ```bool``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `is_declined` | ```bool``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `has_error` | ```bool``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `files_url` | ```str``` | The URL where a copy of the request's documents can be downloaded. | | -| `signing_url` | ```str``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `details_url` | ```str``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `cc_email_addresses` | ```List[str]``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signing_redirect_url` | ```str``` | The URL you want the signer redirected to after they successfully sign. | | -| `final_copy_uri` | ```str``` | The path where the completed document can be downloaded | | -| `template_ids` | ```List[str]``` | Templates IDs used in this SignatureRequest (if any). | | -| `custom_fields` | [```List[SignatureRequestResponseCustomFieldBase]```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `response_data` | [```List[SignatureRequestResponseDataBase]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```List[SignatureRequestResponseSignatures]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulk_send_job_id` | ```str``` | The id of the BulkSendJob. | | +| `test_mode` | ```bool``` | _t__SignatureRequestResponse::TEST_MODE | [default to False] | +| `signature_request_id` | ```str``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requester_email_address` | ```str``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```str``` | _t__SignatureRequestResponse::TITLE | | +| `original_title` | ```str``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```str``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```str``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```Dict[str, object]``` | _t__SignatureRequestResponse::METADATA | | +| `created_at` | ```int``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expires_at` | ```int``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `is_complete` | ```bool``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `is_declined` | ```bool``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `has_error` | ```bool``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `files_url` | ```str``` | _t__SignatureRequestResponse::FILES_URL | | +| `signing_url` | ```str``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `details_url` | ```str``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `cc_email_addresses` | ```List[str]``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signing_redirect_url` | ```str``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `final_copy_uri` | ```str``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `template_ids` | ```List[str]``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `custom_fields` | [```List[SignatureRequestResponseCustomFieldBase]```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `response_data` | [```List[SignatureRequestResponseDataBase]```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```List[SignatureRequestResponseSignatures]```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulk_send_job_id` | ```str``` | _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/BulkSendJobListResponse.md b/sdks/python/docs/BulkSendJobListResponse.md index 2767d7101..a0f8bd946 100644 --- a/sdks/python/docs/BulkSendJobListResponse.md +++ b/sdks/python/docs/BulkSendJobListResponse.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_jobs`*_required_ | [```List[BulkSendJobResponse]```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | +| `bulk_send_jobs`*_required_ | [```List[BulkSendJobResponse]```](BulkSendJobResponse.md) | _t__BulkSendJobListResponse::BULK_SEND_JOBS | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/BulkSendJobResponse.md b/sdks/python/docs/BulkSendJobResponse.md index 11a6322c2..848acd053 100644 --- a/sdks/python/docs/BulkSendJobResponse.md +++ b/sdks/python/docs/BulkSendJobResponse.md @@ -1,14 +1,14 @@ # BulkSendJobResponse -Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. +_t__BulkSendJobResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `bulk_send_job_id` | ```str``` | The id of the BulkSendJob. | | -| `total` | ```int``` | The total amount of Signature Requests queued for sending. | | -| `is_creator` | ```bool``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at` | ```int``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id` | ```str``` | _t__BulkSendJobResponse::BULK_SEND_JOB_ID | | +| `total` | ```int``` | _t__BulkSendJobResponse::TOTAL | | +| `is_creator` | ```bool``` | _t__BulkSendJobResponse::IS_CREATOR | | +| `created_at` | ```int``` | _t__BulkSendJobResponse::CREATED_AT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/BulkSendJobSendResponse.md b/sdks/python/docs/BulkSendJobSendResponse.md index a40845451..6a6bb4475 100644 --- a/sdks/python/docs/BulkSendJobSendResponse.md +++ b/sdks/python/docs/BulkSendJobSendResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `bulk_send_job`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/EmbeddedEditUrlRequest.md b/sdks/python/docs/EmbeddedEditUrlRequest.md index 603d65bcf..bfce12c7f 100644 --- a/sdks/python/docs/EmbeddedEditUrlRequest.md +++ b/sdks/python/docs/EmbeddedEditUrlRequest.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `allow_edit_ccs` | ```bool``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to False] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `cc_roles` | ```List[str]``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to False] | diff --git a/sdks/python/docs/EmbeddedEditUrlResponse.md b/sdks/python/docs/EmbeddedEditUrlResponse.md index 7cf3c1bac..72d9c9e14 100644 --- a/sdks/python/docs/EmbeddedEditUrlResponse.md +++ b/sdks/python/docs/EmbeddedEditUrlResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `embedded`*_required_ | [```EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/EmbeddedEditUrlResponseEmbedded.md b/sdks/python/docs/EmbeddedEditUrlResponseEmbedded.md index f5e819aa7..9676f0298 100644 --- a/sdks/python/docs/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/python/docs/EmbeddedEditUrlResponseEmbedded.md @@ -1,12 +1,12 @@ # EmbeddedEditUrlResponseEmbedded -An embedded template object. +_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `edit_url` | ```str``` | A template url that can be opened in an iFrame. | | -| `expires_at` | ```int``` | The specific time that the the `edit_url` link expires, in epoch. | | +| `edit_url` | ```str``` | _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL | | +| `expires_at` | ```int``` | _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/EmbeddedSignUrlResponse.md b/sdks/python/docs/EmbeddedSignUrlResponse.md index e91d0759a..7c4d475fa 100644 --- a/sdks/python/docs/EmbeddedSignUrlResponse.md +++ b/sdks/python/docs/EmbeddedSignUrlResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `embedded`*_required_ | [```EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/EmbeddedSignUrlResponseEmbedded.md b/sdks/python/docs/EmbeddedSignUrlResponseEmbedded.md index bf6fdbdae..f48a3c9cc 100644 --- a/sdks/python/docs/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/python/docs/EmbeddedSignUrlResponseEmbedded.md @@ -1,12 +1,12 @@ # EmbeddedSignUrlResponseEmbedded -An object that contains necessary information to set up embedded signing. +_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `sign_url` | ```str``` | A signature url that can be opened in an iFrame. | | -| `expires_at` | ```int``` | The specific time that the the `sign_url` link expires, in epoch. | | +| `sign_url` | ```str``` | _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL | | +| `expires_at` | ```int``` | _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ErrorResponseError.md b/sdks/python/docs/ErrorResponseError.md index f6052d69f..46fc8915d 100644 --- a/sdks/python/docs/ErrorResponseError.md +++ b/sdks/python/docs/ErrorResponseError.md @@ -1,13 +1,13 @@ # ErrorResponseError -Contains information about an error that occurred. +_t__ErrorResponseError::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `error_msg`*_required_ | ```str``` | Message describing an error. | | -| `error_name`*_required_ | ```str``` | Name of the error. | | -| `error_path` | ```str``` | Path at which an error occurred. | | +| `error_msg`*_required_ | ```str``` | _t__ErrorResponseError::ERROR_MSG | | +| `error_name`*_required_ | ```str``` | _t__ErrorResponseError::ERROR_NAME | | +| `error_path` | ```str``` | _t__ErrorResponseError::ERROR_PATH | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/EventCallbackRequestEvent.md b/sdks/python/docs/EventCallbackRequestEvent.md index 2675bbf3c..83089c858 100644 --- a/sdks/python/docs/EventCallbackRequestEvent.md +++ b/sdks/python/docs/EventCallbackRequestEvent.md @@ -1,13 +1,13 @@ # EventCallbackRequestEvent -Basic information about the event that occurred. +_t__EventCallbackRequestEvent::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `event_time`*_required_ | ```str``` | Time the event was created (using Unix time). | | -| `event_type`*_required_ | ```str``` | Type of callback event that was triggered. | | -| `event_hash`*_required_ | ```str``` | Generated hash used to verify source of event data. | | +| `event_time`*_required_ | ```str``` | _t__EventCallbackRequestEvent::EVENT_TIME | | +| `event_type`*_required_ | ```str``` | _t__EventCallbackRequestEvent::EVENT_TYPE | | +| `event_hash`*_required_ | ```str``` | _t__EventCallbackRequestEvent::EVENT_HASH | | | `event_metadata` | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/EventCallbackRequestEventMetadata.md b/sdks/python/docs/EventCallbackRequestEventMetadata.md index 35f31bb43..5c4a1e353 100644 --- a/sdks/python/docs/EventCallbackRequestEventMetadata.md +++ b/sdks/python/docs/EventCallbackRequestEventMetadata.md @@ -1,14 +1,14 @@ # EventCallbackRequestEventMetadata -Specific metadata about the event. +_t__EventCallbackRequestEventMetadata::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `related_signature_id` | ```str``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | -| `reported_for_account_id` | ```str``` | Account ID the event was reported for. | | -| `reported_for_app_id` | ```str``` | App ID the event was reported for. | | -| `event_message` | ```str``` | Message about a declined or failed (due to error) signature flow. | | +| `related_signature_id` | ```str``` | _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID | | +| `reported_for_account_id` | ```str``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID | | +| `reported_for_app_id` | ```str``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID | | +| `event_message` | ```str``` | _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/FaxGetResponse.md b/sdks/python/docs/FaxGetResponse.md index 094dc616c..b33c73ea8 100644 --- a/sdks/python/docs/FaxGetResponse.md +++ b/sdks/python/docs/FaxGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/FileResponse.md b/sdks/python/docs/FileResponse.md index 93eb0b683..edcaa5307 100644 --- a/sdks/python/docs/FileResponse.md +++ b/sdks/python/docs/FileResponse.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `file_url`*_required_ | ```str``` | URL to the file. | | -| `expires_at`*_required_ | ```int``` | When the link expires. | | +| `file_url`*_required_ | ```str``` | _t__FileResponse::FILE_URL | | +| `expires_at`*_required_ | ```int``` | _t__FileResponse::EXPIRES_AT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/FileResponseDataUri.md b/sdks/python/docs/FileResponseDataUri.md index fa83a3d4c..1b7047b78 100644 --- a/sdks/python/docs/FileResponseDataUri.md +++ b/sdks/python/docs/FileResponseDataUri.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `data_uri`*_required_ | ```str``` | File as base64 encoded string. | | +| `data_uri`*_required_ | ```str``` | _t__FileResponse::DATA_URI | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ListInfoResponse.md b/sdks/python/docs/ListInfoResponse.md index 5a5fd3257..b32556560 100644 --- a/sdks/python/docs/ListInfoResponse.md +++ b/sdks/python/docs/ListInfoResponse.md @@ -1,14 +1,14 @@ # ListInfoResponse -Contains pagination information about the data returned. +_t__ListInfoResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_pages` | ```int``` | Total number of pages available. | | -| `num_results` | ```int``` | Total number of objects available. | | -| `page` | ```int``` | Number of the page being returned. | | -| `page_size` | ```int``` | Objects returned per page. | | +| `num_pages` | ```int``` | _t__ListInfoResponse::NUM_PAGES | | +| `num_results` | ```int``` | _t__ListInfoResponse::NUM_RESULTS | | +| `page` | ```int``` | _t__ListInfoResponse::PAGE | | +| `page_size` | ```int``` | _t__ListInfoResponse::PAGE_SIZE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/OAuthTokenResponse.md b/sdks/python/docs/OAuthTokenResponse.md index 5bea2b69d..826d180a2 100644 --- a/sdks/python/docs/OAuthTokenResponse.md +++ b/sdks/python/docs/OAuthTokenResponse.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes | `access_token` | ```str``` | | | | `token_type` | ```str``` | | | | `refresh_token` | ```str``` | | | -| `expires_in` | ```int``` | Number of seconds until the `access_token` expires. Uses epoch time. | | +| `expires_in` | ```int``` | _t__OAuthTokenResponse::EXPIRES_IN | | | `state` | ```str``` | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ReportCreateResponse.md b/sdks/python/docs/ReportCreateResponse.md index 46f850877..dbf2411aa 100644 --- a/sdks/python/docs/ReportCreateResponse.md +++ b/sdks/python/docs/ReportCreateResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `report`*_required_ | [```ReportResponse```](ReportResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/ReportResponse.md b/sdks/python/docs/ReportResponse.md index 2215e1f1a..d9498105f 100644 --- a/sdks/python/docs/ReportResponse.md +++ b/sdks/python/docs/ReportResponse.md @@ -1,14 +1,14 @@ # ReportResponse -Contains information about the report request. +_t__ReportResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `success` | ```str``` | A message indicating the requested operation's success | | -| `start_date` | ```str``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | | -| `end_date` | ```str``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | | -| `report_type` | ```List[str]``` | 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). | | +| `success` | ```str``` | _t__ReportResponse::SUCCESS | | +| `start_date` | ```str``` | _t__ReportResponse::START_DATE | | +| `end_date` | ```str``` | _t__ReportResponse::END_DATE | | +| `report_type` | ```List[str]``` | _t__ReportResponse::REPORT_TYPE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/python/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index d09fa3c05..f5905cf53 100644 --- a/sdks/python/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes | `ccs` | [```List[SubCC]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | diff --git a/sdks/python/docs/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/python/docs/SignatureRequestBulkSendWithTemplateRequest.md index 0780a3cea..aae3a1426 100644 --- a/sdks/python/docs/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestBulkSendWithTemplateRequest.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes | `client_id` | ```str``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | diff --git a/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md index 9f2fe0584..6ccdd763b 100644 --- a/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md @@ -8,11 +8,12 @@ Name | Type | Description | Notes | `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to False] | -| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -21,7 +22,7 @@ Name | Type | Description | Notes | `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to False] | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | diff --git a/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 261759720..69dc91425 100644 --- a/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -7,14 +7,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```List[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | | `ccs` | [```List[SubCC]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | diff --git a/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md index 5165d1da6..f28368358 100644 --- a/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md @@ -8,11 +8,12 @@ Name | Type | Description | Notes | `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to False] | -| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -21,7 +22,7 @@ Name | Type | Description | Notes | `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to False] | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | diff --git a/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index c0dcf6fd1..d8288f2da 100644 --- a/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -7,14 +7,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```List[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `client_id`*_required_ | ```str``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | | `ccs` | [```List[SubCC]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | diff --git a/sdks/python/docs/SignatureRequestEditRequest.md b/sdks/python/docs/SignatureRequestEditRequest.md index b4d9783d6..50766b7a1 100644 --- a/sdks/python/docs/SignatureRequestEditRequest.md +++ b/sdks/python/docs/SignatureRequestEditRequest.md @@ -7,11 +7,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | -| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | | `client_id` | ```str``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -22,7 +23,7 @@ Name | Type | Description | Notes | `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to False] | | `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md index 47b6af51b..31604df6e 100644 --- a/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```List[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | | `ccs` | [```List[SubCC]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `client_id` | ```str``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -15,7 +15,7 @@ Name | Type | Description | Notes | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/python/docs/SignatureRequestGetResponse.md b/sdks/python/docs/SignatureRequestGetResponse.md index a464459e9..6891edf89 100644 --- a/sdks/python/docs/SignatureRequestGetResponse.md +++ b/sdks/python/docs/SignatureRequestGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `signature_request`*_required_ | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestListResponse.md b/sdks/python/docs/SignatureRequestListResponse.md index 1bd179bad..9a268e158 100644 --- a/sdks/python/docs/SignatureRequestListResponse.md +++ b/sdks/python/docs/SignatureRequestListResponse.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_requests`*_required_ | [```List[SignatureRequestResponse]```](SignatureRequestResponse.md) | Contains information about signature requests. | | +| `signature_requests`*_required_ | [```List[SignatureRequestResponse]```](SignatureRequestResponse.md) | _t__SignatureRequestListResponse::DESCRIPTION | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponse.md b/sdks/python/docs/SignatureRequestResponse.md index 92a517b3f..8cf2591ae 100644 --- a/sdks/python/docs/SignatureRequestResponse.md +++ b/sdks/python/docs/SignatureRequestResponse.md @@ -1,35 +1,35 @@ # SignatureRequestResponse -Contains information about a signature request. +_t__SignatureRequestResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `test_mode` | ```bool``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to False] | -| `signature_request_id` | ```str``` | The id of the SignatureRequest. | | -| `requester_email_address` | ```str``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```str``` | The title the specified Account uses for the SignatureRequest. | | -| `original_title` | ```str``` | Default Label for account. | | -| `subject` | ```str``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```str``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | The metadata attached to the signature request. | | -| `created_at` | ```int``` | Time the signature request was created. | | -| `expires_at` | ```int``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `is_complete` | ```bool``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `is_declined` | ```bool``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `has_error` | ```bool``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `files_url` | ```str``` | The URL where a copy of the request's documents can be downloaded. | | -| `signing_url` | ```str``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `details_url` | ```str``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `cc_email_addresses` | ```List[str]``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signing_redirect_url` | ```str``` | The URL you want the signer redirected to after they successfully sign. | | -| `final_copy_uri` | ```str``` | The path where the completed document can be downloaded | | -| `template_ids` | ```List[str]``` | Templates IDs used in this SignatureRequest (if any). | | -| `custom_fields` | [```List[SignatureRequestResponseCustomFieldBase]```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `response_data` | [```List[SignatureRequestResponseDataBase]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```List[SignatureRequestResponseSignatures]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulk_send_job_id` | ```str``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `test_mode` | ```bool``` | _t__SignatureRequestResponse::TEST_MODE | [default to False] | +| `signature_request_id` | ```str``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requester_email_address` | ```str``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```str``` | _t__SignatureRequestResponse::TITLE | | +| `original_title` | ```str``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```str``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```str``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```Dict[str, object]``` | _t__SignatureRequestResponse::METADATA | | +| `created_at` | ```int``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expires_at` | ```int``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `is_complete` | ```bool``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `is_declined` | ```bool``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `has_error` | ```bool``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `files_url` | ```str``` | _t__SignatureRequestResponse::FILES_URL | | +| `signing_url` | ```str``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `details_url` | ```str``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `cc_email_addresses` | ```List[str]``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signing_redirect_url` | ```str``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `final_copy_uri` | ```str``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `template_ids` | ```List[str]``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `custom_fields` | [```List[SignatureRequestResponseCustomFieldBase]```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `response_data` | [```List[SignatureRequestResponseDataBase]```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```List[SignatureRequestResponseSignatures]```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulk_send_job_id` | ```str``` | _t__SignatureRequestResponse::BULK_SEND_JOB_ID | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseAttachment.md b/sdks/python/docs/SignatureRequestResponseAttachment.md index 753b0a473..34b7444f2 100644 --- a/sdks/python/docs/SignatureRequestResponseAttachment.md +++ b/sdks/python/docs/SignatureRequestResponseAttachment.md @@ -1,16 +1,16 @@ # SignatureRequestResponseAttachment -Signer attachments. +_t__SignatureRequestResponseAttachment::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `id`*_required_ | ```str``` | The unique ID for this attachment. | | -| `signer`*_required_ | ```str``` | The Signer this attachment is assigned to. | | -| `name`*_required_ | ```str``` | The name of this attachment. | | -| `required`*_required_ | ```bool``` | A boolean value denoting if this attachment is required. | | -| `instructions` | ```str``` | Instructions for Signer. | | -| `uploaded_at` | ```int``` | Timestamp when attachment was uploaded by Signer. | | +| `id`*_required_ | ```str``` | _t__SignatureRequestResponseAttachment::ID | | +| `signer`*_required_ | ```str``` | _t__SignatureRequestResponseAttachment::SIGNER | | +| `name`*_required_ | ```str``` | _t__SignatureRequestResponseAttachment::NAME | | +| `required`*_required_ | ```bool``` | _t__SignatureRequestResponseAttachment::REQUIRED | | +| `instructions` | ```str``` | _t__SignatureRequestResponseAttachment::INSTRUCTIONS | | +| `uploaded_at` | ```int``` | _t__SignatureRequestResponseAttachment::UPLOADED_AT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseCustomFieldBase.md b/sdks/python/docs/SignatureRequestResponseCustomFieldBase.md index 915e6f6ed..b0dab1966 100644 --- a/sdks/python/docs/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/python/docs/SignatureRequestResponseCustomFieldBase.md @@ -1,18 +1,15 @@ # SignatureRequestResponseCustomFieldBase -An array of Custom Field objects containing the name and type of each custom field. - -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` +_t__SignatureRequestResponseCustomField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `name`*_required_ | ```str``` | The name of the Custom Field. | | -| `required` | ```bool``` | A boolean value denoting if this field is required. | | -| `api_id` | ```str``` | The unique ID for this field. | | -| `editor` | ```str``` | The name of the Role that is able to edit this field. | | +| `type`*_required_ | ```str``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `name`*_required_ | ```str``` | _t__SignatureRequestResponseCustomField::NAME | | +| `required` | ```bool``` | _t__SignatureRequestResponseCustomField::REQUIRED | | +| `api_id` | ```str``` | _t__SignatureRequestResponseCustomField::API_ID | | +| `editor` | ```str``` | _t__SignatureRequestResponseCustomField::EDITOR | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/python/docs/SignatureRequestResponseCustomFieldCheckbox.md index fff258579..77525cdac 100644 --- a/sdks/python/docs/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/python/docs/SignatureRequestResponseCustomFieldCheckbox.md @@ -1,12 +1,12 @@ # SignatureRequestResponseCustomFieldCheckbox -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'checkbox'] | -| `value` | ```bool``` | A true/false for checkbox fields | | +| `type`*_required_ | ```str``` | _t__SignatureRequestResponseCustomField::TYPE | [default to 'checkbox'] | +| `value` | ```bool``` | _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseCustomFieldText.md b/sdks/python/docs/SignatureRequestResponseCustomFieldText.md index fee080e57..b08d2fbda 100644 --- a/sdks/python/docs/SignatureRequestResponseCustomFieldText.md +++ b/sdks/python/docs/SignatureRequestResponseCustomFieldText.md @@ -1,12 +1,12 @@ # SignatureRequestResponseCustomFieldText -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'text'] | -| `value` | ```str``` | A text string for text fields | | +| `type`*_required_ | ```str``` | _t__SignatureRequestResponseCustomField::TYPE | [default to 'text'] | +| `value` | ```str``` | _t__SignatureRequestResponseCustomField::VALUE_TEXT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataBase.md b/sdks/python/docs/SignatureRequestResponseDataBase.md index e4bf79185..bb73dd27f 100644 --- a/sdks/python/docs/SignatureRequestResponseDataBase.md +++ b/sdks/python/docs/SignatureRequestResponseDataBase.md @@ -1,14 +1,14 @@ # SignatureRequestResponseDataBase -An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. +_t__SignatureRequestResponseData::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `api_id` | ```str``` | The unique ID for this field. | | -| `signature_id` | ```str``` | The ID of the signature to which this response is linked. | | -| `name` | ```str``` | The name of the form field. | | -| `required` | ```bool``` | A boolean value denoting if this field is required. | | +| `api_id` | ```str``` | _t__SignatureRequestResponseData::API_ID | | +| `signature_id` | ```str``` | _t__SignatureRequestResponseData::SIGNATURE_ID | | +| `name` | ```str``` | _t__SignatureRequestResponseData::NAME | | +| `required` | ```bool``` | _t__SignatureRequestResponseData::REQUIRED | | | `type` | ```str``` | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataValueCheckbox.md b/sdks/python/docs/SignatureRequestResponseDataValueCheckbox.md index 9fe6c8319..082989fbf 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueCheckbox.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```str``` | A yes/no checkbox | [default to 'checkbox'] | -| `value` | ```bool``` | The value of the form field. | | +| `type` | ```str``` | _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE | [default to 'checkbox'] | +| `value` | ```bool``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/python/docs/SignatureRequestResponseDataValueCheckboxMerge.md index 0a4c036ae..87b8dc9f0 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueCheckboxMerge.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```str``` | A checkbox field that has default value set by the api | [default to 'checkbox-merge'] | -| `value` | ```str``` | The value of the form field. | | +| `type` | ```str``` | _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE | [default to 'checkbox-merge'] | +| `value` | ```str``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataValueDateSigned.md b/sdks/python/docs/SignatureRequestResponseDataValueDateSigned.md index d8d9b405b..e0fee09fa 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueDateSigned.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```str``` | A date | [default to 'date_signed'] | -| `value` | ```str``` | The value of the form field. | | +| `type` | ```str``` | _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE | [default to 'date_signed'] | +| `value` | ```str``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataValueDropdown.md b/sdks/python/docs/SignatureRequestResponseDataValueDropdown.md index c588b0c0f..21084731c 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueDropdown.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```str``` | An input field for dropdowns | [default to 'dropdown'] | -| `value` | ```str``` | The value of the form field. | | +| `type` | ```str``` | _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE | [default to 'dropdown'] | +| `value` | ```str``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataValueInitials.md b/sdks/python/docs/SignatureRequestResponseDataValueInitials.md index a3420974d..e37fa4186 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueInitials.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueInitials.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```str``` | An input field for initials | [default to 'initials'] | -| `value` | ```str``` | The value of the form field. | | -| `is_signed` | ```bool``` | This field contains the boolean true if the field is signed. | | +| `type` | ```str``` | _t__SignatureRequestResponseDataValue::INITIAL_TYPE | [default to 'initials'] | +| `value` | ```str``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `is_signed` | ```bool``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataValueRadio.md b/sdks/python/docs/SignatureRequestResponseDataValueRadio.md index 53c6b68db..13f018def 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueRadio.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueRadio.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```str``` | An input field for radios | [default to 'radio'] | -| `value` | ```bool``` | The value of the form field. | | +| `type` | ```str``` | _t__SignatureRequestResponseDataValue::RADIO_TYPE | [default to 'radio'] | +| `value` | ```bool``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataValueSignature.md b/sdks/python/docs/SignatureRequestResponseDataValueSignature.md index bb2603144..a8be42c06 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueSignature.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueSignature.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```str``` | A signature input field | [default to 'signature'] | -| `value` | ```str``` | The value of the form field. | | -| `is_signed` | ```bool``` | This field contains the boolean true if the field is signed. | | +| `type` | ```str``` | _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE | [default to 'signature'] | +| `value` | ```str``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `is_signed` | ```bool``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataValueText.md b/sdks/python/docs/SignatureRequestResponseDataValueText.md index c56a9075c..8b37cc9e8 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueText.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueText.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```str``` | A text input field | [default to 'text'] | -| `value` | ```str``` | The value of the form field. | | +| `type` | ```str``` | _t__SignatureRequestResponseDataValue::TEXT_TYPE | [default to 'text'] | +| `value` | ```str``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseDataValueTextMerge.md b/sdks/python/docs/SignatureRequestResponseDataValueTextMerge.md index 90c9819c1..8fabd96cc 100644 --- a/sdks/python/docs/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/python/docs/SignatureRequestResponseDataValueTextMerge.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type` | ```str``` | A text field that has default text set by the api | [default to 'text-merge'] | -| `value` | ```str``` | The value of the form field. | | +| `type` | ```str``` | _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE | [default to 'text-merge'] | +| `value` | ```str``` | _t__SignatureRequestResponseDataValue::VALUE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponseSignatures.md b/sdks/python/docs/SignatureRequestResponseSignatures.md index fd0ad98af..1bfd26926 100644 --- a/sdks/python/docs/SignatureRequestResponseSignatures.md +++ b/sdks/python/docs/SignatureRequestResponseSignatures.md @@ -1,29 +1,29 @@ # SignatureRequestResponseSignatures -An array of signature objects, 1 for each signer. +_t__SignatureRequestResponseSignatures::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_id` | ```str``` | Signature identifier. | | -| `signer_group_guid` | ```str``` | Signer Group GUID | | -| `signer_email_address` | ```str``` | The email address of the signer. | | -| `signer_name` | ```str``` | The name of the signer. | | -| `signer_role` | ```str``` | The role of the signer. | | -| `order` | ```int``` | If signer order is assigned this is the 0-based index for this signer. | | -| `status_code` | ```str``` | The current status of the signature. eg: awaiting_signature, signed, declined. | | -| `decline_reason` | ```str``` | The reason provided by the signer for declining the request. | | -| `signed_at` | ```int``` | Time that the document was signed or null. | | -| `last_viewed_at` | ```int``` | The time that the document was last viewed by this signer or null. | | -| `last_reminded_at` | ```int``` | The time the last reminder email was sent to the signer or null. | | -| `has_pin` | ```bool``` | Boolean to indicate whether this signature requires a PIN to access. | | -| `has_sms_auth` | ```bool``` | Boolean to indicate whether this signature has SMS authentication enabled. | | -| `has_sms_delivery` | ```bool``` | Boolean to indicate whether this signature has SMS delivery enabled. | | -| `sms_phone_number` | ```str``` | The SMS phone number used for authentication or signature request delivery. | | -| `reassigned_by` | ```str``` | Email address of original signer who reassigned to this signer. | | -| `reassignment_reason` | ```str``` | Reason provided by original signer who reassigned to this signer. | | -| `reassigned_from` | ```str``` | Previous signature identifier. | | -| `error` | ```str``` | Error message pertaining to this signer, or null. | | +| `signature_id` | ```str``` | _t__SignatureRequestResponseSignatures::SIGNATURE_ID | | +| `signer_group_guid` | ```str``` | _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID | | +| `signer_email_address` | ```str``` | _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS | | +| `signer_name` | ```str``` | _t__SignatureRequestResponseSignatures::SIGNER_NAME | | +| `signer_role` | ```str``` | _t__SignatureRequestResponseSignatures::SIGNER_ROLE | | +| `order` | ```int``` | _t__SignatureRequestResponseSignatures::ORDER | | +| `status_code` | ```str``` | _t__SignatureRequestResponseSignatures::STATUS_CODE | | +| `decline_reason` | ```str``` | _t__SignatureRequestResponseSignatures::DECLINE_REASON | | +| `signed_at` | ```int``` | _t__SignatureRequestResponseSignatures::SIGNED_AT | | +| `last_viewed_at` | ```int``` | _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT | | +| `last_reminded_at` | ```int``` | _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT | | +| `has_pin` | ```bool``` | _t__SignatureRequestResponseSignatures::HAS_PIN | | +| `has_sms_auth` | ```bool``` | _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH | | +| `has_sms_delivery` | ```bool``` | _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY | | +| `sms_phone_number` | ```str``` | _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER | | +| `reassigned_by` | ```str``` | _t__SignatureRequestResponseSignatures::REASSIGNED_BY | | +| `reassignment_reason` | ```str``` | _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON | | +| `reassigned_from` | ```str``` | _t__SignatureRequestResponseSignatures::REASSIGNED_FROM | | +| `error` | ```str``` | _t__SignatureRequestResponseSignatures::ERROR | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestSendRequest.md b/sdks/python/docs/SignatureRequestSendRequest.md index 54e5d9d4c..180383429 100644 --- a/sdks/python/docs/SignatureRequestSendRequest.md +++ b/sdks/python/docs/SignatureRequestSendRequest.md @@ -7,11 +7,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | -| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | | `client_id` | ```str``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -23,7 +24,7 @@ Name | Type | Description | Notes | `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | | `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md index 0278d63a8..5c2415206 100644 --- a/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template_ids`*_required_ | ```List[str]``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```List[SubSignatureRequestTemplateSigner]```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | | `ccs` | [```List[SubCC]```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `client_id` | ```str``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -16,7 +16,7 @@ Name | Type | Description | Notes | `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | | `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to False] | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/python/docs/SubFormFieldsPerDocumentBase.md b/sdks/python/docs/SubFormFieldsPerDocumentBase.md index fcd075f4c..3799e77e5 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentBase.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentBase.md @@ -24,9 +24,9 @@ Name | Type | Description | Notes | `required`*_required_ | ```bool``` | Whether this field is required. | | | `signer`*_required_ | ```str``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | | | `type`*_required_ | ```str``` | | | -| `width`*_required_ | ```int``` | Size of the field in pixels. | | -| `x`*_required_ | ```int``` | Location coordinates of the field in pixels. | | -| `y`*_required_ | ```int``` | Location coordinates of the field in pixels. | | +| `width`*_required_ | ```int``` | _t__Sub::FormFieldsPerDocument::WIDTH | | +| `x`*_required_ | ```int``` | _t__Sub::FormFieldsPerDocument::X | | +| `y`*_required_ | ```int``` | _t__Sub::FormFieldsPerDocument::Y | | | `name` | ```str``` | Display name for the field. | | | `page` | ```int``` | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | | diff --git a/sdks/python/docs/SubFormFieldsPerDocumentText.md b/sdks/python/docs/SubFormFieldsPerDocumentText.md index f851ec317..ab7c80ddf 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentText.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentText.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes | `auto_fill_type` | ```str``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | | | `link_id` | ```str``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | | | `masked` | ```bool``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | | -| `validation_type` | ```str``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.

**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | | +| `validation_type` | ```str``` | _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE | | | `validation_custom_regex` | ```str``` | | | | `validation_custom_regex_format_label` | ```str``` | | | | `content` | ```str``` | Content of a `me_now` text field | | diff --git a/sdks/python/docs/SubFormFieldsPerDocumentTextMerge.md b/sdks/python/docs/SubFormFieldsPerDocumentTextMerge.md index fe812d863..fd0847045 100644 --- a/sdks/python/docs/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/python/docs/SubFormFieldsPerDocumentTextMerge.md @@ -5,7 +5,7 @@ This class extends `SubFormFieldsPerDocumentBase`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] | +| `type`*_required_ | ```str``` | _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE | [default to 'text-merge'] | | `font_family` | ```str``` | Font family for the field. | | | `font_size` | ```int``` | 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] | diff --git a/sdks/python/docs/SubMergeField.md b/sdks/python/docs/SubMergeField.md index be4dfd7cf..f0a5ab82a 100644 --- a/sdks/python/docs/SubMergeField.md +++ b/sdks/python/docs/SubMergeField.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```str``` | The name of the merge field. Must be unique. | | -| `type`*_required_ | ```str``` | The type of merge field. | | +| `name`*_required_ | ```str``` | _t__Sub::MergeField::NAME | | +| `type`*_required_ | ```str``` | _t__Sub::MergeField::TYPE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubOAuth.md b/sdks/python/docs/SubOAuth.md index f1d04905a..9220af8c1 100644 --- a/sdks/python/docs/SubOAuth.md +++ b/sdks/python/docs/SubOAuth.md @@ -1,12 +1,12 @@ # SubOAuth -OAuth related parameters. +_t__Sub::OAuth::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `callback_url` | ```str``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | -| `scopes` | ```List[str]``` | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | +| `callback_url` | ```str``` | _t__Sub::OAuth::CALLBACK_URL | | +| `scopes` | ```List[str]``` | _t__Sub::OAuth::SCOPES | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubOptions.md b/sdks/python/docs/SubOptions.md index 871dc60b6..7002330a2 100644 --- a/sdks/python/docs/SubOptions.md +++ b/sdks/python/docs/SubOptions.md @@ -1,11 +1,11 @@ # SubOptions -Additional options supported by API App. +_t__Sub::Options::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `can_insert_everywhere` | ```bool``` | Determines if signers can use "Insert Everywhere" when signing a document. | [default to False] | +| `can_insert_everywhere` | ```bool``` | _t__Sub::Options::CAN_INSERT_EVERYWHERE | [default to False] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubSignatureRequestGroupedSigners.md b/sdks/python/docs/SubSignatureRequestGroupedSigners.md index 0c03df8d4..02dad3b85 100644 --- a/sdks/python/docs/SubSignatureRequestGroupedSigners.md +++ b/sdks/python/docs/SubSignatureRequestGroupedSigners.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `group`*_required_ | ```str``` | The name of the group. | | -| `signers`*_required_ | [```List[SubSignatureRequestSigner]```](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. | | -| `order` | ```int``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | +| `group`*_required_ | ```str``` | _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME | | +| `signers`*_required_ | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestGroupedSigners::SIGNERS | | +| `order` | ```int``` | _t__Sub::SignatureRequestGroupedSigners::ORDER | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubSignatureRequestSigner.md b/sdks/python/docs/SubSignatureRequestSigner.md index 4af8f72e0..612726817 100644 --- a/sdks/python/docs/SubSignatureRequestSigner.md +++ b/sdks/python/docs/SubSignatureRequestSigner.md @@ -5,12 +5,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name`*_required_ | ```str``` | The name of the signer. | | -| `email_address`*_required_ | ```str``` | The email address of the signer. | | -| `order` | ```int``` | The order the signer is required to sign in. | | -| `pin` | ```str``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `sms_phone_number` | ```str``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `sms_phone_number_type` | ```str``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `name`*_required_ | ```str``` | _t__Sub::SignatureRequestSigner::SIGNER_NAME | | +| `email_address`*_required_ | ```str``` | _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS | | +| `order` | ```int``` | _t__Sub::SignatureRequestSigner::SIGNER_ORDER | | +| `pin` | ```str``` | _t__Sub::SignatureRequestSigner::SIGNER_PIN | | +| `sms_phone_number` | ```str``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER | | +| `sms_phone_number_type` | ```str``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubSignatureRequestTemplateSigner.md b/sdks/python/docs/SubSignatureRequestTemplateSigner.md index 392204b1c..a0067afa8 100644 --- a/sdks/python/docs/SubSignatureRequestTemplateSigner.md +++ b/sdks/python/docs/SubSignatureRequestTemplateSigner.md @@ -5,12 +5,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```str``` | Must match an existing role in chosen Template(s). It's case-sensitive. | | -| `name`*_required_ | ```str``` | The name of the signer. | | -| `email_address`*_required_ | ```str``` | The email address of the signer. | | -| `pin` | ```str``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `sms_phone_number` | ```str``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `sms_phone_number_type` | ```str``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `role`*_required_ | ```str``` | _t__Sub::SignatureRequestTemplateSigner::ROLE | | +| `name`*_required_ | ```str``` | _t__Sub::SignatureRequestTemplateSigner::NAME | | +| `email_address`*_required_ | ```str``` | _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS | | +| `pin` | ```str``` | _t__Sub::SignatureRequestTemplateSigner::PIN | | +| `sms_phone_number` | ```str``` | _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER | | +| `sms_phone_number_type` | ```str``` | _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubSigningOptions.md b/sdks/python/docs/SubSigningOptions.md index 9584478ec..f44a73ecf 100644 --- a/sdks/python/docs/SubSigningOptions.md +++ b/sdks/python/docs/SubSigningOptions.md @@ -1,17 +1,15 @@ # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. - -**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +_t__Sub::SigningOptions::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `default_type`*_required_ | ```str``` | The default type shown (limited to the listed types) | | -| `draw` | ```bool``` | Allows drawing the signature | [default to False] | -| `phone` | ```bool``` | Allows using a smartphone to email the signature | [default to False] | -| `type` | ```bool``` | Allows typing the signature | [default to False] | -| `upload` | ```bool``` | Allows uploading the signature | [default to False] | +| `default_type`*_required_ | ```str``` | _t__Sub::SigningOptions::DEFAULT | | +| `draw` | ```bool``` | _t__Sub::SigningOptions::DRAW | [default to False] | +| `phone` | ```bool``` | _t__Sub::SigningOptions::PHONE | [default to False] | +| `type` | ```bool``` | _t__Sub::SigningOptions::TYPE | [default to False] | +| `upload` | ```bool``` | _t__Sub::SigningOptions::UPLOAD | [default to False] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubTeamResponse.md b/sdks/python/docs/SubTeamResponse.md index 750829a35..18afd6679 100644 --- a/sdks/python/docs/SubTeamResponse.md +++ b/sdks/python/docs/SubTeamResponse.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```str``` | The id of a team | | -| `name` | ```str``` | The name of a team | | +| `team_id` | ```str``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```str``` | _t__TeamGeneral::NAME | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubTemplateRole.md b/sdks/python/docs/SubTemplateRole.md index 30a6deb41..f3f29c88d 100644 --- a/sdks/python/docs/SubTemplateRole.md +++ b/sdks/python/docs/SubTemplateRole.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | -| `order` | ```int``` | The order in which this signer role is required to sign. | | +| `name` | ```str``` | _t__Sub::SignerRole::NAME | | +| `order` | ```int``` | _t__Sub::SignerRole::ORDER | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubUnclaimedDraftSigner.md b/sdks/python/docs/SubUnclaimedDraftSigner.md index 636ccf6b9..6c048eecd 100644 --- a/sdks/python/docs/SubUnclaimedDraftSigner.md +++ b/sdks/python/docs/SubUnclaimedDraftSigner.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `email_address`*_required_ | ```str``` | The email address of the signer. | | -| `name`*_required_ | ```str``` | The name of the signer. | | -| `order` | ```int``` | The order the signer is required to sign in. | | +| `email_address`*_required_ | ```str``` | _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS | | +| `name`*_required_ | ```str``` | _t__Sub::UnclaimedDraftSigner::NAME | | +| `order` | ```int``` | _t__Sub::UnclaimedDraftSigner::ORDER | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubUnclaimedDraftTemplateSigner.md b/sdks/python/docs/SubUnclaimedDraftTemplateSigner.md index 80634e817..3d8b36408 100644 --- a/sdks/python/docs/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/python/docs/SubUnclaimedDraftTemplateSigner.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `role`*_required_ | ```str``` | Must match an existing role in chosen Template(s). | | -| `name`*_required_ | ```str``` | The name of the signer filling the role of `role`. | | -| `email_address`*_required_ | ```str``` | The email address of the signer filling the role of `role`. | | +| `role`*_required_ | ```str``` | _t__Sub::UnclaimedDraftTemplateSigner::ROLE | | +| `name`*_required_ | ```str``` | _t__Sub::UnclaimedDraftTemplateSigner::NAME | | +| `email_address`*_required_ | ```str``` | _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SubWhiteLabelingOptions.md b/sdks/python/docs/SubWhiteLabelingOptions.md index 7baf3600c..f076b0a65 100644 --- a/sdks/python/docs/SubWhiteLabelingOptions.md +++ b/sdks/python/docs/SubWhiteLabelingOptions.md @@ -1,8 +1,6 @@ # SubWhiteLabelingOptions -An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) - -Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. +_t__Sub::WhiteLabelingOptions::DESCRIPTION ## Properties Name | Type | Description | Notes @@ -21,7 +19,7 @@ Name | Type | Description | Notes | `secondary_button_text_color_hover` | ```str``` | | [default to '#0061FE'] | | `text_color1` | ```str``` | | [default to '#808080'] | | `text_color2` | ```str``` | | [default to '#ffffff'] | -| `reset_to_default` | ```bool``` | Resets white labeling options to defaults. Only useful when updating an API App. | | +| `reset_to_default` | ```bool``` | _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TeamGetInfoResponse.md b/sdks/python/docs/TeamGetInfoResponse.md index b57b05c46..7e9b994ed 100644 --- a/sdks/python/docs/TeamGetInfoResponse.md +++ b/sdks/python/docs/TeamGetInfoResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `team`*_required_ | [```TeamInfoResponse```](TeamInfoResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TeamGetResponse.md b/sdks/python/docs/TeamGetResponse.md index d7977adac..c947645c3 100644 --- a/sdks/python/docs/TeamGetResponse.md +++ b/sdks/python/docs/TeamGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `team`*_required_ | [```TeamResponse```](TeamResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TeamInfoResponse.md b/sdks/python/docs/TeamInfoResponse.md index ee8991007..22bfbce4e 100644 --- a/sdks/python/docs/TeamInfoResponse.md +++ b/sdks/python/docs/TeamInfoResponse.md @@ -5,11 +5,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```str``` | The id of a team | | +| `team_id` | ```str``` | _t__TeamGeneral::TEAM_ID | | | `team_parent` | [```TeamParentResponse```](TeamParentResponse.md) | | | -| `name` | ```str``` | The name of a team | | -| `num_members` | ```int``` | Number of members within a team | | -| `num_sub_teams` | ```int``` | Number of sub teams within a team | | +| `name` | ```str``` | _t__TeamGeneral::NAME | | +| `num_members` | ```int``` | _t__TeamGeneral::NUM_MEMBERS | | +| `num_sub_teams` | ```int``` | _t__TeamGeneral::NUM_SUB_TEAMS | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TeamParentResponse.md b/sdks/python/docs/TeamParentResponse.md index ba3f06dd2..88f19ce2a 100644 --- a/sdks/python/docs/TeamParentResponse.md +++ b/sdks/python/docs/TeamParentResponse.md @@ -5,8 +5,8 @@ Information about the parent team if a team has one, set to `null` otherwise. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `team_id` | ```str``` | The id of a team | | -| `name` | ```str``` | The name of a team | | +| `team_id` | ```str``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```str``` | _t__TeamGeneral::NAME | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TeamResponse.md b/sdks/python/docs/TeamResponse.md index f8b211bdf..063f5cc6d 100644 --- a/sdks/python/docs/TeamResponse.md +++ b/sdks/python/docs/TeamResponse.md @@ -1,14 +1,14 @@ # TeamResponse -Contains information about your team and its members +_t__TeamResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of your Team | | +| `name` | ```str``` | _t__Team::NAME | | | `accounts` | [```List[AccountResponse]```](AccountResponse.md) | | | -| `invited_accounts` | [```List[AccountResponse]```](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`. | | -| `invited_emails` | ```List[str]``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `invited_accounts` | [```List[AccountResponse]```](AccountResponse.md) | _t__Team::INVITED_ACCOUNTS | | +| `invited_emails` | ```List[str]``` | _t__Team::INVITED_EMAILS | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md index c63d97184..245370cdd 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md @@ -10,7 +10,8 @@ Name | Type | Description | Notes | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to True] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | -| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_roles` | ```List[str]``` | The CC roles that must be assigned when using the template to send a signature request | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -21,7 +22,7 @@ Name | Type | Description | Notes | `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `merge_fields` | [```List[SubMergeField]```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```str``` | The default template email message. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to False] | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to True] | | `signer_roles` | [```List[SubTemplateRole]```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | diff --git a/sdks/python/docs/TemplateCreateEmbeddedDraftResponse.md b/sdks/python/docs/TemplateCreateEmbeddedDraftResponse.md index ecf1a4357..f2f4f7233 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template`*_required_ | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 045277287..ec865bb63 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -1,14 +1,14 @@ # TemplateCreateEmbeddedDraftResponseTemplate -Template object with parameters: `template_id`, `edit_url`, `expires_at`. +_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | -| `edit_url` | ```str``` | Link to edit the template. | | -| `expires_at` | ```int``` | When the link expires. | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `template_id` | ```str``` | _t__TemplateResponse::TEMPLATE_ID | | +| `edit_url` | ```str``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL | | +| `expires_at` | ```int``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateCreateRequest.md b/sdks/python/docs/TemplateCreateRequest.md index a5341c381..62c9f167e 100644 --- a/sdks/python/docs/TemplateCreateRequest.md +++ b/sdks/python/docs/TemplateCreateRequest.md @@ -10,7 +10,8 @@ Name | Type | Description | Notes | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | -| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_roles` | ```List[str]``` | The CC roles that must be assigned when using the template to send a signature request | | | `client_id` | ```str``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -18,7 +19,7 @@ Name | Type | Description | Notes | `form_field_rules` | [```List[SubFormFieldRule]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | | `merge_fields` | [```List[SubMergeField]```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```str``` | The default template email message. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `subject` | ```str``` | The template title (alias). | | | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | diff --git a/sdks/python/docs/TemplateCreateResponse.md b/sdks/python/docs/TemplateCreateResponse.md index c87b262a5..7e9179066 100644 --- a/sdks/python/docs/TemplateCreateResponse.md +++ b/sdks/python/docs/TemplateCreateResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template`*_required_ | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateCreateResponseTemplate.md b/sdks/python/docs/TemplateCreateResponseTemplate.md index 21d6307c7..5968bcf79 100644 --- a/sdks/python/docs/TemplateCreateResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateResponseTemplate.md @@ -1,11 +1,11 @@ # TemplateCreateResponseTemplate -Template object with parameters: `template_id`. +_t__TemplateCreateResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | +| `template_id` | ```str``` | _t__TemplateResponse::TEMPLATE_ID | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateEditResponse.md b/sdks/python/docs/TemplateEditResponse.md index 2384cb094..3e21a24c7 100644 --- a/sdks/python/docs/TemplateEditResponse.md +++ b/sdks/python/docs/TemplateEditResponse.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id`*_required_ | ```str``` | The id of the Template. | | +| `template_id`*_required_ | ```str``` | _t__TemplateResponse::TEMPLATE_ID | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateGetResponse.md b/sdks/python/docs/TemplateGetResponse.md index c208fbbef..3e827d65e 100644 --- a/sdks/python/docs/TemplateGetResponse.md +++ b/sdks/python/docs/TemplateGetResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `template`*_required_ | [```TemplateResponse```](TemplateResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateListResponse.md b/sdks/python/docs/TemplateListResponse.md index 1c3f0b8f5..23052be1b 100644 --- a/sdks/python/docs/TemplateListResponse.md +++ b/sdks/python/docs/TemplateListResponse.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates`*_required_ | [```List[TemplateResponse]```](TemplateResponse.md) | List of templates that the API caller has access to. | | +| `templates`*_required_ | [```List[TemplateResponse]```](TemplateResponse.md) | _t__TemplateListResponse::DESCRIPTION | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponse.md b/sdks/python/docs/TemplateResponse.md index 0eb88aa1b..5725e4d32 100644 --- a/sdks/python/docs/TemplateResponse.md +++ b/sdks/python/docs/TemplateResponse.md @@ -1,26 +1,26 @@ # TemplateResponse -Contains information about the templates you and your team have created. +_t__TemplateResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | -| `title` | ```str``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```str``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `updated_at` | ```int``` | Time the template was last updated. | | -| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | -| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```Dict[str, object]``` | The metadata attached to the template. | | -| `signer_roles` | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `named_form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments` | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `template_id` | ```str``` | _t__TemplateResponse::TEMPLATE_ID | | +| `title` | ```str``` | _t__TemplateResponse::TITLE | | +| `message` | ```str``` | _t__TemplateResponse::MESSAGE | | +| `updated_at` | ```int``` | _t__TemplateResponse::UPDATED_AT | | +| `is_embedded` | ```bool``` | _t__TemplateResponse::IS_EMBEDDED | | +| `is_creator` | ```bool``` | _t__TemplateResponse::IS_CREATOR | | +| `can_edit` | ```bool``` | _t__TemplateResponse::CAN_EDIT | | +| `is_locked` | ```bool``` | _t__TemplateResponse::IS_LOCKED | | +| `metadata` | ```Dict[str, object]``` | _t__TemplateResponse::METADATA | | +| `signer_roles` | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) | _t__TemplateResponse::SIGNER_ROLES | | +| `cc_roles` | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) | _t__TemplateResponse::CC_ROLES | | +| `documents` | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) | _t__TemplateResponse::DOCUMENTS | | +| `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseCustomField::DESCRIPTION | | +| `named_form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseNamedFormField::DESCRIPTION | | +| `accounts` | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | _t__TemplateResponse::ACCOUNTS | | +| `attachments` | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseAccount.md b/sdks/python/docs/TemplateResponseAccount.md index e991a4092..a2e086c45 100644 --- a/sdks/python/docs/TemplateResponseAccount.md +++ b/sdks/python/docs/TemplateResponseAccount.md @@ -5,11 +5,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```str``` | The id of the Account. | | -| `email_address` | ```str``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `account_id` | ```str``` | _t__TemplateResponseAccount::ACCOUNT_ID | | +| `email_address` | ```str``` | _t__TemplateResponseAccount::EMAIL_ADDRESS | | +| `is_locked` | ```bool``` | _t__TemplateResponseAccount::IS_LOCKED | | +| `is_paid_hs` | ```bool``` | _t__TemplateResponseAccount::IS_PAID_HS | | +| `is_paid_hf` | ```bool``` | _t__TemplateResponseAccount::IS_PAID_HF | | | `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseAccountQuota.md b/sdks/python/docs/TemplateResponseAccountQuota.md index 1af33065a..d7fbeebe3 100644 --- a/sdks/python/docs/TemplateResponseAccountQuota.md +++ b/sdks/python/docs/TemplateResponseAccountQuota.md @@ -1,14 +1,14 @@ # TemplateResponseAccountQuota -An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. +_t__TemplateResponseAccountQuota::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left` | ```int``` | API templates remaining. | | -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `templates_left` | ```int``` | _t__TemplateResponseAccountQuota::TEMPLATES_LEFT | | +| `api_signature_requests_left` | ```int``` | _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documents_left` | ```int``` | _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT | | +| `sms_verifications_left` | ```int``` | _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseCCRole.md b/sdks/python/docs/TemplateResponseCCRole.md index 68b6feafe..be95a5cfd 100644 --- a/sdks/python/docs/TemplateResponseCCRole.md +++ b/sdks/python/docs/TemplateResponseCCRole.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of the Role. | | +| `name` | ```str``` | _t__TemplateResponseCCRole::NAME | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocument.md b/sdks/python/docs/TemplateResponseDocument.md index 7e16172f3..51de7947b 100644 --- a/sdks/python/docs/TemplateResponseDocument.md +++ b/sdks/python/docs/TemplateResponseDocument.md @@ -5,12 +5,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | Name of the associated file. | | -| `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```List[TemplateResponseDocumentFieldGroup]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```List[TemplateResponseDocumentStaticFieldBase]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```str``` | _t__TemplateResponseDocument::NAME | | +| `index` | ```int``` | _t__TemplateResponseDocument::INDEX | | +| `field_groups` | [```List[TemplateResponseDocumentFieldGroup]```](TemplateResponseDocumentFieldGroup.md) | _t__TemplateResponseDocument::FIELD_GROUPS | | +| `form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseDocumentFormField::DESCRIPTION | | +| `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseDocumentCustomField::DESCRIPTION | | +| `static_fields` | [```List[TemplateResponseDocumentStaticFieldBase]```](TemplateResponseDocumentStaticFieldBase.md) | _t__TemplateResponseDocumentStaticField::DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md index 577319835..89901409c 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md @@ -1,20 +1,20 @@ # TemplateResponseDocumentCustomFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentCustomField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | | | -| `api_id` | ```str``` | The unique ID for this field. | | -| `name` | ```str``` | The name of the Custom Field. | | -| `signer` | ```str``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `api_id` | ```str``` | _t__TemplateResponseDocumentCustomField::API_ID | | +| `name` | ```str``` | _t__TemplateResponseDocumentCustomField::NAME | | +| `signer` | ```str``` | _t__TemplateResponseDocumentCustomField::SIGNER | | +| `x` | ```int``` | _t__TemplateResponseDocumentCustomField::X | | +| `y` | ```int``` | _t__TemplateResponseDocumentCustomField::Y | | +| `width` | ```int``` | _t__TemplateResponseDocumentCustomField::WIDTH | | +| `height` | ```int``` | _t__TemplateResponseDocumentCustomField::HEIGHT | | +| `required` | ```bool``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```str``` | _t__TemplateResponseDocumentCustomField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldCheckbox.md index 121a63e86..daebdcfe2 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -1,11 +1,11 @@ # TemplateResponseDocumentCustomFieldCheckbox -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'checkbox'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentCustomField::TYPE | [default to 'checkbox'] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md index 72b1d3edf..8f0aad4d4 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md @@ -1,15 +1,15 @@ # TemplateResponseDocumentCustomFieldText -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentCustomField::TYPE | [default to 'text'] | | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```str``` | Font family used in this form field's text. | | +| `is_multiline` | ```bool``` | _t__TemplateResponseDocumentCustomField::IS_MULTILINE | | +| `original_font_size` | ```int``` | _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE | | +| `font_family` | ```str``` | _t__TemplateResponseDocumentCustomField::FONT_FAMILY | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFieldGroup.md b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md index ec90f2362..8598c81fa 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of the form field group. | | +| `name` | ```str``` | _t__TemplateResponseDocumentFieldGroup::NAME | | | `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md index c23407f0e..e0abeb818 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md @@ -1,12 +1,12 @@ # TemplateResponseDocumentFieldGroupRule -The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). +_t__TemplateResponseDocumentFieldGroup::RULE ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement` | ```str``` | 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. | | -| `group_label` | ```str``` | Name of the group | | +| `requirement` | ```str``` | _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT | | +| `group_label` | ```str``` | _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md index 32e2d5dd9..0e8cc4c2f 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md @@ -1,19 +1,19 @@ # TemplateResponseDocumentFormFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentFormField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | | | -| `api_id` | ```str``` | A unique id for the form field. | | -| `name` | ```str``` | The name of the form field. | | -| `signer` | ```str``` | The signer of the Form Field. | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```str``` | _t__TemplateResponseDocumentFormField::API_ID | | +| `name` | ```str``` | _t__TemplateResponseDocumentFormField::NAME | | +| `signer` | ```str``` | _t__TemplateResponseDocumentFormField::SIGNER | | +| `x` | ```int``` | _t__TemplateResponseDocumentFormField::X | | +| `y` | ```int``` | _t__TemplateResponseDocumentFormField::Y | | +| `width` | ```int``` | _t__TemplateResponseDocumentFormField::WIDTH | | +| `height` | ```int``` | _t__TemplateResponseDocumentFormField::HEIGHT | | +| `required` | ```bool``` | _t__TemplateResponseDocumentFormField::REQUIRED | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md index 946f83a2e..c783510d9 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -1,12 +1,12 @@ # TemplateResponseDocumentFormFieldCheckbox -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'checkbox'] | +| `group` | ```str``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md index 9ab442e73..db81a651f 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -1,12 +1,12 @@ # TemplateResponseDocumentFormFieldDateSigned -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'date_signed'] | +| `group` | ```str``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md index 2a472ec24..bcadc6b67 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -1,12 +1,12 @@ # TemplateResponseDocumentFormFieldDropdown -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'dropdown'] | +| `group` | ```str``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md index c85e5e56e..facd0143f 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -1,16 +1,16 @@ # TemplateResponseDocumentFormFieldHyperlink -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'hyperlink'] | | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```str``` | Font family used in this form field's text. | | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `is_multiline` | ```bool``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `original_font_size` | ```int``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `font_family` | ```str``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `group` | ```str``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md index a186404fa..5ffa2ac63 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md @@ -1,12 +1,12 @@ # TemplateResponseDocumentFormFieldInitials -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'initials'] | +| `group` | ```str``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md index 67e78b5c9..e602cd8c5 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md @@ -1,12 +1,12 @@ # TemplateResponseDocumentFormFieldRadio -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | -| `group`*_required_ | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'radio'] | +| `group`*_required_ | ```str``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md index 1540a03b3..794dc3540 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md @@ -1,12 +1,12 @@ # TemplateResponseDocumentFormFieldSignature -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'signature'] | +| `group` | ```str``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFormFieldText.md b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md index c0ed796ca..f72f16c01 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md @@ -1,19 +1,19 @@ # TemplateResponseDocumentFormFieldText -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'text'] | | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```str``` | Font family used in this form field's text. | | -| `validation_type` | ```str``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | -| `validation_custom_regex` | ```str``` | When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. | | -| `validation_custom_regex_format_label` | ```str``` | When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. | | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `is_multiline` | ```bool``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `original_font_size` | ```int``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `font_family` | ```str``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `validation_type` | ```str``` | _t__TemplateResponseDocumentFormField::VALIDATION_TYPE | | +| `validation_custom_regex` | ```str``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX | | +| `validation_custom_regex_format_label` | ```str``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL | | +| `group` | ```str``` | _t__TemplateResponseDocumentFormField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md index bbeb828e4..9b24fd39c 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md @@ -1,20 +1,20 @@ # TemplateResponseDocumentStaticFieldBase -An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. +_t__TemplateResponseDocumentStaticField::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | | | -| `api_id` | ```str``` | A unique id for the static field. | | -| `name` | ```str``` | The name of the static field. | | -| `signer` | ```str``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```int``` | The horizontal offset in pixels for this static field. | | -| `y` | ```int``` | The vertical offset in pixels for this static field. | | -| `width` | ```int``` | The width in pixels of this static field. | | -| `height` | ```int``` | The height in pixels of this static field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `api_id` | ```str``` | _t__TemplateResponseDocumentStaticField::API_ID | | +| `name` | ```str``` | _t__TemplateResponseDocumentStaticField::NAME | | +| `signer` | ```str``` | _t__TemplateResponseDocumentStaticField::SIGNER | [default to 'me_now'] | +| `x` | ```int``` | _t__TemplateResponseDocumentStaticField::X | | +| `y` | ```int``` | _t__TemplateResponseDocumentStaticField::Y | | +| `width` | ```int``` | _t__TemplateResponseDocumentStaticField::WIDTH | | +| `height` | ```int``` | _t__TemplateResponseDocumentStaticField::HEIGHT | | +| `required` | ```bool``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```str``` | _t__TemplateResponseDocumentStaticField::GROUP | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldCheckbox.md index 1b2931db6..b3964a2ef 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -1,11 +1,11 @@ # TemplateResponseDocumentStaticFieldCheckbox -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'checkbox'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'checkbox'] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldDateSigned.md index b03c2f7b0..302becbd3 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -1,11 +1,11 @@ # TemplateResponseDocumentStaticFieldDateSigned -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'date_signed'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'date_signed'] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldDropdown.md index 13d21c1c9..d60ec11c8 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -1,11 +1,11 @@ # TemplateResponseDocumentStaticFieldDropdown -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'dropdown'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'dropdown'] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldHyperlink.md index 76e556a1a..38055eba7 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -1,11 +1,11 @@ # TemplateResponseDocumentStaticFieldHyperlink -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'hyperlink'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'hyperlink'] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldInitials.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldInitials.md index 11746ca49..1d3ec550f 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -1,11 +1,11 @@ # TemplateResponseDocumentStaticFieldInitials -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'initials'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'initials'] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldRadio.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldRadio.md index 484053c8e..221039acf 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -1,11 +1,11 @@ # TemplateResponseDocumentStaticFieldRadio -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'radio'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'radio'] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldSignature.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldSignature.md index 18682b350..1a4dd5cd5 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -1,11 +1,11 @@ # TemplateResponseDocumentStaticFieldSignature -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'signature'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'signature'] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentStaticFieldText.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldText.md index 36887588d..69680396f 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldText.md @@ -1,11 +1,11 @@ # TemplateResponseDocumentStaticFieldText -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `type`*_required_ | ```str``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'text'] | +| `type`*_required_ | ```str``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'text'] | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseFieldAvgTextLength.md b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md index 231267889..ef3353f32 100644 --- a/sdks/python/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md @@ -1,12 +1,12 @@ # TemplateResponseFieldAvgTextLength -Average text length in this field. +_t__TemplateResponseFieldAvgTextLength::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines` | ```int``` | Number of lines. | | -| `num_chars_per_line` | ```int``` | Number of characters per line. | | +| `num_lines` | ```int``` | _t__TemplateResponseFieldAvgTextLength::NUM_LINES | | +| `num_chars_per_line` | ```int``` | _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseSignerRole.md b/sdks/python/docs/TemplateResponseSignerRole.md index 060870d39..683bac16d 100644 --- a/sdks/python/docs/TemplateResponseSignerRole.md +++ b/sdks/python/docs/TemplateResponseSignerRole.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of the Role. | | -| `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | +| `name` | ```str``` | _t__TemplateResponseSignerRole::NAME | | +| `order` | ```int``` | _t__TemplateResponseSignerRole::ORDER | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md index 4c9521e46..5fb358a77 100644 --- a/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md @@ -1,12 +1,12 @@ # TemplateUpdateFilesResponseTemplate -Contains template id +_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `template_id` | ```str``` | _t__TemplateResponse::TEMPLATE_ID | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md index 49704d25b..10eefbcc2 100644 --- a/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -11,8 +11,9 @@ Name | Type | Description | Notes | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to True] | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | -| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -26,11 +27,11 @@ Name | Type | Description | Notes | `hold_request` | ```bool``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to False] | | `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to False] | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `requesting_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully request a signature. | | | `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to True] | -| `signers` | [```List[SubUnclaimedDraftSigner]```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```List[SubUnclaimedDraftSigner]```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to False] | diff --git a/sdks/python/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/python/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index 88a201846..8f3069678 100644 --- a/sdks/python/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -21,12 +21,12 @@ Name | Type | Description | Notes | `hold_request` | ```bool``` | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to False] | | `is_for_embedded_signing` | ```bool``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to False] | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `preview_only` | ```bool``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | [default to False] | | `requesting_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully request a signature. | | | `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to False] | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to True] | -| `signers` | [```List[SubUnclaimedDraftTemplateSigner]```](SubUnclaimedDraftTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers` | [```List[SubUnclaimedDraftTemplateSigner]```](SubUnclaimedDraftTemplateSigner.md) | _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `skip_me_now` | ```bool``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to False] | diff --git a/sdks/python/docs/UnclaimedDraftCreateRequest.md b/sdks/python/docs/UnclaimedDraftCreateRequest.md index 2d84e6ea7..ea42f123a 100644 --- a/sdks/python/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateRequest.md @@ -9,7 +9,8 @@ Name | Type | Description | Notes | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | -| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | +| `attachments` | [```List[SubAttachment]```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | | `client_id` | ```str``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -19,9 +20,9 @@ Name | Type | Description | Notes | `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hide_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to False] | | `message` | ```str``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Dict[str, object]``` | _t__Sub::Metadata::DESCRIPTION | | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to True] | -| `signers` | [```List[SubUnclaimedDraftSigner]```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```List[SubUnclaimedDraftSigner]```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/python/docs/UnclaimedDraftCreateResponse.md b/sdks/python/docs/UnclaimedDraftCreateResponse.md index 41fbc8371..aeb84e078 100644 --- a/sdks/python/docs/UnclaimedDraftCreateResponse.md +++ b/sdks/python/docs/UnclaimedDraftCreateResponse.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `unclaimed_draft`*_required_ | [```UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | -| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/UnclaimedDraftResponse.md b/sdks/python/docs/UnclaimedDraftResponse.md index 561d632e2..d4e7b6772 100644 --- a/sdks/python/docs/UnclaimedDraftResponse.md +++ b/sdks/python/docs/UnclaimedDraftResponse.md @@ -1,16 +1,16 @@ # UnclaimedDraftResponse -A group of documents that a user can take ownership of via the claim URL. +_t__UnclaimedDraftResponse::DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `signature_request_id` | ```str``` | The ID of the signature request that is represented by this UnclaimedDraft. | | -| `claim_url` | ```str``` | The URL to be used to claim this UnclaimedDraft. | | -| `signing_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully sign. | | -| `requesting_redirect_url` | ```str``` | The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). | | -| `expires_at` | ```int``` | When the link expires. | | -| `test_mode` | ```bool``` | Whether this is a test draft. Signature requests made from test drafts have no legal value. | | +| `signature_request_id` | ```str``` | _t__UnclaimedDraft::SIGNATURE_REQUEST_ID | | +| `claim_url` | ```str``` | _t__UnclaimedDraft::CLAIM_URL | | +| `signing_redirect_url` | ```str``` | _t__UnclaimedDraft::SIGNING_REDIRECT_URL | | +| `requesting_redirect_url` | ```str``` | _t__UnclaimedDraft::REQUESTING_REDIRECT_URL | | +| `expires_at` | ```int``` | _t__UnclaimedDraft::EXPIRES_AT | | +| `test_mode` | ```bool``` | _t__UnclaimedDraft::TEST_MODE | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/WarningResponse.md b/sdks/python/docs/WarningResponse.md index c015bda8b..c11503533 100644 --- a/sdks/python/docs/WarningResponse.md +++ b/sdks/python/docs/WarningResponse.md @@ -1,12 +1,12 @@ # WarningResponse -A list of warnings. +_t__WarningResponse::LIST_DESCRIPTION ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `warning_msg`*_required_ | ```str``` | Warning message | | -| `warning_name`*_required_ | ```str``` | Warning name | | +| `warning_msg`*_required_ | ```str``` | _t__WarningResponse::WARNING_MSG | | +| `warning_name`*_required_ | ```str``` | _t__WarningResponse::WARNING_NAME | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/dropbox_sign/models/account_create_response.py b/sdks/python/dropbox_sign/models/account_create_response.py index 3bcabfd76..983492f09 100644 --- a/sdks/python/dropbox_sign/models/account_create_response.py +++ b/sdks/python/dropbox_sign/models/account_create_response.py @@ -38,7 +38,7 @@ class AccountCreateResponse(BaseModel): account: AccountResponse oauth_data: Optional[OAuthTokenResponse] = None warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["account", "oauth_data", "warnings"] diff --git a/sdks/python/dropbox_sign/models/account_get_response.py b/sdks/python/dropbox_sign/models/account_get_response.py index 9a12adb80..695ca8c3e 100644 --- a/sdks/python/dropbox_sign/models/account_get_response.py +++ b/sdks/python/dropbox_sign/models/account_get_response.py @@ -36,7 +36,7 @@ class AccountGetResponse(BaseModel): account: AccountResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["account", "warnings"] diff --git a/sdks/python/dropbox_sign/models/account_response.py b/sdks/python/dropbox_sign/models/account_response.py index 527377330..ee633aa63 100644 --- a/sdks/python/dropbox_sign/models/account_response.py +++ b/sdks/python/dropbox_sign/models/account_response.py @@ -35,37 +35,31 @@ class AccountResponse(BaseModel): """ # noqa: E501 account_id: Optional[StrictStr] = Field( - default=None, description="The ID of the Account" + default=None, description="_t__Account::ACCOUNT_ID" ) email_address: Optional[StrictStr] = Field( - default=None, description="The email address associated with the Account." + default=None, description="_t__Account::EMAIL_ADDRESS" ) is_locked: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has been locked out of their account by a team admin.", + default=None, description="_t__Account::IS_LOCKED" ) is_paid_hs: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has a paid Dropbox Sign account.", + default=None, description="_t__Account::IS_PAID_HS" ) is_paid_hf: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has a paid HelloFax account.", + default=None, description="_t__Account::IS_PAID_HF" ) quotas: Optional[AccountResponseQuotas] = None callback_url: Optional[StrictStr] = Field( - default=None, description="The URL that Dropbox Sign events will `POST` to." + default=None, description="_t__Account::CALLBACK_URL" ) role_code: Optional[StrictStr] = Field( - default=None, description="The membership role for the team." + default=None, description="_t__Account::ROLE_CODE" ) team_id: Optional[StrictStr] = Field( - default=None, description="The id of the team account belongs to." - ) - locale: Optional[StrictStr] = Field( - default=None, - description="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.", + default=None, description="_t__Account::TEAM_ID" ) + locale: Optional[StrictStr] = Field(default=None, description="_t__Account::LOCALE") usage: Optional[AccountResponseUsage] = None __properties: ClassVar[List[str]] = [ "account_id", diff --git a/sdks/python/dropbox_sign/models/account_response_quotas.py b/sdks/python/dropbox_sign/models/account_response_quotas.py index d2b2ffbb0..bcf88b2e4 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -29,26 +29,26 @@ class AccountResponseQuotas(BaseModel): """ - Details concerning remaining monthly quotas. + _t__Account::QUOTA """ # noqa: E501 api_signature_requests_left: Optional[StrictInt] = Field( - default=None, description="API signature requests remaining." + default=None, description="_t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT" ) documents_left: Optional[StrictInt] = Field( - default=None, description="Signature requests remaining." + default=None, description="_t__AccountQuota::DOCUMENTS_LEFT" ) templates_total: Optional[StrictInt] = Field( - default=None, description="Total API templates allowed." + default=None, description="_t__AccountQuota::TEMPLATES_TOTAL" ) templates_left: Optional[StrictInt] = Field( - default=None, description="API templates remaining." + default=None, description="_t__AccountQuota::TEMPLATES_LEFT" ) sms_verifications_left: Optional[StrictInt] = Field( - default=None, description="SMS verifications remaining." + default=None, description="_t__AccountQuota::SMS_VERIFICATIONS_LEFT" ) num_fax_pages_left: Optional[StrictInt] = Field( - default=None, description="Number of fax pages left" + default=None, description="_t__AccountQuota::NUM_FAX_PAGES_LEFT" ) __properties: ClassVar[List[str]] = [ "api_signature_requests_left", diff --git a/sdks/python/dropbox_sign/models/account_response_usage.py b/sdks/python/dropbox_sign/models/account_response_usage.py index 6fc759346..2c189e4c8 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -29,11 +29,11 @@ class AccountResponseUsage(BaseModel): """ - Details concerning monthly usage + _t__Account::USAGE """ # noqa: E501 fax_pages_sent: Optional[StrictInt] = Field( - default=None, description="Number of fax pages sent" + default=None, description="_t__AccountUsage::FAX_PAGES_SENT" ) __properties: ClassVar[List[str]] = ["fax_pages_sent"] diff --git a/sdks/python/dropbox_sign/models/account_verify_response.py b/sdks/python/dropbox_sign/models/account_verify_response.py index 3b0ee8ddf..87d548101 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response.py +++ b/sdks/python/dropbox_sign/models/account_verify_response.py @@ -38,7 +38,7 @@ class AccountVerifyResponse(BaseModel): account: Optional[AccountVerifyResponseAccount] = None warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["account", "warnings"] diff --git a/sdks/python/dropbox_sign/models/account_verify_response_account.py b/sdks/python/dropbox_sign/models/account_verify_response_account.py index 98f5fb302..67bb8001a 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response_account.py +++ b/sdks/python/dropbox_sign/models/account_verify_response_account.py @@ -33,7 +33,7 @@ class AccountVerifyResponseAccount(BaseModel): """ # noqa: E501 email_address: Optional[StrictStr] = Field( - default=None, description="The email address associated with the Account." + default=None, description="_t__Account::EMAIL_ADDRESS" ) __properties: ClassVar[List[str]] = ["email_address"] diff --git a/sdks/python/dropbox_sign/models/api_app_create_request.py b/sdks/python/dropbox_sign/models/api_app_create_request.py index 2e8e6a77b..788c74a23 100644 --- a/sdks/python/dropbox_sign/models/api_app_create_request.py +++ b/sdks/python/dropbox_sign/models/api_app_create_request.py @@ -36,7 +36,7 @@ class ApiAppCreateRequest(BaseModel): ApiAppCreateRequest """ # noqa: E501 - domains: Annotated[List[StrictStr], Field(min_length=1, max_length=2)] = Field( + domains: Annotated[List[StrictStr], Field(min_length=1, max_length=10)] = Field( description="The domain names the ApiApp will be associated with." ) name: StrictStr = Field(description="The name you want to assign to the ApiApp.") diff --git a/sdks/python/dropbox_sign/models/api_app_get_response.py b/sdks/python/dropbox_sign/models/api_app_get_response.py index 4337be1ee..8b52a12fe 100644 --- a/sdks/python/dropbox_sign/models/api_app_get_response.py +++ b/sdks/python/dropbox_sign/models/api_app_get_response.py @@ -36,7 +36,7 @@ class ApiAppGetResponse(BaseModel): api_app: ApiAppResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["api_app", "warnings"] diff --git a/sdks/python/dropbox_sign/models/api_app_list_response.py b/sdks/python/dropbox_sign/models/api_app_list_response.py index 98a950e09..a99a86ebf 100644 --- a/sdks/python/dropbox_sign/models/api_app_list_response.py +++ b/sdks/python/dropbox_sign/models/api_app_list_response.py @@ -36,11 +36,11 @@ class ApiAppListResponse(BaseModel): """ # noqa: E501 api_apps: List[ApiAppResponse] = Field( - description="Contains information about API Apps." + description="_t__ApiAppListResponse::DESCRIPTION" ) list_info: ListInfoResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["api_apps", "list_info", "warnings"] diff --git a/sdks/python/dropbox_sign/models/api_app_response.py b/sdks/python/dropbox_sign/models/api_app_response.py index ad4e87207..09a9eccf1 100644 --- a/sdks/python/dropbox_sign/models/api_app_response.py +++ b/sdks/python/dropbox_sign/models/api_app_response.py @@ -37,24 +37,26 @@ class ApiAppResponse(BaseModel): """ - Contains information about an API App. + _t__ApiAppResponse::DESCRIPTION """ # noqa: E501 callback_url: Optional[StrictStr] = Field( - default=None, description="The app's callback URL (for events)" + default=None, description="_t__ApiAppResponse::CALLBACK_URL" ) client_id: Optional[StrictStr] = Field( - default=None, description="The app's client id" + default=None, description="_t__ApiAppResponse::CLIENT_ID" ) created_at: Optional[StrictInt] = Field( - default=None, description="The time that the app was created" + default=None, description="_t__ApiAppResponse::CREATED_AT" ) domains: Optional[List[StrictStr]] = Field( - default=None, description="The domain name(s) associated with the app" + default=None, description="_t__ApiAppResponse::DOMAINS" + ) + name: Optional[StrictStr] = Field( + default=None, description="_t__ApiAppResponse::NAME" ) - name: Optional[StrictStr] = Field(default=None, description="The name of the app") is_approved: Optional[StrictBool] = Field( - default=None, description="Boolean to indicate if the app has been approved" + default=None, description="_t__ApiAppResponse::IS_APPROVED" ) oauth: Optional[ApiAppResponseOAuth] = None options: Optional[ApiAppResponseOptions] = None diff --git a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py index b078c1a71..97de260a8 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py +++ b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py @@ -29,22 +29,20 @@ class ApiAppResponseOAuth(BaseModel): """ - An object describing the app's OAuth properties, or null if OAuth is not configured for the app. + _t__ApiAppResponseOAuth::DESCRIPTION """ # noqa: E501 callback_url: Optional[StrictStr] = Field( - default=None, description="The app's OAuth callback URL." + default=None, description="_t__ApiAppResponseOAuth::CALLBACK_URL" ) secret: Optional[StrictStr] = Field( - default=None, - description="The app's OAuth secret, or null if the app does not belong to user.", + default=None, description="_t__ApiAppResponseOAuth::SECRET" ) scopes: Optional[List[StrictStr]] = Field( - default=None, description="Array of OAuth scopes used by the app." + default=None, description="_t__ApiAppResponseOAuth::SCOPES" ) charges_users: Optional[StrictBool] = Field( - default=None, - description="Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.", + default=None, description="_t__ApiAppResponseOAuth::CHARGES_USERS" ) __properties: ClassVar[List[str]] = [ "callback_url", diff --git a/sdks/python/dropbox_sign/models/api_app_response_options.py b/sdks/python/dropbox_sign/models/api_app_response_options.py index ec34ed913..4ea9938ba 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_options.py @@ -29,12 +29,11 @@ class ApiAppResponseOptions(BaseModel): """ - An object with options that override account settings. + _t__ApiAppResponseOptions::DESCRIPTION """ # noqa: E501 can_insert_everywhere: Optional[StrictBool] = Field( - default=None, - description='Boolean denoting if signers can "Insert Everywhere" in one click while signing a document', + default=None, description="_t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE" ) __properties: ClassVar[List[str]] = ["can_insert_everywhere"] diff --git a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py index d57994800..1c680664d 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py +++ b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py @@ -29,14 +29,14 @@ class ApiAppResponseOwnerAccount(BaseModel): """ - An object describing the app's owner + _t__ApiAppResponseOwnerAccount::DESCRIPTION """ # noqa: E501 account_id: Optional[StrictStr] = Field( - default=None, description="The owner account's ID" + default=None, description="_t__ApiAppResponseOwnerAccount::ACCOUNT_ID" ) email_address: Optional[StrictStr] = Field( - default=None, description="The owner account's email address" + default=None, description="_t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS" ) __properties: ClassVar[List[str]] = ["account_id", "email_address"] diff --git a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py index b5747219c..6c18464b0 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py @@ -29,7 +29,7 @@ class ApiAppResponseWhiteLabelingOptions(BaseModel): """ - An object with options to customize the app's signer page + _t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION """ # noqa: E501 header_background_color: Optional[StrictStr] = None diff --git a/sdks/python/dropbox_sign/models/api_app_update_request.py b/sdks/python/dropbox_sign/models/api_app_update_request.py index 7e1f87206..7370a7e96 100644 --- a/sdks/python/dropbox_sign/models/api_app_update_request.py +++ b/sdks/python/dropbox_sign/models/api_app_update_request.py @@ -46,7 +46,7 @@ class ApiAppUpdateRequest(BaseModel): default=None, description="An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)", ) - domains: Optional[Annotated[List[StrictStr], Field(max_length=2)]] = Field( + domains: Optional[Annotated[List[StrictStr], Field(max_length=10)]] = Field( default=None, description="The domain names the ApiApp will be associated with." ) name: Optional[StrictStr] = Field( diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py index 9461ccfa6..c8d843239 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py @@ -41,10 +41,10 @@ class BulkSendJobGetResponse(BaseModel): bulk_send_job: BulkSendJobResponse list_info: ListInfoResponse signature_requests: List[BulkSendJobGetResponseSignatureRequests] = Field( - description="Contains information about the Signature Requests sent in bulk." + description="_t__BulkSendJobGetResponse::SIGNATURE_REQUESTS" ) warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = [ "bulk_send_job", diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py index 704089bef..7e8261b47 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py @@ -45,97 +45,81 @@ class BulkSendJobGetResponseSignatureRequests(BaseModel): """ # noqa: E501 test_mode: Optional[StrictBool] = Field( - default=False, - description="Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.", + default=False, description="_t__SignatureRequestResponse::TEST_MODE" ) signature_request_id: Optional[StrictStr] = Field( - default=None, description="The id of the SignatureRequest." + default=None, description="_t__SignatureRequestResponse::SIGNATURE_REQUEST_ID" ) requester_email_address: Optional[StrictStr] = Field( default=None, - description="The email address of the initiator of the SignatureRequest.", + description="_t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS", ) title: Optional[StrictStr] = Field( - default=None, - description="The title the specified Account uses for the SignatureRequest.", + default=None, description="_t__SignatureRequestResponse::TITLE" ) original_title: Optional[StrictStr] = Field( - default=None, description="Default Label for account." + default=None, description="_t__SignatureRequestResponse::ORIGINAL_TITLE" ) subject: Optional[StrictStr] = Field( - default=None, - description="The subject in the email that was initially sent to the signers.", + default=None, description="_t__SignatureRequestResponse::SUBJECT" ) message: Optional[StrictStr] = Field( - default=None, - description="The custom message in the email that was initially sent to the signers.", + default=None, description="_t__SignatureRequestResponse::MESSAGE" ) metadata: Optional[Dict[str, Any]] = Field( - default=None, description="The metadata attached to the signature request." + default=None, description="_t__SignatureRequestResponse::METADATA" ) created_at: Optional[StrictInt] = Field( - default=None, description="Time the signature request was created." + default=None, description="_t__SignatureRequestResponse::CREATED_AT" ) expires_at: Optional[StrictInt] = Field( - default=None, - description="The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", + default=None, description="_t__SignatureRequestResponse::EXPIRES_AT" ) is_complete: Optional[StrictBool] = Field( - default=None, - description="Whether or not the SignatureRequest has been fully executed by all signers.", + default=None, description="_t__SignatureRequestResponse::IS_COMPLETE" ) is_declined: Optional[StrictBool] = Field( - default=None, - description="Whether or not the SignatureRequest has been declined by a signer.", + default=None, description="_t__SignatureRequestResponse::IS_DECLINED" ) has_error: Optional[StrictBool] = Field( - default=None, - description="Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).", + default=None, description="_t__SignatureRequestResponse::HAS_ERROR" ) files_url: Optional[StrictStr] = Field( - default=None, - description="The URL where a copy of the request's documents can be downloaded.", + default=None, description="_t__SignatureRequestResponse::FILES_URL" ) signing_url: Optional[StrictStr] = Field( - default=None, - description="The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.", + default=None, description="_t__SignatureRequestResponse::SIGNING_URL" ) details_url: Optional[StrictStr] = Field( - default=None, - description="The URL where the requester and the signers can view the current status of the SignatureRequest.", + default=None, description="_t__SignatureRequestResponse::DETAILS_URL" ) cc_email_addresses: Optional[List[StrictStr]] = Field( - default=None, - description="A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.", + default=None, description="_t__SignatureRequestResponse::CC_EMAIL_ADDRESSES" ) signing_redirect_url: Optional[StrictStr] = Field( - default=None, - description="The URL you want the signer redirected to after they successfully sign.", + default=None, description="_t__SignatureRequestResponse::SIGNING_REDIRECT_URL" ) final_copy_uri: Optional[StrictStr] = Field( - default=None, - description="The path where the completed document can be downloaded", + default=None, description="_t__SignatureRequestResponse::FINAL_COPY_URI" ) template_ids: Optional[List[StrictStr]] = Field( - default=None, - description="Templates IDs used in this SignatureRequest (if any).", + default=None, description="_t__SignatureRequestResponse::TEMPLATE_IDS" ) custom_fields: Optional[List[SignatureRequestResponseCustomFieldBase]] = Field( - default=None, - description="An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`", + default=None, description="_t__SignatureRequestResponseCustomField::DESCRIPTION" ) attachments: Optional[List[SignatureRequestResponseAttachment]] = Field( - default=None, description="Signer attachments." + default=None, description="_t__SignatureRequestResponseAttachment::DESCRIPTION" ) response_data: Optional[List[SignatureRequestResponseDataBase]] = Field( - default=None, - description="An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.", + default=None, description="_t__SignatureRequestResponseData::DESCRIPTION" ) signatures: Optional[List[SignatureRequestResponseSignatures]] = Field( - default=None, description="An array of signature objects, 1 for each signer." + default=None, description="_t__SignatureRequestResponseSignatures::DESCRIPTION" ) bulk_send_job_id: Optional[StrictStr] = Field( - default=None, description="The id of the BulkSendJob." + default=None, + description="_t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID", ) __properties: ClassVar[List[str]] = [ "test_mode", diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py index 8f9791880..f0cd3a2be 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py @@ -36,11 +36,11 @@ class BulkSendJobListResponse(BaseModel): """ # noqa: E501 bulk_send_jobs: List[BulkSendJobResponse] = Field( - description="Contains a list of BulkSendJobs that the API caller has access to." + description="_t__BulkSendJobListResponse::BULK_SEND_JOBS" ) list_info: ListInfoResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["bulk_send_jobs", "list_info", "warnings"] diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_response.py index 8d6eeeee0..0a8cd309a 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_response.py @@ -29,22 +29,20 @@ class BulkSendJobResponse(BaseModel): """ - Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. + _t__BulkSendJobResponse::DESCRIPTION """ # noqa: E501 bulk_send_job_id: Optional[StrictStr] = Field( - default=None, description="The id of the BulkSendJob." + default=None, description="_t__BulkSendJobResponse::BULK_SEND_JOB_ID" ) total: Optional[StrictInt] = Field( - default=None, - description="The total amount of Signature Requests queued for sending.", + default=None, description="_t__BulkSendJobResponse::TOTAL" ) is_creator: Optional[StrictBool] = Field( - default=None, - description="True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.", + default=None, description="_t__BulkSendJobResponse::IS_CREATOR" ) created_at: Optional[StrictInt] = Field( - default=None, description="Time that the BulkSendJob was created." + default=None, description="_t__BulkSendJobResponse::CREATED_AT" ) __properties: ClassVar[List[str]] = [ "bulk_send_job_id", diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py index a2eca9737..f8223b646 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py @@ -36,7 +36,7 @@ class BulkSendJobSendResponse(BaseModel): bulk_send_job: BulkSendJobResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["bulk_send_job", "warnings"] diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py index 849ebf426..1c2bad53a 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py @@ -38,6 +38,10 @@ class EmbeddedEditUrlRequest(BaseModel): default=False, description="This allows the requester to enable/disable to add or change CC roles when editing the template.", ) + allow_form_view: Optional[StrictBool] = Field( + default=False, + description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", + ) cc_roles: Optional[List[StrictStr]] = Field( default=None, description="The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.", @@ -73,6 +77,7 @@ class EmbeddedEditUrlRequest(BaseModel): ) __properties: ClassVar[List[str]] = [ "allow_edit_ccs", + "allow_form_view", "cc_roles", "editor_options", "force_signer_roles", @@ -162,6 +167,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_edit_ccs") is not None else False ), + "allow_form_view": ( + obj.get("allow_form_view") + if obj.get("allow_form_view") is not None + else False + ), "cc_roles": obj.get("cc_roles"), "editor_options": ( SubEditorOptions.from_dict(obj["editor_options"]) @@ -219,6 +229,7 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "allow_edit_ccs": "(bool,)", + "allow_form_view": "(bool,)", "cc_roles": "(List[str],)", "editor_options": "(SubEditorOptions,)", "force_signer_roles": "(bool,)", diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py index 653ca7c2c..4e33c7f97 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py @@ -38,7 +38,7 @@ class EmbeddedEditUrlResponse(BaseModel): embedded: EmbeddedEditUrlResponseEmbedded warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["embedded", "warnings"] diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py index 67413cb9a..3cd090daa 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py @@ -29,15 +29,14 @@ class EmbeddedEditUrlResponseEmbedded(BaseModel): """ - An embedded template object. + _t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION """ # noqa: E501 edit_url: Optional[StrictStr] = Field( - default=None, description="A template url that can be opened in an iFrame." + default=None, description="_t__EmbeddedEditUrlResponseEmbedded::EDIT_URL" ) expires_at: Optional[StrictInt] = Field( - default=None, - description="The specific time that the the `edit_url` link expires, in epoch.", + default=None, description="_t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT" ) __properties: ClassVar[List[str]] = ["edit_url", "expires_at"] diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py index f0e03a177..3f300bcc3 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py @@ -38,7 +38,7 @@ class EmbeddedSignUrlResponse(BaseModel): embedded: EmbeddedSignUrlResponseEmbedded warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["embedded", "warnings"] diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py index dc7145702..294a1d315 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py @@ -29,15 +29,14 @@ class EmbeddedSignUrlResponseEmbedded(BaseModel): """ - An object that contains necessary information to set up embedded signing. + _t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION """ # noqa: E501 sign_url: Optional[StrictStr] = Field( - default=None, description="A signature url that can be opened in an iFrame." + default=None, description="_t__EmbeddedSignUrlResponseEmbedded::SIGN_URL" ) expires_at: Optional[StrictInt] = Field( - default=None, - description="The specific time that the the `sign_url` link expires, in epoch.", + default=None, description="_t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT" ) __properties: ClassVar[List[str]] = ["sign_url", "expires_at"] diff --git a/sdks/python/dropbox_sign/models/error_response_error.py b/sdks/python/dropbox_sign/models/error_response_error.py index 6991a0a27..089d520a3 100644 --- a/sdks/python/dropbox_sign/models/error_response_error.py +++ b/sdks/python/dropbox_sign/models/error_response_error.py @@ -29,13 +29,13 @@ class ErrorResponseError(BaseModel): """ - Contains information about an error that occurred. + _t__ErrorResponseError::DESCRIPTION """ # noqa: E501 - error_msg: StrictStr = Field(description="Message describing an error.") - error_name: StrictStr = Field(description="Name of the error.") + error_msg: StrictStr = Field(description="_t__ErrorResponseError::ERROR_MSG") + error_name: StrictStr = Field(description="_t__ErrorResponseError::ERROR_NAME") error_path: Optional[StrictStr] = Field( - default=None, description="Path at which an error occurred." + default=None, description="_t__ErrorResponseError::ERROR_PATH" ) __properties: ClassVar[List[str]] = ["error_msg", "error_name", "error_path"] diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event.py b/sdks/python/dropbox_sign/models/event_callback_request_event.py index 7f263da42..4d2277a1b 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event.py @@ -32,17 +32,17 @@ class EventCallbackRequestEvent(BaseModel): """ - Basic information about the event that occurred. + _t__EventCallbackRequestEvent::DESCRIPTION """ # noqa: E501 event_time: StrictStr = Field( - description="Time the event was created (using Unix time)." + description="_t__EventCallbackRequestEvent::EVENT_TIME" ) event_type: StrictStr = Field( - description="Type of callback event that was triggered." + description="_t__EventCallbackRequestEvent::EVENT_TYPE" ) event_hash: StrictStr = Field( - description="Generated hash used to verify source of event data." + description="_t__EventCallbackRequestEvent::EVENT_HASH" ) event_metadata: Optional[EventCallbackRequestEventMetadata] = None __properties: ClassVar[List[str]] = [ diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py index fee5309d9..19e50edb8 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py @@ -29,22 +29,23 @@ class EventCallbackRequestEventMetadata(BaseModel): """ - Specific metadata about the event. + _t__EventCallbackRequestEventMetadata::DESCRIPTION """ # noqa: E501 related_signature_id: Optional[StrictStr] = Field( default=None, - description="Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.", + description="_t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID", ) reported_for_account_id: Optional[StrictStr] = Field( - default=None, description="Account ID the event was reported for." + default=None, + description="_t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID", ) reported_for_app_id: Optional[StrictStr] = Field( - default=None, description="App ID the event was reported for." + default=None, + description="_t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID", ) event_message: Optional[StrictStr] = Field( - default=None, - description="Message about a declined or failed (due to error) signature flow.", + default=None, description="_t__EventCallbackRequestEventMetadata::EVENT_MESSAGE" ) __properties: ClassVar[List[str]] = [ "related_signature_id", diff --git a/sdks/python/dropbox_sign/models/fax_get_response.py b/sdks/python/dropbox_sign/models/fax_get_response.py index 25bf9d2fd..eca73529e 100644 --- a/sdks/python/dropbox_sign/models/fax_get_response.py +++ b/sdks/python/dropbox_sign/models/fax_get_response.py @@ -36,7 +36,7 @@ class FaxGetResponse(BaseModel): fax: FaxResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["fax", "warnings"] diff --git a/sdks/python/dropbox_sign/models/file_response.py b/sdks/python/dropbox_sign/models/file_response.py index 434a4f1be..8d44309c3 100644 --- a/sdks/python/dropbox_sign/models/file_response.py +++ b/sdks/python/dropbox_sign/models/file_response.py @@ -32,8 +32,8 @@ class FileResponse(BaseModel): FileResponse """ # noqa: E501 - file_url: StrictStr = Field(description="URL to the file.") - expires_at: StrictInt = Field(description="When the link expires.") + file_url: StrictStr = Field(description="_t__FileResponse::FILE_URL") + expires_at: StrictInt = Field(description="_t__FileResponse::EXPIRES_AT") __properties: ClassVar[List[str]] = ["file_url", "expires_at"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/file_response_data_uri.py b/sdks/python/dropbox_sign/models/file_response_data_uri.py index da1384d66..23ea0ada3 100644 --- a/sdks/python/dropbox_sign/models/file_response_data_uri.py +++ b/sdks/python/dropbox_sign/models/file_response_data_uri.py @@ -32,7 +32,7 @@ class FileResponseDataUri(BaseModel): FileResponseDataUri """ # noqa: E501 - data_uri: StrictStr = Field(description="File as base64 encoded string.") + data_uri: StrictStr = Field(description="_t__FileResponse::DATA_URI") __properties: ClassVar[List[str]] = ["data_uri"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/list_info_response.py b/sdks/python/dropbox_sign/models/list_info_response.py index cdca4fa28..d12ea2bce 100644 --- a/sdks/python/dropbox_sign/models/list_info_response.py +++ b/sdks/python/dropbox_sign/models/list_info_response.py @@ -29,20 +29,20 @@ class ListInfoResponse(BaseModel): """ - Contains pagination information about the data returned. + _t__ListInfoResponse::DESCRIPTION """ # noqa: E501 num_pages: Optional[StrictInt] = Field( - default=None, description="Total number of pages available." + default=None, description="_t__ListInfoResponse::NUM_PAGES" ) num_results: Optional[StrictInt] = Field( - default=None, description="Total number of objects available." + default=None, description="_t__ListInfoResponse::NUM_RESULTS" ) page: Optional[StrictInt] = Field( - default=None, description="Number of the page being returned." + default=None, description="_t__ListInfoResponse::PAGE" ) page_size: Optional[StrictInt] = Field( - default=None, description="Objects returned per page." + default=None, description="_t__ListInfoResponse::PAGE_SIZE" ) __properties: ClassVar[List[str]] = [ "num_pages", diff --git a/sdks/python/dropbox_sign/models/o_auth_token_response.py b/sdks/python/dropbox_sign/models/o_auth_token_response.py index 4b91161f4..741e395e2 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_response.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_response.py @@ -36,8 +36,7 @@ class OAuthTokenResponse(BaseModel): token_type: Optional[StrictStr] = None refresh_token: Optional[StrictStr] = None expires_in: Optional[StrictInt] = Field( - default=None, - description="Number of seconds until the `access_token` expires. Uses epoch time.", + default=None, description="_t__OAuthTokenResponse::EXPIRES_IN" ) state: Optional[StrictStr] = None __properties: ClassVar[List[str]] = [ diff --git a/sdks/python/dropbox_sign/models/report_create_request.py b/sdks/python/dropbox_sign/models/report_create_request.py index bdee2101e..9c4e3e1ff 100644 --- a/sdks/python/dropbox_sign/models/report_create_request.py +++ b/sdks/python/dropbox_sign/models/report_create_request.py @@ -48,9 +48,9 @@ class ReportCreateRequest(BaseModel): def report_type_validate_enum(cls, value): """Validates the enum""" for i in value: - if i not in set(["user_activity", "document_status"]): + if i not in set(["user_activity", "document_status", "sms_activity"]): raise ValueError( - "each list item must be one of ('user_activity', 'document_status')" + "each list item must be one of ('user_activity', 'document_status', 'sms_activity')" ) return value diff --git a/sdks/python/dropbox_sign/models/report_create_response.py b/sdks/python/dropbox_sign/models/report_create_response.py index 3d781b9bd..adbcccac6 100644 --- a/sdks/python/dropbox_sign/models/report_create_response.py +++ b/sdks/python/dropbox_sign/models/report_create_response.py @@ -36,7 +36,7 @@ class ReportCreateResponse(BaseModel): report: ReportResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["report", "warnings"] diff --git a/sdks/python/dropbox_sign/models/report_response.py b/sdks/python/dropbox_sign/models/report_response.py index f1fbe5148..01f11b96c 100644 --- a/sdks/python/dropbox_sign/models/report_response.py +++ b/sdks/python/dropbox_sign/models/report_response.py @@ -29,24 +29,20 @@ class ReportResponse(BaseModel): """ - Contains information about the report request. + _t__ReportResponse::DESCRIPTION """ # noqa: E501 success: Optional[StrictStr] = Field( - default=None, - description="A message indicating the requested operation's success", + default=None, description="_t__ReportResponse::SUCCESS" ) start_date: Optional[StrictStr] = Field( - default=None, - description="The (inclusive) start date for the report data in MM/DD/YYYY format.", + default=None, description="_t__ReportResponse::START_DATE" ) end_date: Optional[StrictStr] = Field( - default=None, - description="The (inclusive) end date for the report data in MM/DD/YYYY format.", + default=None, description="_t__ReportResponse::END_DATE" ) report_type: Optional[List[StrictStr]] = Field( - default=None, - description='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).', + default=None, description="_t__ReportResponse::REPORT_TYPE" ) __properties: ClassVar[List[str]] = [ "success", @@ -62,9 +58,9 @@ def report_type_validate_enum(cls, value): return value for i in value: - if i not in set(["user_activity", "document_status"]): + if i not in set(["user_activity", "document_status", "sms_activity"]): raise ValueError( - "each list item must be one of ('user_activity', 'document_status')" + "each list item must be one of ('user_activity', 'document_status', 'sms_activity')" ) return value diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py index 54fd997c1..0f64c8f56 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py @@ -69,8 +69,7 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_redirect_url: Optional[StrictStr] = Field( default=None, diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py index 54cb9808f..aeb268fd2 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py @@ -70,8 +70,7 @@ class SignatureRequestBulkSendWithTemplateRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_redirect_url: Optional[StrictStr] = Field( default=None, diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py index 72ef4be80..065cfc82c 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py @@ -68,23 +68,25 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", ) signers: Optional[List[SubSignatureRequestSigner]] = Field( - default=None, - description="Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + default=None, description="_t__Sub::SignatureRequestSigner::DESCRIPTION" ) grouped_signers: Optional[List[SubSignatureRequestGroupedSigners]] = Field( - default=None, - description="Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + default=None, description="_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION" ) allow_decline: Optional[StrictBool] = Field( default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) + allow_form_view: Optional[StrictBool] = Field( + default=False, + description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", + ) allow_reassign: Optional[StrictBool] = Field( default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan.", ) attachments: Optional[List[SubAttachment]] = Field( - default=None, description="A list describing the attachments" + default=None, description="_t__SubAttachment::LIST_DESCRIPTION" ) cc_email_addresses: Optional[List[StrictStr]] = Field( default=None, description="The email addresses that should be CCed." @@ -115,8 +117,7 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( @@ -150,6 +151,7 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): "signers", "grouped_signers", "allow_decline", + "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -312,6 +314,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), + "allow_form_view": ( + obj.get("allow_form_view") + if obj.get("allow_form_view") is not None + else False + ), "allow_reassign": ( obj.get("allow_reassign") if obj.get("allow_reassign") is not None @@ -408,6 +415,7 @@ def openapi_types(cls) -> Dict[str, str]: "signers": "(List[SubSignatureRequestSigner],)", "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", "allow_decline": "(bool,)", + "allow_form_view": "(bool,)", "allow_reassign": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py index 07c2d0cfe..1736fdb6b 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py @@ -46,7 +46,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest(BaseModel): description="Client id of the app you're using to create this embedded signature request. Used for security purposes." ) signers: List[SubSignatureRequestTemplateSigner] = Field( - description="Add Signers to your Templated-based Signature Request." + description="_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION" ) allow_decline: Optional[StrictBool] = Field( default=False, @@ -75,8 +75,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py index 6e952ad78..62404191c 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py @@ -68,23 +68,25 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", ) signers: Optional[List[SubSignatureRequestSigner]] = Field( - default=None, - description="Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + default=None, description="_t__Sub::SignatureRequestSigner::DESCRIPTION" ) grouped_signers: Optional[List[SubSignatureRequestGroupedSigners]] = Field( - default=None, - description="Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + default=None, description="_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION" ) allow_decline: Optional[StrictBool] = Field( default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) + allow_form_view: Optional[StrictBool] = Field( + default=False, + description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", + ) allow_reassign: Optional[StrictBool] = Field( default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan.", ) attachments: Optional[List[SubAttachment]] = Field( - default=None, description="A list describing the attachments" + default=None, description="_t__SubAttachment::LIST_DESCRIPTION" ) cc_email_addresses: Optional[List[StrictStr]] = Field( default=None, description="The email addresses that should be CCed." @@ -115,8 +117,7 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( @@ -150,6 +151,7 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): "signers", "grouped_signers", "allow_decline", + "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -312,6 +314,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), + "allow_form_view": ( + obj.get("allow_form_view") + if obj.get("allow_form_view") is not None + else False + ), "allow_reassign": ( obj.get("allow_reassign") if obj.get("allow_reassign") is not None @@ -408,6 +415,7 @@ def openapi_types(cls) -> Dict[str, str]: "signers": "(List[SubSignatureRequestSigner],)", "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", "allow_decline": "(bool,)", + "allow_form_view": "(bool,)", "allow_reassign": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py index 0061169bb..455b1d51f 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py @@ -46,7 +46,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest(BaseModel): description="Client id of the app you're using to create this embedded signature request. Used for security purposes." ) signers: List[SubSignatureRequestTemplateSigner] = Field( - description="Add Signers to your Templated-based Signature Request." + description="_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION" ) allow_decline: Optional[StrictBool] = Field( default=False, @@ -75,8 +75,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None subject: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field( diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_request.py index 4bd18cf01..837a35aec 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_request.py @@ -65,23 +65,25 @@ class SignatureRequestEditRequest(BaseModel): description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", ) signers: Optional[List[SubSignatureRequestSigner]] = Field( - default=None, - description="Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + default=None, description="_t__Sub::SignatureRequestSigner::DESCRIPTION" ) grouped_signers: Optional[List[SubSignatureRequestGroupedSigners]] = Field( - default=None, - description="Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + default=None, description="_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION" ) allow_decline: Optional[StrictBool] = Field( default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) + allow_form_view: Optional[StrictBool] = Field( + default=False, + description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", + ) allow_reassign: Optional[StrictBool] = Field( default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", ) attachments: Optional[List[SubAttachment]] = Field( - default=None, description="A list describing the attachments" + default=None, description="_t__SubAttachment::LIST_DESCRIPTION" ) cc_email_addresses: Optional[List[StrictStr]] = Field( default=None, description="The email addresses that should be CCed." @@ -120,8 +122,7 @@ class SignatureRequestEditRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None signing_redirect_url: Optional[StrictStr] = Field( @@ -154,6 +155,7 @@ class SignatureRequestEditRequest(BaseModel): "signers", "grouped_signers", "allow_decline", + "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -317,6 +319,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), + "allow_form_view": ( + obj.get("allow_form_view") + if obj.get("allow_form_view") is not None + else False + ), "allow_reassign": ( obj.get("allow_reassign") if obj.get("allow_reassign") is not None @@ -410,6 +417,7 @@ def openapi_types(cls) -> Dict[str, str]: "signers": "(List[SubSignatureRequestSigner],)", "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", "allow_decline": "(bool,)", + "allow_form_view": "(bool,)", "allow_reassign": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py index fedc9afd5..f3fececab 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py @@ -41,7 +41,7 @@ class SignatureRequestEditWithTemplateRequest(BaseModel): description="Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used." ) signers: List[SubSignatureRequestTemplateSigner] = Field( - description="Add Signers to your Templated-based Signature Request." + description="_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION" ) allow_decline: Optional[StrictBool] = Field( default=False, @@ -78,8 +78,7 @@ class SignatureRequestEditWithTemplateRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None signing_redirect_url: Optional[StrictStr] = Field( diff --git a/sdks/python/dropbox_sign/models/signature_request_get_response.py b/sdks/python/dropbox_sign/models/signature_request_get_response.py index 546c12ce3..95b24f72e 100644 --- a/sdks/python/dropbox_sign/models/signature_request_get_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_get_response.py @@ -36,7 +36,7 @@ class SignatureRequestGetResponse(BaseModel): signature_request: SignatureRequestResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["signature_request", "warnings"] diff --git a/sdks/python/dropbox_sign/models/signature_request_list_response.py b/sdks/python/dropbox_sign/models/signature_request_list_response.py index 2df4cbfe3..a39da9802 100644 --- a/sdks/python/dropbox_sign/models/signature_request_list_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_list_response.py @@ -36,11 +36,11 @@ class SignatureRequestListResponse(BaseModel): """ # noqa: E501 signature_requests: List[SignatureRequestResponse] = Field( - description="Contains information about signature requests." + description="_t__SignatureRequestListResponse::DESCRIPTION" ) list_info: ListInfoResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["signature_requests", "list_info", "warnings"] diff --git a/sdks/python/dropbox_sign/models/signature_request_response.py b/sdks/python/dropbox_sign/models/signature_request_response.py index 7720256b8..bff3a8f02 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_response.py @@ -41,102 +41,84 @@ class SignatureRequestResponse(BaseModel): """ - Contains information about a signature request. + _t__SignatureRequestResponse::DESCRIPTION """ # noqa: E501 test_mode: Optional[StrictBool] = Field( - default=False, - description="Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.", + default=False, description="_t__SignatureRequestResponse::TEST_MODE" ) signature_request_id: Optional[StrictStr] = Field( - default=None, description="The id of the SignatureRequest." + default=None, description="_t__SignatureRequestResponse::SIGNATURE_REQUEST_ID" ) requester_email_address: Optional[StrictStr] = Field( default=None, - description="The email address of the initiator of the SignatureRequest.", + description="_t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS", ) title: Optional[StrictStr] = Field( - default=None, - description="The title the specified Account uses for the SignatureRequest.", + default=None, description="_t__SignatureRequestResponse::TITLE" ) original_title: Optional[StrictStr] = Field( - default=None, description="Default Label for account." + default=None, description="_t__SignatureRequestResponse::ORIGINAL_TITLE" ) subject: Optional[StrictStr] = Field( - default=None, - description="The subject in the email that was initially sent to the signers.", + default=None, description="_t__SignatureRequestResponse::SUBJECT" ) message: Optional[StrictStr] = Field( - default=None, - description="The custom message in the email that was initially sent to the signers.", + default=None, description="_t__SignatureRequestResponse::MESSAGE" ) metadata: Optional[Dict[str, Any]] = Field( - default=None, description="The metadata attached to the signature request." + default=None, description="_t__SignatureRequestResponse::METADATA" ) created_at: Optional[StrictInt] = Field( - default=None, description="Time the signature request was created." + default=None, description="_t__SignatureRequestResponse::CREATED_AT" ) expires_at: Optional[StrictInt] = Field( - default=None, - description="The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", + default=None, description="_t__SignatureRequestResponse::EXPIRES_AT" ) is_complete: Optional[StrictBool] = Field( - default=None, - description="Whether or not the SignatureRequest has been fully executed by all signers.", + default=None, description="_t__SignatureRequestResponse::IS_COMPLETE" ) is_declined: Optional[StrictBool] = Field( - default=None, - description="Whether or not the SignatureRequest has been declined by a signer.", + default=None, description="_t__SignatureRequestResponse::IS_DECLINED" ) has_error: Optional[StrictBool] = Field( - default=None, - description="Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).", + default=None, description="_t__SignatureRequestResponse::HAS_ERROR" ) files_url: Optional[StrictStr] = Field( - default=None, - description="The URL where a copy of the request's documents can be downloaded.", + default=None, description="_t__SignatureRequestResponse::FILES_URL" ) signing_url: Optional[StrictStr] = Field( - default=None, - description="The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.", + default=None, description="_t__SignatureRequestResponse::SIGNING_URL" ) details_url: Optional[StrictStr] = Field( - default=None, - description="The URL where the requester and the signers can view the current status of the SignatureRequest.", + default=None, description="_t__SignatureRequestResponse::DETAILS_URL" ) cc_email_addresses: Optional[List[StrictStr]] = Field( - default=None, - description="A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.", + default=None, description="_t__SignatureRequestResponse::CC_EMAIL_ADDRESSES" ) signing_redirect_url: Optional[StrictStr] = Field( - default=None, - description="The URL you want the signer redirected to after they successfully sign.", + default=None, description="_t__SignatureRequestResponse::SIGNING_REDIRECT_URL" ) final_copy_uri: Optional[StrictStr] = Field( - default=None, - description="The path where the completed document can be downloaded", + default=None, description="_t__SignatureRequestResponse::FINAL_COPY_URI" ) template_ids: Optional[List[StrictStr]] = Field( - default=None, - description="Templates IDs used in this SignatureRequest (if any).", + default=None, description="_t__SignatureRequestResponse::TEMPLATE_IDS" ) custom_fields: Optional[List[SignatureRequestResponseCustomFieldBase]] = Field( - default=None, - description="An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`", + default=None, description="_t__SignatureRequestResponseCustomField::DESCRIPTION" ) attachments: Optional[List[SignatureRequestResponseAttachment]] = Field( - default=None, description="Signer attachments." + default=None, description="_t__SignatureRequestResponseAttachment::DESCRIPTION" ) response_data: Optional[List[SignatureRequestResponseDataBase]] = Field( - default=None, - description="An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.", + default=None, description="_t__SignatureRequestResponseData::DESCRIPTION" ) signatures: Optional[List[SignatureRequestResponseSignatures]] = Field( - default=None, description="An array of signature objects, 1 for each signer." + default=None, description="_t__SignatureRequestResponseSignatures::DESCRIPTION" ) bulk_send_job_id: Optional[StrictStr] = Field( - default=None, - description="The ID of the Bulk Send job which sent the signature request, if applicable.", + default=None, description="_t__SignatureRequestResponse::BULK_SEND_JOB_ID" ) __properties: ClassVar[List[str]] = [ "test_mode", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py index 30af75823..8ccddc2fb 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py @@ -29,22 +29,22 @@ class SignatureRequestResponseAttachment(BaseModel): """ - Signer attachments. + _t__SignatureRequestResponseAttachment::DESCRIPTION """ # noqa: E501 - id: StrictStr = Field(description="The unique ID for this attachment.") + id: StrictStr = Field(description="_t__SignatureRequestResponseAttachment::ID") signer: Union[StrictStr, StrictInt] = Field( - description="The Signer this attachment is assigned to." + description="_t__SignatureRequestResponseAttachment::SIGNER" ) - name: StrictStr = Field(description="The name of this attachment.") + name: StrictStr = Field(description="_t__SignatureRequestResponseAttachment::NAME") required: StrictBool = Field( - description="A boolean value denoting if this attachment is required." + description="_t__SignatureRequestResponseAttachment::REQUIRED" ) instructions: Optional[StrictStr] = Field( - default=None, description="Instructions for Signer." + default=None, description="_t__SignatureRequestResponseAttachment::INSTRUCTIONS" ) uploaded_at: Optional[StrictInt] = Field( - default=None, description="Timestamp when attachment was uploaded by Signer." + default=None, description="_t__SignatureRequestResponseAttachment::UPLOADED_AT" ) __properties: ClassVar[List[str]] = [ "id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py index 61ecdd69c..debe21345 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py @@ -40,22 +40,19 @@ class SignatureRequestResponseCustomFieldBase(BaseModel): """ - An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + _t__SignatureRequestResponseCustomField::DESCRIPTION """ # noqa: E501 - type: StrictStr = Field( - description="The type of this Custom Field. Only 'text' and 'checkbox' are currently supported." - ) - name: StrictStr = Field(description="The name of the Custom Field.") + type: StrictStr = Field(description="_t__SignatureRequestResponseCustomField::TYPE") + name: StrictStr = Field(description="_t__SignatureRequestResponseCustomField::NAME") required: Optional[StrictBool] = Field( - default=None, description="A boolean value denoting if this field is required." + default=None, description="_t__SignatureRequestResponseCustomField::REQUIRED" ) api_id: Optional[StrictStr] = Field( - default=None, description="The unique ID for this field." + default=None, description="_t__SignatureRequestResponseCustomField::API_ID" ) editor: Optional[StrictStr] = Field( - default=None, - description="The name of the Role that is able to edit this field.", + default=None, description="_t__SignatureRequestResponseCustomField::EDITOR" ) __properties: ClassVar[List[str]] = ["type", "name", "required", "api_id", "editor"] diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py index de55b64e5..336324b6a 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py @@ -34,14 +34,13 @@ class SignatureRequestResponseCustomFieldCheckbox( SignatureRequestResponseCustomFieldBase ): """ - This class extends `SignatureRequestResponseCustomFieldBase`. + _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this Custom Field. Only 'text' and 'checkbox' are currently supported." - ) + type: StrictStr = Field(description="_t__SignatureRequestResponseCustomField::TYPE") value: Optional[StrictBool] = Field( - default=None, description="A true/false for checkbox fields" + default=None, + description="_t__SignatureRequestResponseCustomField::VALUE_CHECKBOX", ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py index 48fa24f29..525c6d4d2 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py @@ -32,14 +32,12 @@ class SignatureRequestResponseCustomFieldText(SignatureRequestResponseCustomFieldBase): """ - This class extends `SignatureRequestResponseCustomFieldBase`. + _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this Custom Field. Only 'text' and 'checkbox' are currently supported." - ) + type: StrictStr = Field(description="_t__SignatureRequestResponseCustomField::TYPE") value: Optional[StrictStr] = Field( - default=None, description="A text string for text fields" + default=None, description="_t__SignatureRequestResponseCustomField::VALUE_TEXT" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py index 374d2cc50..b2d50b802 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py @@ -61,21 +61,20 @@ class SignatureRequestResponseDataBase(BaseModel): """ - An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + _t__SignatureRequestResponseData::DESCRIPTION """ # noqa: E501 api_id: Optional[StrictStr] = Field( - default=None, description="The unique ID for this field." + default=None, description="_t__SignatureRequestResponseData::API_ID" ) signature_id: Optional[StrictStr] = Field( - default=None, - description="The ID of the signature to which this response is linked.", + default=None, description="_t__SignatureRequestResponseData::SIGNATURE_ID" ) name: Optional[StrictStr] = Field( - default=None, description="The name of the form field." + default=None, description="_t__SignatureRequestResponseData::NAME" ) required: Optional[StrictBool] = Field( - default=None, description="A boolean value denoting if this field is required." + default=None, description="_t__SignatureRequestResponseData::REQUIRED" ) type: Optional[StrictStr] = None __properties: ClassVar[List[str]] = [ diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py index 4e258335d..2a714b496 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py @@ -36,10 +36,11 @@ class SignatureRequestResponseDataValueCheckbox(SignatureRequestResponseDataBase """ # noqa: E501 type: Optional[StrictStr] = Field( - default="checkbox", description="A yes/no checkbox" + default="checkbox", + description="_t__SignatureRequestResponseDataValue::CHECKBOX_TYPE", ) value: Optional[StrictBool] = Field( - default=None, description="The value of the form field." + default=None, description="_t__SignatureRequestResponseDataValue::VALUE" ) __properties: ClassVar[List[str]] = [ "api_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py index 0a25a7ca7..3e47a4fd6 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py @@ -37,10 +37,10 @@ class SignatureRequestResponseDataValueCheckboxMerge(SignatureRequestResponseDat type: Optional[StrictStr] = Field( default="checkbox-merge", - description="A checkbox field that has default value set by the api", + description="_t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE", ) value: Optional[StrictStr] = Field( - default=None, description="The value of the form field." + default=None, description="_t__SignatureRequestResponseDataValue::VALUE" ) __properties: ClassVar[List[str]] = [ "api_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py index ac09c2600..99aa077b4 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py @@ -35,9 +35,12 @@ class SignatureRequestResponseDataValueDateSigned(SignatureRequestResponseDataBa SignatureRequestResponseDataValueDateSigned """ # noqa: E501 - type: Optional[StrictStr] = Field(default="date_signed", description="A date") + type: Optional[StrictStr] = Field( + default="date_signed", + description="_t__SignatureRequestResponseDataValue::DATESIGNED_TYPE", + ) value: Optional[StrictStr] = Field( - default=None, description="The value of the form field." + default=None, description="_t__SignatureRequestResponseDataValue::VALUE" ) __properties: ClassVar[List[str]] = [ "api_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py index 9eb735261..6156ce5a6 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py @@ -36,10 +36,11 @@ class SignatureRequestResponseDataValueDropdown(SignatureRequestResponseDataBase """ # noqa: E501 type: Optional[StrictStr] = Field( - default="dropdown", description="An input field for dropdowns" + default="dropdown", + description="_t__SignatureRequestResponseDataValue::DROPDOWN_TYPE", ) value: Optional[StrictStr] = Field( - default=None, description="The value of the form field." + default=None, description="_t__SignatureRequestResponseDataValue::VALUE" ) __properties: ClassVar[List[str]] = [ "api_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py index 9a5f19055..5bdbfc4a2 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py @@ -36,14 +36,14 @@ class SignatureRequestResponseDataValueInitials(SignatureRequestResponseDataBase """ # noqa: E501 type: Optional[StrictStr] = Field( - default="initials", description="An input field for initials" + default="initials", + description="_t__SignatureRequestResponseDataValue::INITIAL_TYPE", ) value: Optional[StrictStr] = Field( - default=None, description="The value of the form field." + default=None, description="_t__SignatureRequestResponseDataValue::VALUE" ) is_signed: Optional[StrictBool] = Field( - default=None, - description="This field contains the boolean true if the field is signed.", + default=None, description="_t__SignatureRequestResponseDataValue::IS_SIGNED" ) __properties: ClassVar[List[str]] = [ "api_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py index 38b3cc04a..87bd32267 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py @@ -36,10 +36,10 @@ class SignatureRequestResponseDataValueRadio(SignatureRequestResponseDataBase): """ # noqa: E501 type: Optional[StrictStr] = Field( - default="radio", description="An input field for radios" + default="radio", description="_t__SignatureRequestResponseDataValue::RADIO_TYPE" ) value: Optional[StrictBool] = Field( - default=None, description="The value of the form field." + default=None, description="_t__SignatureRequestResponseDataValue::VALUE" ) __properties: ClassVar[List[str]] = [ "api_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py index a928d102b..4df5156ca 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py @@ -36,14 +36,14 @@ class SignatureRequestResponseDataValueSignature(SignatureRequestResponseDataBas """ # noqa: E501 type: Optional[StrictStr] = Field( - default="signature", description="A signature input field" + default="signature", + description="_t__SignatureRequestResponseDataValue::SIGNATURE_TYPE", ) value: Optional[StrictStr] = Field( - default=None, description="The value of the form field." + default=None, description="_t__SignatureRequestResponseDataValue::VALUE" ) is_signed: Optional[StrictBool] = Field( - default=None, - description="This field contains the boolean true if the field is signed.", + default=None, description="_t__SignatureRequestResponseDataValue::IS_SIGNED" ) __properties: ClassVar[List[str]] = [ "api_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py index 7b5b782e5..536120850 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py @@ -35,9 +35,11 @@ class SignatureRequestResponseDataValueText(SignatureRequestResponseDataBase): SignatureRequestResponseDataValueText """ # noqa: E501 - type: Optional[StrictStr] = Field(default="text", description="A text input field") + type: Optional[StrictStr] = Field( + default="text", description="_t__SignatureRequestResponseDataValue::TEXT_TYPE" + ) value: Optional[StrictStr] = Field( - default=None, description="The value of the form field." + default=None, description="_t__SignatureRequestResponseDataValue::VALUE" ) __properties: ClassVar[List[str]] = [ "api_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py index 13b9591e9..835f5ad45 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py @@ -37,10 +37,10 @@ class SignatureRequestResponseDataValueTextMerge(SignatureRequestResponseDataBas type: Optional[StrictStr] = Field( default="text-merge", - description="A text field that has default text set by the api", + description="_t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE", ) value: Optional[StrictStr] = Field( - default=None, description="The value of the form field." + default=None, description="_t__SignatureRequestResponseDataValue::VALUE" ) __properties: ClassVar[List[str]] = [ "api_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py index 9b36e81f6..afb3f82ce 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py @@ -29,76 +29,75 @@ class SignatureRequestResponseSignatures(BaseModel): """ - An array of signature objects, 1 for each signer. + _t__SignatureRequestResponseSignatures::DESCRIPTION """ # noqa: E501 signature_id: Optional[StrictStr] = Field( - default=None, description="Signature identifier." + default=None, description="_t__SignatureRequestResponseSignatures::SIGNATURE_ID" ) signer_group_guid: Optional[StrictStr] = Field( - default=None, description="Signer Group GUID" + default=None, + description="_t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID", ) signer_email_address: Optional[StrictStr] = Field( - default=None, description="The email address of the signer." + default=None, + description="_t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS", ) signer_name: Optional[StrictStr] = Field( - default=None, description="The name of the signer." + default=None, description="_t__SignatureRequestResponseSignatures::SIGNER_NAME" ) signer_role: Optional[StrictStr] = Field( - default=None, description="The role of the signer." + default=None, description="_t__SignatureRequestResponseSignatures::SIGNER_ROLE" ) order: Optional[StrictInt] = Field( - default=None, - description="If signer order is assigned this is the 0-based index for this signer.", + default=None, description="_t__SignatureRequestResponseSignatures::ORDER" ) status_code: Optional[StrictStr] = Field( - default=None, - description="The current status of the signature. eg: awaiting_signature, signed, declined.", + default=None, description="_t__SignatureRequestResponseSignatures::STATUS_CODE" ) decline_reason: Optional[StrictStr] = Field( default=None, - description="The reason provided by the signer for declining the request.", + description="_t__SignatureRequestResponseSignatures::DECLINE_REASON", ) signed_at: Optional[StrictInt] = Field( - default=None, description="Time that the document was signed or null." + default=None, description="_t__SignatureRequestResponseSignatures::SIGNED_AT" ) last_viewed_at: Optional[StrictInt] = Field( default=None, - description="The time that the document was last viewed by this signer or null.", + description="_t__SignatureRequestResponseSignatures::LAST_VIEWED_AT", ) last_reminded_at: Optional[StrictInt] = Field( default=None, - description="The time the last reminder email was sent to the signer or null.", + description="_t__SignatureRequestResponseSignatures::LAST_REMINDED_AT", ) has_pin: Optional[StrictBool] = Field( - default=None, - description="Boolean to indicate whether this signature requires a PIN to access.", + default=None, description="_t__SignatureRequestResponseSignatures::HAS_PIN" ) has_sms_auth: Optional[StrictBool] = Field( - default=None, - description="Boolean to indicate whether this signature has SMS authentication enabled.", + default=None, description="_t__SignatureRequestResponseSignatures::HAS_SMS_AUTH" ) has_sms_delivery: Optional[StrictBool] = Field( default=None, - description="Boolean to indicate whether this signature has SMS delivery enabled.", + description="_t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY", ) sms_phone_number: Optional[StrictStr] = Field( default=None, - description="The SMS phone number used for authentication or signature request delivery.", + description="_t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER", ) reassigned_by: Optional[StrictStr] = Field( default=None, - description="Email address of original signer who reassigned to this signer.", + description="_t__SignatureRequestResponseSignatures::REASSIGNED_BY", ) reassignment_reason: Optional[StrictStr] = Field( default=None, - description="Reason provided by original signer who reassigned to this signer.", + description="_t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON", ) reassigned_from: Optional[StrictStr] = Field( - default=None, description="Previous signature identifier." + default=None, + description="_t__SignatureRequestResponseSignatures::REASSIGNED_FROM", ) error: Optional[StrictStr] = Field( - default=None, description="Error message pertaining to this signer, or null." + default=None, description="_t__SignatureRequestResponseSignatures::ERROR" ) __properties: ClassVar[List[str]] = [ "signature_id", diff --git a/sdks/python/dropbox_sign/models/signature_request_send_request.py b/sdks/python/dropbox_sign/models/signature_request_send_request.py index d1f7b7280..a9fb6235c 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_request.py @@ -65,12 +65,10 @@ class SignatureRequestSendRequest(BaseModel): description="Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.", ) signers: Optional[List[SubSignatureRequestSigner]] = Field( - default=None, - description="Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + default=None, description="_t__Sub::SignatureRequestSigner::DESCRIPTION" ) grouped_signers: Optional[List[SubSignatureRequestGroupedSigners]] = Field( - default=None, - description="Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.", + default=None, description="_t__Sub::SignatureRequestGroupedSigners::DESCRIPTION" ) allow_decline: Optional[StrictBool] = Field( default=False, @@ -80,8 +78,12 @@ class SignatureRequestSendRequest(BaseModel): default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", ) + allow_form_view: Optional[StrictBool] = Field( + default=False, + description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", + ) attachments: Optional[List[SubAttachment]] = Field( - default=None, description="A list describing the attachments" + default=None, description="_t__SubAttachment::LIST_DESCRIPTION" ) cc_email_addresses: Optional[List[StrictStr]] = Field( default=None, description="The email addresses that should be CCed." @@ -124,8 +126,7 @@ class SignatureRequestSendRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None signing_redirect_url: Optional[StrictStr] = Field( @@ -159,6 +160,7 @@ class SignatureRequestSendRequest(BaseModel): "grouped_signers", "allow_decline", "allow_reassign", + "allow_form_view", "attachments", "cc_email_addresses", "client_id", @@ -327,6 +329,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_reassign") is not None else False ), + "allow_form_view": ( + obj.get("allow_form_view") + if obj.get("allow_form_view") is not None + else False + ), "attachments": ( [SubAttachment.from_dict(_item) for _item in obj["attachments"]] if obj.get("attachments") is not None @@ -421,6 +428,7 @@ def openapi_types(cls) -> Dict[str, str]: "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", "allow_decline": "(bool,)", "allow_reassign": "(bool,)", + "allow_form_view": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", "client_id": "(str,)", diff --git a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py index f09727801..5b73a7473 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py @@ -41,7 +41,7 @@ class SignatureRequestSendWithTemplateRequest(BaseModel): description="Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used." ) signers: List[SubSignatureRequestTemplateSigner] = Field( - description="Add Signers to your Templated-based Signature Request." + description="_t__Sub::SignatureRequestTemplateSigner::DESCRIPTION" ) allow_decline: Optional[StrictBool] = Field( default=False, @@ -82,8 +82,7 @@ class SignatureRequestSendWithTemplateRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None signing_redirect_url: Optional[StrictStr] = Field( diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py index 615f1089e..c4f27a7a1 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py @@ -79,9 +79,9 @@ class SubFormFieldsPerDocumentBase(BaseModel): description="Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data." ) type: StrictStr - width: StrictInt = Field(description="Size of the field in pixels.") - x: StrictInt = Field(description="Location coordinates of the field in pixels.") - y: StrictInt = Field(description="Location coordinates of the field in pixels.") + width: StrictInt = Field(description="_t__Sub::FormFieldsPerDocument::WIDTH") + x: StrictInt = Field(description="_t__Sub::FormFieldsPerDocument::X") + y: StrictInt = Field(description="_t__Sub::FormFieldsPerDocument::Y") name: Optional[StrictStr] = Field( default=None, description="Display name for the field." ) diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py index c2e2c3ae4..1fa6e0811 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py @@ -61,8 +61,7 @@ class SubFormFieldsPerDocumentText(SubFormFieldsPerDocumentBase): description="Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.", ) validation_type: Optional[StrictStr] = Field( - default=None, - description="Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.", + default=None, description="_t__Sub::FormFieldsPerDocument::VALIDATION_TYPE" ) validation_custom_regex: Optional[StrictStr] = None validation_custom_regex_format_label: Optional[StrictStr] = None diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py index 990c2374a..4a2b117a0 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py @@ -36,7 +36,7 @@ class SubFormFieldsPerDocumentTextMerge(SubFormFieldsPerDocumentBase): """ # noqa: E501 type: StrictStr = Field( - description="A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class." + description="_t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE" ) font_family: Optional[StrictStr] = Field( default=None, description="Font family for the field." diff --git a/sdks/python/dropbox_sign/models/sub_merge_field.py b/sdks/python/dropbox_sign/models/sub_merge_field.py index e83058e97..b201a656c 100644 --- a/sdks/python/dropbox_sign/models/sub_merge_field.py +++ b/sdks/python/dropbox_sign/models/sub_merge_field.py @@ -32,8 +32,8 @@ class SubMergeField(BaseModel): SubMergeField """ # noqa: E501 - name: StrictStr = Field(description="The name of the merge field. Must be unique.") - type: StrictStr = Field(description="The type of merge field.") + name: StrictStr = Field(description="_t__Sub::MergeField::NAME") + type: StrictStr = Field(description="_t__Sub::MergeField::TYPE") __properties: ClassVar[List[str]] = ["name", "type"] @field_validator("type") diff --git a/sdks/python/dropbox_sign/models/sub_o_auth.py b/sdks/python/dropbox_sign/models/sub_o_auth.py index 2c11784aa..b0799f1b8 100644 --- a/sdks/python/dropbox_sign/models/sub_o_auth.py +++ b/sdks/python/dropbox_sign/models/sub_o_auth.py @@ -29,16 +29,14 @@ class SubOAuth(BaseModel): """ - OAuth related parameters. + _t__Sub::OAuth::DESCRIPTION """ # noqa: E501 callback_url: Optional[StrictStr] = Field( - default=None, - description="The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)", + default=None, description="_t__Sub::OAuth::CALLBACK_URL" ) scopes: Optional[List[StrictStr]] = Field( - default=None, - description="A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided).", + default=None, description="_t__Sub::OAuth::SCOPES" ) __properties: ClassVar[List[str]] = ["callback_url", "scopes"] diff --git a/sdks/python/dropbox_sign/models/sub_options.py b/sdks/python/dropbox_sign/models/sub_options.py index e7965f446..4dff91b1b 100644 --- a/sdks/python/dropbox_sign/models/sub_options.py +++ b/sdks/python/dropbox_sign/models/sub_options.py @@ -29,12 +29,11 @@ class SubOptions(BaseModel): """ - Additional options supported by API App. + _t__Sub::Options::DESCRIPTION """ # noqa: E501 can_insert_everywhere: Optional[StrictBool] = Field( - default=False, - description='Determines if signers can use "Insert Everywhere" when signing a document.', + default=False, description="_t__Sub::Options::CAN_INSERT_EVERYWHERE" ) __properties: ClassVar[List[str]] = ["can_insert_everywhere"] diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py index a14f315f0..9440bac37 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py @@ -33,13 +33,14 @@ class SubSignatureRequestGroupedSigners(BaseModel): SubSignatureRequestGroupedSigners """ # noqa: E501 - group: StrictStr = Field(description="The name of the group.") + group: StrictStr = Field( + description="_t__Sub::SignatureRequestGroupedSigners::GROUP_NAME" + ) signers: List[SubSignatureRequestSigner] = Field( - description="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." + description="_t__Sub::SignatureRequestGroupedSigners::SIGNERS" ) order: Optional[StrictInt] = Field( - default=None, - description="The order the group is required to sign in. Use this instead of Signer-level `order`.", + default=None, description="_t__Sub::SignatureRequestGroupedSigners::ORDER" ) __properties: ClassVar[List[str]] = ["group", "signers", "order"] diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py index 3337098c4..7ed9f0685 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py @@ -33,24 +33,23 @@ class SubSignatureRequestSigner(BaseModel): SubSignatureRequestSigner """ # noqa: E501 - name: StrictStr = Field(description="The name of the signer.") - email_address: StrictStr = Field(description="The email address of the signer.") + name: StrictStr = Field(description="_t__Sub::SignatureRequestSigner::SIGNER_NAME") + email_address: StrictStr = Field( + description="_t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS" + ) order: Optional[StrictInt] = Field( - default=None, description="The order the signer is required to sign in." + default=None, description="_t__Sub::SignatureRequestSigner::SIGNER_ORDER" ) pin: Optional[Annotated[str, Field(min_length=4, strict=True, max_length=12)]] = ( - Field( - default=None, - description="The 4- to 12-character access code that will secure this signer's signature page.", - ) + Field(default=None, description="_t__Sub::SignatureRequestSigner::SIGNER_PIN") ) sms_phone_number: Optional[StrictStr] = Field( default=None, - description="An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher.", + description="_t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER", ) sms_phone_number_type: Optional[StrictStr] = Field( default=None, - description="Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).", + description="_t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE", ) __properties: ClassVar[List[str]] = [ "name", diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py index 4d1e239ec..7b2acf144 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py @@ -33,24 +33,21 @@ class SubSignatureRequestTemplateSigner(BaseModel): SubSignatureRequestTemplateSigner """ # noqa: E501 - role: StrictStr = Field( - description="Must match an existing role in chosen Template(s). It's case-sensitive." + role: StrictStr = Field(description="_t__Sub::SignatureRequestTemplateSigner::ROLE") + name: StrictStr = Field(description="_t__Sub::SignatureRequestTemplateSigner::NAME") + email_address: StrictStr = Field( + description="_t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS" ) - name: StrictStr = Field(description="The name of the signer.") - email_address: StrictStr = Field(description="The email address of the signer.") pin: Optional[Annotated[str, Field(min_length=4, strict=True, max_length=12)]] = ( - Field( - default=None, - description="The 4- to 12-character access code that will secure this signer's signature page.", - ) + Field(default=None, description="_t__Sub::SignatureRequestTemplateSigner::PIN") ) sms_phone_number: Optional[StrictStr] = Field( default=None, - description="An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher.", + description="_t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER", ) sms_phone_number_type: Optional[StrictStr] = Field( default=None, - description="Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).", + description="_t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE", ) __properties: ClassVar[List[str]] = [ "role", diff --git a/sdks/python/dropbox_sign/models/sub_signing_options.py b/sdks/python/dropbox_sign/models/sub_signing_options.py index 717d3a8d7..e35c55a6c 100644 --- a/sdks/python/dropbox_sign/models/sub_signing_options.py +++ b/sdks/python/dropbox_sign/models/sub_signing_options.py @@ -36,23 +36,21 @@ class SubSigningOptions(BaseModel): """ - This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + _t__Sub::SigningOptions::DESCRIPTION """ # noqa: E501 - default_type: StrictStr = Field( - description="The default type shown (limited to the listed types)" - ) + default_type: StrictStr = Field(description="_t__Sub::SigningOptions::DEFAULT") draw: Optional[StrictBool] = Field( - default=False, description="Allows drawing the signature" + default=False, description="_t__Sub::SigningOptions::DRAW" ) phone: Optional[StrictBool] = Field( - default=False, description="Allows using a smartphone to email the signature" + default=False, description="_t__Sub::SigningOptions::PHONE" ) type: Optional[StrictBool] = Field( - default=False, description="Allows typing the signature" + default=False, description="_t__Sub::SigningOptions::TYPE" ) upload: Optional[StrictBool] = Field( - default=False, description="Allows uploading the signature" + default=False, description="_t__Sub::SigningOptions::UPLOAD" ) __properties: ClassVar[List[str]] = [ "default_type", diff --git a/sdks/python/dropbox_sign/models/sub_team_response.py b/sdks/python/dropbox_sign/models/sub_team_response.py index 5a3b7f74f..9ed4e4040 100644 --- a/sdks/python/dropbox_sign/models/sub_team_response.py +++ b/sdks/python/dropbox_sign/models/sub_team_response.py @@ -32,8 +32,10 @@ class SubTeamResponse(BaseModel): SubTeamResponse """ # noqa: E501 - team_id: Optional[StrictStr] = Field(default=None, description="The id of a team") - name: Optional[StrictStr] = Field(default=None, description="The name of a team") + team_id: Optional[StrictStr] = Field( + default=None, description="_t__TeamGeneral::TEAM_ID" + ) + name: Optional[StrictStr] = Field(default=None, description="_t__TeamGeneral::NAME") __properties: ClassVar[List[str]] = ["team_id", "name"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/sub_template_role.py b/sdks/python/dropbox_sign/models/sub_template_role.py index fd407632c..6e8c597b8 100644 --- a/sdks/python/dropbox_sign/models/sub_template_role.py +++ b/sdks/python/dropbox_sign/models/sub_template_role.py @@ -33,12 +33,10 @@ class SubTemplateRole(BaseModel): """ # noqa: E501 name: Optional[StrictStr] = Field( - default=None, - description="The role name of the signer that will be displayed when the template is used to create a signature request.", + default=None, description="_t__Sub::SignerRole::NAME" ) order: Optional[StrictInt] = Field( - default=None, - description="The order in which this signer role is required to sign.", + default=None, description="_t__Sub::SignerRole::ORDER" ) __properties: ClassVar[List[str]] = ["name", "order"] diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py index 318fd8056..e300bdc05 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py @@ -32,10 +32,12 @@ class SubUnclaimedDraftSigner(BaseModel): SubUnclaimedDraftSigner """ # noqa: E501 - email_address: StrictStr = Field(description="The email address of the signer.") - name: StrictStr = Field(description="The name of the signer.") + email_address: StrictStr = Field( + description="_t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS" + ) + name: StrictStr = Field(description="_t__Sub::UnclaimedDraftSigner::NAME") order: Optional[StrictInt] = Field( - default=None, description="The order the signer is required to sign in." + default=None, description="_t__Sub::UnclaimedDraftSigner::ORDER" ) __properties: ClassVar[List[str]] = ["email_address", "name", "order"] diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py index a668e9fdc..0ef4e234f 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py @@ -32,14 +32,10 @@ class SubUnclaimedDraftTemplateSigner(BaseModel): SubUnclaimedDraftTemplateSigner """ # noqa: E501 - role: StrictStr = Field( - description="Must match an existing role in chosen Template(s)." - ) - name: StrictStr = Field( - description="The name of the signer filling the role of `role`." - ) + role: StrictStr = Field(description="_t__Sub::UnclaimedDraftTemplateSigner::ROLE") + name: StrictStr = Field(description="_t__Sub::UnclaimedDraftTemplateSigner::NAME") email_address: StrictStr = Field( - description="The email address of the signer filling the role of `role`." + description="_t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS" ) __properties: ClassVar[List[str]] = ["role", "name", "email_address"] diff --git a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py index 9fe6f145c..4469c5a9d 100644 --- a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py @@ -36,7 +36,7 @@ class SubWhiteLabelingOptions(BaseModel): """ - An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. + _t__Sub::WhiteLabelingOptions::DESCRIPTION """ # noqa: E501 header_background_color: Optional[StrictStr] = "#1a1a1a" @@ -54,8 +54,7 @@ class SubWhiteLabelingOptions(BaseModel): text_color1: Optional[StrictStr] = "#808080" text_color2: Optional[StrictStr] = "#ffffff" reset_to_default: Optional[StrictBool] = Field( - default=None, - description="Resets white labeling options to defaults. Only useful when updating an API App.", + default=None, description="_t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT" ) __properties: ClassVar[List[str]] = [ "header_background_color", diff --git a/sdks/python/dropbox_sign/models/team_get_info_response.py b/sdks/python/dropbox_sign/models/team_get_info_response.py index e716e4daa..83a96a18b 100644 --- a/sdks/python/dropbox_sign/models/team_get_info_response.py +++ b/sdks/python/dropbox_sign/models/team_get_info_response.py @@ -36,7 +36,7 @@ class TeamGetInfoResponse(BaseModel): team: TeamInfoResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["team", "warnings"] diff --git a/sdks/python/dropbox_sign/models/team_get_response.py b/sdks/python/dropbox_sign/models/team_get_response.py index 3c137e35a..35c75db40 100644 --- a/sdks/python/dropbox_sign/models/team_get_response.py +++ b/sdks/python/dropbox_sign/models/team_get_response.py @@ -36,7 +36,7 @@ class TeamGetResponse(BaseModel): team: TeamResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["team", "warnings"] diff --git a/sdks/python/dropbox_sign/models/team_info_response.py b/sdks/python/dropbox_sign/models/team_info_response.py index b10d7cb82..43b8e00a6 100644 --- a/sdks/python/dropbox_sign/models/team_info_response.py +++ b/sdks/python/dropbox_sign/models/team_info_response.py @@ -33,14 +33,16 @@ class TeamInfoResponse(BaseModel): TeamInfoResponse """ # noqa: E501 - team_id: Optional[StrictStr] = Field(default=None, description="The id of a team") + team_id: Optional[StrictStr] = Field( + default=None, description="_t__TeamGeneral::TEAM_ID" + ) team_parent: Optional[TeamParentResponse] = None - name: Optional[StrictStr] = Field(default=None, description="The name of a team") + name: Optional[StrictStr] = Field(default=None, description="_t__TeamGeneral::NAME") num_members: Optional[StrictInt] = Field( - default=None, description="Number of members within a team" + default=None, description="_t__TeamGeneral::NUM_MEMBERS" ) num_sub_teams: Optional[StrictInt] = Field( - default=None, description="Number of sub teams within a team" + default=None, description="_t__TeamGeneral::NUM_SUB_TEAMS" ) __properties: ClassVar[List[str]] = [ "team_id", diff --git a/sdks/python/dropbox_sign/models/team_parent_response.py b/sdks/python/dropbox_sign/models/team_parent_response.py index 2478765be..24bc85260 100644 --- a/sdks/python/dropbox_sign/models/team_parent_response.py +++ b/sdks/python/dropbox_sign/models/team_parent_response.py @@ -32,8 +32,10 @@ class TeamParentResponse(BaseModel): Information about the parent team if a team has one, set to `null` otherwise. """ # noqa: E501 - team_id: Optional[StrictStr] = Field(default=None, description="The id of a team") - name: Optional[StrictStr] = Field(default=None, description="The name of a team") + team_id: Optional[StrictStr] = Field( + default=None, description="_t__TeamGeneral::TEAM_ID" + ) + name: Optional[StrictStr] = Field(default=None, description="_t__TeamGeneral::NAME") __properties: ClassVar[List[str]] = ["team_id", "name"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/team_response.py b/sdks/python/dropbox_sign/models/team_response.py index 9f72e11fe..6fbf7c08f 100644 --- a/sdks/python/dropbox_sign/models/team_response.py +++ b/sdks/python/dropbox_sign/models/team_response.py @@ -30,18 +30,16 @@ class TeamResponse(BaseModel): """ - Contains information about your team and its members + _t__TeamResponse::DESCRIPTION """ # noqa: E501 - name: Optional[StrictStr] = Field(default=None, description="The name of your Team") + name: Optional[StrictStr] = Field(default=None, description="_t__Team::NAME") accounts: Optional[List[AccountResponse]] = None invited_accounts: Optional[List[AccountResponse]] = Field( - default=None, - description="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`.", + default=None, description="_t__Team::INVITED_ACCOUNTS" ) invited_emails: Optional[List[StrictStr]] = Field( - default=None, - description="A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.", + default=None, description="_t__Team::INVITED_EMAILS" ) __properties: ClassVar[List[str]] = [ "name", diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py index 808ba1ce8..138854a29 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py @@ -64,8 +64,12 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", ) + allow_form_view: Optional[StrictBool] = Field( + default=False, + description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", + ) attachments: Optional[List[SubAttachment]] = Field( - default=None, description="A list describing the attachments" + default=None, description="_t__SubAttachment::LIST_DESCRIPTION" ) cc_roles: Optional[List[StrictStr]] = Field( default=None, @@ -101,8 +105,7 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): default=None, description="The default template email message." ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) show_preview: Optional[StrictBool] = Field( default=False, @@ -141,6 +144,7 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): "file_urls", "allow_ccs", "allow_reassign", + "allow_form_view", "attachments", "cc_roles", "editor_options", @@ -285,6 +289,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_reassign") is not None else False ), + "allow_form_view": ( + obj.get("allow_form_view") + if obj.get("allow_form_view") is not None + else False + ), "attachments": ( [SubAttachment.from_dict(_item) for _item in obj["attachments"]] if obj.get("attachments") is not None @@ -394,6 +403,7 @@ def openapi_types(cls) -> Dict[str, str]: "file_urls": "(List[str],)", "allow_ccs": "(bool,)", "allow_reassign": "(bool,)", + "allow_form_view": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_roles": "(List[str],)", "editor_options": "(SubEditorOptions,)", diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py index fb9a0eb9a..c018e0a54 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py @@ -38,7 +38,7 @@ class TemplateCreateEmbeddedDraftResponse(BaseModel): template: TemplateCreateEmbeddedDraftResponseTemplate warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["template", "warnings"] diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py index 3016dce2e..5a98c8e40 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py @@ -30,20 +30,22 @@ class TemplateCreateEmbeddedDraftResponseTemplate(BaseModel): """ - Template object with parameters: `template_id`, `edit_url`, `expires_at`. + _t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION """ # noqa: E501 template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." + default=None, description="_t__TemplateResponse::TEMPLATE_ID" ) edit_url: Optional[StrictStr] = Field( - default=None, description="Link to edit the template." + default=None, + description="_t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL", ) expires_at: Optional[StrictInt] = Field( - default=None, description="When the link expires." + default=None, + description="_t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT", ) warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = [ "template_id", diff --git a/sdks/python/dropbox_sign/models/template_create_request.py b/sdks/python/dropbox_sign/models/template_create_request.py index 532027646..fccfa8a71 100644 --- a/sdks/python/dropbox_sign/models/template_create_request.py +++ b/sdks/python/dropbox_sign/models/template_create_request.py @@ -62,8 +62,12 @@ class TemplateCreateRequest(BaseModel): default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", ) + allow_form_view: Optional[StrictBool] = Field( + default=False, + description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", + ) attachments: Optional[List[SubAttachment]] = Field( - default=None, description="A list describing the attachments" + default=None, description="_t__SubAttachment::LIST_DESCRIPTION" ) cc_roles: Optional[List[StrictStr]] = Field( default=None, @@ -90,8 +94,7 @@ class TemplateCreateRequest(BaseModel): default=None, description="The default template email message." ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) subject: Optional[Annotated[str, Field(strict=True, max_length=200)]] = Field( default=None, description="The template title (alias)." @@ -114,6 +117,7 @@ class TemplateCreateRequest(BaseModel): "files", "file_urls", "allow_reassign", + "allow_form_view", "attachments", "cc_roles", "client_id", @@ -257,6 +261,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_reassign") is not None else False ), + "allow_form_view": ( + obj.get("allow_form_view") + if obj.get("allow_form_view") is not None + else False + ), "attachments": ( [SubAttachment.from_dict(_item) for _item in obj["attachments"]] if obj.get("attachments") is not None @@ -324,6 +333,7 @@ def openapi_types(cls) -> Dict[str, str]: "files": "(List[io.IOBase],)", "file_urls": "(List[str],)", "allow_reassign": "(bool,)", + "allow_form_view": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_roles": "(List[str],)", "client_id": "(str,)", diff --git a/sdks/python/dropbox_sign/models/template_create_response.py b/sdks/python/dropbox_sign/models/template_create_response.py index bc5f6c6a2..f7b141cfa 100644 --- a/sdks/python/dropbox_sign/models/template_create_response.py +++ b/sdks/python/dropbox_sign/models/template_create_response.py @@ -38,7 +38,7 @@ class TemplateCreateResponse(BaseModel): template: TemplateCreateResponseTemplate warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["template", "warnings"] diff --git a/sdks/python/dropbox_sign/models/template_create_response_template.py b/sdks/python/dropbox_sign/models/template_create_response_template.py index 25d9bd7bd..e400ad801 100644 --- a/sdks/python/dropbox_sign/models/template_create_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_response_template.py @@ -29,11 +29,11 @@ class TemplateCreateResponseTemplate(BaseModel): """ - Template object with parameters: `template_id`. + _t__TemplateCreateResponseTemplate::DESCRIPTION """ # noqa: E501 template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." + default=None, description="_t__TemplateResponse::TEMPLATE_ID" ) __properties: ClassVar[List[str]] = ["template_id"] diff --git a/sdks/python/dropbox_sign/models/template_edit_response.py b/sdks/python/dropbox_sign/models/template_edit_response.py index 198813848..18ac2894d 100644 --- a/sdks/python/dropbox_sign/models/template_edit_response.py +++ b/sdks/python/dropbox_sign/models/template_edit_response.py @@ -32,7 +32,7 @@ class TemplateEditResponse(BaseModel): TemplateEditResponse """ # noqa: E501 - template_id: StrictStr = Field(description="The id of the Template.") + template_id: StrictStr = Field(description="_t__TemplateResponse::TEMPLATE_ID") __properties: ClassVar[List[str]] = ["template_id"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_get_response.py b/sdks/python/dropbox_sign/models/template_get_response.py index 10d714c52..5bcababc5 100644 --- a/sdks/python/dropbox_sign/models/template_get_response.py +++ b/sdks/python/dropbox_sign/models/template_get_response.py @@ -36,7 +36,7 @@ class TemplateGetResponse(BaseModel): template: TemplateResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["template", "warnings"] diff --git a/sdks/python/dropbox_sign/models/template_list_response.py b/sdks/python/dropbox_sign/models/template_list_response.py index 5ccaba716..874a17d6c 100644 --- a/sdks/python/dropbox_sign/models/template_list_response.py +++ b/sdks/python/dropbox_sign/models/template_list_response.py @@ -36,11 +36,11 @@ class TemplateListResponse(BaseModel): """ # noqa: E501 templates: List[TemplateResponse] = Field( - description="List of templates that the API caller has access to." + description="_t__TemplateListResponse::DESCRIPTION" ) list_info: ListInfoResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["templates", "list_info", "warnings"] diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index 667465fff..511675995 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -42,67 +42,56 @@ class TemplateResponse(BaseModel): """ - Contains information about the templates you and your team have created. + _t__TemplateResponse::DESCRIPTION """ # noqa: E501 template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." + default=None, description="_t__TemplateResponse::TEMPLATE_ID" ) title: Optional[StrictStr] = Field( - default=None, - description="The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.", + default=None, description="_t__TemplateResponse::TITLE" ) message: Optional[StrictStr] = Field( - default=None, - description="The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.", + default=None, description="_t__TemplateResponse::MESSAGE" ) updated_at: Optional[StrictInt] = Field( - default=None, description="Time the template was last updated." + default=None, description="_t__TemplateResponse::UPDATED_AT" ) is_embedded: Optional[StrictBool] = Field( - default=None, - description="`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.", + default=None, description="_t__TemplateResponse::IS_EMBEDDED" ) is_creator: Optional[StrictBool] = Field( - default=None, - description="`true` if you are the owner of this template, `false` if it's been shared with you by a team member.", + default=None, description="_t__TemplateResponse::IS_CREATOR" ) can_edit: Optional[StrictBool] = Field( - default=None, - description="Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).", + default=None, description="_t__TemplateResponse::CAN_EDIT" ) is_locked: Optional[StrictBool] = Field( - default=None, - description="Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.", + default=None, description="_t__TemplateResponse::IS_LOCKED" ) metadata: Optional[Dict[str, Any]] = Field( - default=None, description="The metadata attached to the template." + default=None, description="_t__TemplateResponse::METADATA" ) signer_roles: Optional[List[TemplateResponseSignerRole]] = Field( - default=None, - description="An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.", + default=None, description="_t__TemplateResponse::SIGNER_ROLES" ) cc_roles: Optional[List[TemplateResponseCCRole]] = Field( - default=None, - description="An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.", + default=None, description="_t__TemplateResponse::CC_ROLES" ) documents: Optional[List[TemplateResponseDocument]] = Field( - default=None, - description="An array describing each document associated with this Template. Includes form field data for each document.", + default=None, description="_t__TemplateResponse::DOCUMENTS" ) custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( - default=None, - description="Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.", + default=None, description="_t__TemplateResponseCustomField::DESCRIPTION" ) named_form_fields: Optional[List[TemplateResponseDocumentFormFieldBase]] = Field( - default=None, - description="Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.", + default=None, description="_t__TemplateResponseNamedFormField::DESCRIPTION" ) accounts: Optional[List[TemplateResponseAccount]] = Field( - default=None, description="An array of the Accounts that can use this Template." + default=None, description="_t__TemplateResponse::ACCOUNTS" ) attachments: Optional[List[SignatureRequestResponseAttachment]] = Field( - default=None, description="Signer attachments." + default=None, description="_t__SignatureRequestResponseAttachment::DESCRIPTION" ) __properties: ClassVar[List[str]] = [ "template_id", diff --git a/sdks/python/dropbox_sign/models/template_response_account.py b/sdks/python/dropbox_sign/models/template_response_account.py index d29db33d0..2a0fe0484 100644 --- a/sdks/python/dropbox_sign/models/template_response_account.py +++ b/sdks/python/dropbox_sign/models/template_response_account.py @@ -36,22 +36,19 @@ class TemplateResponseAccount(BaseModel): """ # noqa: E501 account_id: Optional[StrictStr] = Field( - default=None, description="The id of the Account." + default=None, description="_t__TemplateResponseAccount::ACCOUNT_ID" ) email_address: Optional[StrictStr] = Field( - default=None, description="The email address associated with the Account." + default=None, description="_t__TemplateResponseAccount::EMAIL_ADDRESS" ) is_locked: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has been locked out of their account by a team admin.", + default=None, description="_t__TemplateResponseAccount::IS_LOCKED" ) is_paid_hs: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has a paid Dropbox Sign account.", + default=None, description="_t__TemplateResponseAccount::IS_PAID_HS" ) is_paid_hf: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has a paid HelloFax account.", + default=None, description="_t__TemplateResponseAccount::IS_PAID_HF" ) quotas: Optional[TemplateResponseAccountQuota] = None __properties: ClassVar[List[str]] = [ diff --git a/sdks/python/dropbox_sign/models/template_response_account_quota.py b/sdks/python/dropbox_sign/models/template_response_account_quota.py index e4fa3668b..204d130ce 100644 --- a/sdks/python/dropbox_sign/models/template_response_account_quota.py +++ b/sdks/python/dropbox_sign/models/template_response_account_quota.py @@ -29,20 +29,22 @@ class TemplateResponseAccountQuota(BaseModel): """ - An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + _t__TemplateResponseAccountQuota::DESCRIPTION """ # noqa: E501 templates_left: Optional[StrictInt] = Field( - default=None, description="API templates remaining." + default=None, description="_t__TemplateResponseAccountQuota::TEMPLATES_LEFT" ) api_signature_requests_left: Optional[StrictInt] = Field( - default=None, description="API signature requests remaining." + default=None, + description="_t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT", ) documents_left: Optional[StrictInt] = Field( - default=None, description="Signature requests remaining." + default=None, description="_t__TemplateResponseAccountQuota::DOCUMENTS_LEFT" ) sms_verifications_left: Optional[StrictInt] = Field( - default=None, description="SMS verifications remaining." + default=None, + description="_t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT", ) __properties: ClassVar[List[str]] = [ "templates_left", diff --git a/sdks/python/dropbox_sign/models/template_response_cc_role.py b/sdks/python/dropbox_sign/models/template_response_cc_role.py index 89a3b4c88..7947705e8 100644 --- a/sdks/python/dropbox_sign/models/template_response_cc_role.py +++ b/sdks/python/dropbox_sign/models/template_response_cc_role.py @@ -32,7 +32,9 @@ class TemplateResponseCCRole(BaseModel): TemplateResponseCCRole """ # noqa: E501 - name: Optional[StrictStr] = Field(default=None, description="The name of the Role.") + name: Optional[StrictStr] = Field( + default=None, description="_t__TemplateResponseCCRole::NAME" + ) __properties: ClassVar[List[str]] = ["name"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_document.py b/sdks/python/dropbox_sign/models/template_response_document.py index d2f0cafb6..58acac220 100644 --- a/sdks/python/dropbox_sign/models/template_response_document.py +++ b/sdks/python/dropbox_sign/models/template_response_document.py @@ -45,26 +45,22 @@ class TemplateResponseDocument(BaseModel): """ # noqa: E501 name: Optional[StrictStr] = Field( - default=None, description="Name of the associated file." + default=None, description="_t__TemplateResponseDocument::NAME" ) index: Optional[StrictInt] = Field( - default=None, - description="Document ordering, the lowest index is displayed first and the highest last (0-based indexing).", + default=None, description="_t__TemplateResponseDocument::INDEX" ) field_groups: Optional[List[TemplateResponseDocumentFieldGroup]] = Field( - default=None, description="An array of Form Field Group objects." + default=None, description="_t__TemplateResponseDocument::FIELD_GROUPS" ) form_fields: Optional[List[TemplateResponseDocumentFormFieldBase]] = Field( - default=None, - description="An array of Form Field objects containing the name and type of each named field.", + default=None, description="_t__TemplateResponseDocumentFormField::DESCRIPTION" ) custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( - default=None, - description="An array of Form Field objects containing the name and type of each named field.", + default=None, description="_t__TemplateResponseDocumentCustomField::DESCRIPTION" ) static_fields: Optional[List[TemplateResponseDocumentStaticFieldBase]] = Field( - default=None, - description="An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.", + default=None, description="_t__TemplateResponseDocumentStaticField::DESCRIPTION" ) __properties: ClassVar[List[str]] = [ "name", diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py index 6c6a35b7e..13a5828bd 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py @@ -40,38 +40,36 @@ class TemplateResponseDocumentCustomFieldBase(BaseModel): """ - An array of Form Field objects containing the name and type of each named field. + _t__TemplateResponseDocumentCustomField::DESCRIPTION """ # noqa: E501 type: StrictStr api_id: Optional[StrictStr] = Field( - default=None, description="The unique ID for this field." + default=None, description="_t__TemplateResponseDocumentCustomField::API_ID" ) name: Optional[StrictStr] = Field( - default=None, description="The name of the Custom Field." + default=None, description="_t__TemplateResponseDocumentCustomField::NAME" ) signer: Union[StrictStr, StrictInt, None] = Field( - description="The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender)." + description="_t__TemplateResponseDocumentCustomField::SIGNER" ) x: Optional[StrictInt] = Field( - default=None, description="The horizontal offset in pixels for this form field." + default=None, description="_t__TemplateResponseDocumentCustomField::X" ) y: Optional[StrictInt] = Field( - default=None, description="The vertical offset in pixels for this form field." + default=None, description="_t__TemplateResponseDocumentCustomField::Y" ) width: Optional[StrictInt] = Field( - default=None, description="The width in pixels of this form field." + default=None, description="_t__TemplateResponseDocumentCustomField::WIDTH" ) height: Optional[StrictInt] = Field( - default=None, description="The height in pixels of this form field." + default=None, description="_t__TemplateResponseDocumentCustomField::HEIGHT" ) required: Optional[StrictBool] = Field( - default=None, - description="Boolean showing whether or not this field is required.", + default=None, description="_t__TemplateResponseDocumentStaticField::REQUIRED" ) group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null`.", + default=None, description="_t__TemplateResponseDocumentCustomField::GROUP" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py index 35e391517..d1320757a 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py @@ -34,12 +34,10 @@ class TemplateResponseDocumentCustomFieldCheckbox( TemplateResponseDocumentCustomFieldBase ): """ - This class extends `TemplateResponseDocumentCustomFieldBase` + _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentCustomField::TYPE") __properties: ClassVar[List[str]] = [ "type", "api_id", diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py index 09a85e20f..bce1416f2 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py @@ -35,26 +35,24 @@ class TemplateResponseDocumentCustomFieldText(TemplateResponseDocumentCustomFieldBase): """ - This class extends `TemplateResponseDocumentCustomFieldBase` + _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentCustomField::TYPE") avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None is_multiline: Optional[StrictBool] = Field( default=None, - description="Whether this form field is multiline text.", + description="_t__TemplateResponseDocumentCustomField::IS_MULTILINE", alias="isMultiline", ) original_font_size: Optional[StrictInt] = Field( default=None, - description="Original font size used in this form field's text.", + description="_t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE", alias="originalFontSize", ) font_family: Optional[StrictStr] = Field( default=None, - description="Font family used in this form field's text.", + description="_t__TemplateResponseDocumentCustomField::FONT_FAMILY", alias="fontFamily", ) __properties: ClassVar[List[str]] = [ diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group.py b/sdks/python/dropbox_sign/models/template_response_document_field_group.py index 8f3bc1a16..55575ccd7 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group.py @@ -36,7 +36,7 @@ class TemplateResponseDocumentFieldGroup(BaseModel): """ # noqa: E501 name: Optional[StrictStr] = Field( - default=None, description="The name of the form field group." + default=None, description="_t__TemplateResponseDocumentFieldGroup::NAME" ) rule: Optional[TemplateResponseDocumentFieldGroupRule] = None __properties: ClassVar[List[str]] = ["name", "rule"] diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py index 17d81cbd9..a2ff4ef5d 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py @@ -29,15 +29,17 @@ class TemplateResponseDocumentFieldGroupRule(BaseModel): """ - The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). + _t__TemplateResponseDocumentFieldGroup::RULE """ # noqa: E501 requirement: Optional[StrictStr] = Field( default=None, - description="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.", + description="_t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT", ) group_label: Optional[StrictStr] = Field( - default=None, description="Name of the group", alias="groupLabel" + default=None, + description="_t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL", + alias="groupLabel", ) __properties: ClassVar[List[str]] = ["requirement", "groupLabel"] diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py index 6f8777a3b..8230219a0 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py @@ -58,34 +58,33 @@ class TemplateResponseDocumentFormFieldBase(BaseModel): """ - An array of Form Field objects containing the name and type of each named field. + _t__TemplateResponseDocumentFormField::DESCRIPTION """ # noqa: E501 type: StrictStr api_id: Optional[StrictStr] = Field( - default=None, description="A unique id for the form field." + default=None, description="_t__TemplateResponseDocumentFormField::API_ID" ) name: Optional[StrictStr] = Field( - default=None, description="The name of the form field." + default=None, description="_t__TemplateResponseDocumentFormField::NAME" ) signer: Union[StrictStr, StrictInt] = Field( - description="The signer of the Form Field." + description="_t__TemplateResponseDocumentFormField::SIGNER" ) x: Optional[StrictInt] = Field( - default=None, description="The horizontal offset in pixels for this form field." + default=None, description="_t__TemplateResponseDocumentFormField::X" ) y: Optional[StrictInt] = Field( - default=None, description="The vertical offset in pixels for this form field." + default=None, description="_t__TemplateResponseDocumentFormField::Y" ) width: Optional[StrictInt] = Field( - default=None, description="The width in pixels of this form field." + default=None, description="_t__TemplateResponseDocumentFormField::WIDTH" ) height: Optional[StrictInt] = Field( - default=None, description="The height in pixels of this form field." + default=None, description="_t__TemplateResponseDocumentFormField::HEIGHT" ) required: Optional[StrictBool] = Field( - default=None, - description="Boolean showing whether or not this field is required.", + default=None, description="_t__TemplateResponseDocumentFormField::REQUIRED" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py index d81d6572a..31a6c198b 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py @@ -32,15 +32,12 @@ class TemplateResponseDocumentFormFieldCheckbox(TemplateResponseDocumentFormFieldBase): """ - This class extends `TemplateResponseDocumentFormFieldBase` + _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentFormField::TYPE") group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + default=None, description="_t__TemplateResponseDocumentFormField::GROUP" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py index 8ee5fe31b..6e1095d71 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py @@ -34,15 +34,12 @@ class TemplateResponseDocumentFormFieldDateSigned( TemplateResponseDocumentFormFieldBase ): """ - This class extends `TemplateResponseDocumentFormFieldBase` + _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentFormField::TYPE") group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + default=None, description="_t__TemplateResponseDocumentFormField::GROUP" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py index 2b30ae4c5..265af2096 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py @@ -32,15 +32,12 @@ class TemplateResponseDocumentFormFieldDropdown(TemplateResponseDocumentFormFieldBase): """ - This class extends `TemplateResponseDocumentFormFieldBase` + _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentFormField::TYPE") group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + default=None, description="_t__TemplateResponseDocumentFormField::GROUP" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py index 0102248d3..4ca464603 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py @@ -35,31 +35,28 @@ class TemplateResponseDocumentFormFieldHyperlink(TemplateResponseDocumentFormFieldBase): """ - This class extends `TemplateResponseDocumentFormFieldBase` + _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentFormField::TYPE") avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None is_multiline: Optional[StrictBool] = Field( default=None, - description="Whether this form field is multiline text.", + description="_t__TemplateResponseDocumentFormField::IS_MULTILINE", alias="isMultiline", ) original_font_size: Optional[StrictInt] = Field( default=None, - description="Original font size used in this form field's text.", + description="_t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE", alias="originalFontSize", ) font_family: Optional[StrictStr] = Field( default=None, - description="Font family used in this form field's text.", + description="_t__TemplateResponseDocumentFormField::FONT_FAMILY", alias="fontFamily", ) group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + default=None, description="_t__TemplateResponseDocumentFormField::GROUP" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py index 64321add8..dccd62790 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py @@ -32,15 +32,12 @@ class TemplateResponseDocumentFormFieldInitials(TemplateResponseDocumentFormFieldBase): """ - This class extends `TemplateResponseDocumentFormFieldBase` + _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentFormField::TYPE") group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + default=None, description="_t__TemplateResponseDocumentFormField::GROUP" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py index 0f0c3443a..a3cb9d9f3 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py @@ -32,15 +32,11 @@ class TemplateResponseDocumentFormFieldRadio(TemplateResponseDocumentFormFieldBase): """ - This class extends `TemplateResponseDocumentFormFieldBase` + _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" - ) - group: StrictStr = Field( - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields." - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentFormField::TYPE") + group: StrictStr = Field(description="_t__TemplateResponseDocumentFormField::GROUP") __properties: ClassVar[List[str]] = [ "type", "group", diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py index c509f92ce..722a285ad 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py @@ -32,15 +32,12 @@ class TemplateResponseDocumentFormFieldSignature(TemplateResponseDocumentFormFieldBase): """ - This class extends `TemplateResponseDocumentFormFieldBase` + _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentFormField::TYPE") group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + default=None, description="_t__TemplateResponseDocumentFormField::GROUP" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py index 6280970f4..438e93620 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py @@ -42,43 +42,39 @@ class TemplateResponseDocumentFormFieldText(TemplateResponseDocumentFormFieldBase): """ - This class extends `TemplateResponseDocumentFormFieldBase` + _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentFormField::TYPE") avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None is_multiline: Optional[StrictBool] = Field( default=None, - description="Whether this form field is multiline text.", + description="_t__TemplateResponseDocumentFormField::IS_MULTILINE", alias="isMultiline", ) original_font_size: Optional[StrictInt] = Field( default=None, - description="Original font size used in this form field's text.", + description="_t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE", alias="originalFontSize", ) font_family: Optional[StrictStr] = Field( default=None, - description="Font family used in this form field's text.", + description="_t__TemplateResponseDocumentFormField::FONT_FAMILY", alias="fontFamily", ) validation_type: Optional[StrictStr] = Field( default=None, - description="Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.", + description="_t__TemplateResponseDocumentFormField::VALIDATION_TYPE", ) validation_custom_regex: Optional[StrictStr] = Field( - default=None, - description="When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field.", + default=None, description="_t__TemplateResponseDocumentFormField::CUSTOM_REGEX" ) validation_custom_regex_format_label: Optional[StrictStr] = Field( default=None, - description="When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern.", + description="_t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL", ) group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + default=None, description="_t__TemplateResponseDocumentFormField::GROUP" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py index d9735c703..a2456a1e3 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py @@ -58,39 +58,36 @@ class TemplateResponseDocumentStaticFieldBase(BaseModel): """ - An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + _t__TemplateResponseDocumentStaticField::DESCRIPTION """ # noqa: E501 type: StrictStr api_id: Optional[StrictStr] = Field( - default=None, description="A unique id for the static field." + default=None, description="_t__TemplateResponseDocumentStaticField::API_ID" ) name: Optional[StrictStr] = Field( - default=None, description="The name of the static field." + default=None, description="_t__TemplateResponseDocumentStaticField::NAME" ) signer: Optional[StrictStr] = Field( - default="me_now", description="The signer of the Static Field." + default="me_now", description="_t__TemplateResponseDocumentStaticField::SIGNER" ) x: Optional[StrictInt] = Field( - default=None, - description="The horizontal offset in pixels for this static field.", + default=None, description="_t__TemplateResponseDocumentStaticField::X" ) y: Optional[StrictInt] = Field( - default=None, description="The vertical offset in pixels for this static field." + default=None, description="_t__TemplateResponseDocumentStaticField::Y" ) width: Optional[StrictInt] = Field( - default=None, description="The width in pixels of this static field." + default=None, description="_t__TemplateResponseDocumentStaticField::WIDTH" ) height: Optional[StrictInt] = Field( - default=None, description="The height in pixels of this static field." + default=None, description="_t__TemplateResponseDocumentStaticField::HEIGHT" ) required: Optional[StrictBool] = Field( - default=None, - description="Boolean showing whether or not this field is required.", + default=None, description="_t__TemplateResponseDocumentStaticField::REQUIRED" ) group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null`.", + default=None, description="_t__TemplateResponseDocumentStaticField::GROUP" ) __properties: ClassVar[List[str]] = [ "type", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py index 0afba0d9f..2d839bf22 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py @@ -34,12 +34,10 @@ class TemplateResponseDocumentStaticFieldCheckbox( TemplateResponseDocumentStaticFieldBase ): """ - This class extends `TemplateResponseDocumentStaticFieldBase` + _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentStaticField::TYPE") __properties: ClassVar[List[str]] = [ "type", "api_id", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py index 0b232a6c9..12916b6a0 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py @@ -34,12 +34,10 @@ class TemplateResponseDocumentStaticFieldDateSigned( TemplateResponseDocumentStaticFieldBase ): """ - This class extends `TemplateResponseDocumentStaticFieldBase` + _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentStaticField::TYPE") __properties: ClassVar[List[str]] = [ "type", "api_id", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py index 7ac71ec4e..39cc8b6a8 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py @@ -34,12 +34,10 @@ class TemplateResponseDocumentStaticFieldDropdown( TemplateResponseDocumentStaticFieldBase ): """ - This class extends `TemplateResponseDocumentStaticFieldBase` + _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentStaticField::TYPE") __properties: ClassVar[List[str]] = [ "type", "api_id", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py index bdd27c9d2..931121c0b 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py @@ -34,12 +34,10 @@ class TemplateResponseDocumentStaticFieldHyperlink( TemplateResponseDocumentStaticFieldBase ): """ - This class extends `TemplateResponseDocumentStaticFieldBase` + _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentStaticField::TYPE") __properties: ClassVar[List[str]] = [ "type", "api_id", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py index bd755ee8e..6d369e524 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py @@ -34,12 +34,10 @@ class TemplateResponseDocumentStaticFieldInitials( TemplateResponseDocumentStaticFieldBase ): """ - This class extends `TemplateResponseDocumentStaticFieldBase` + _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentStaticField::TYPE") __properties: ClassVar[List[str]] = [ "type", "api_id", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py index a78d5b803..c53505ea9 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py @@ -32,12 +32,10 @@ class TemplateResponseDocumentStaticFieldRadio(TemplateResponseDocumentStaticFieldBase): """ - This class extends `TemplateResponseDocumentStaticFieldBase` + _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentStaticField::TYPE") __properties: ClassVar[List[str]] = [ "type", "api_id", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py index c0ff8eee6..daca550ab 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py @@ -34,12 +34,10 @@ class TemplateResponseDocumentStaticFieldSignature( TemplateResponseDocumentStaticFieldBase ): """ - This class extends `TemplateResponseDocumentStaticFieldBase` + _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentStaticField::TYPE") __properties: ClassVar[List[str]] = [ "type", "api_id", diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py index 03a3a4831..99122bcaf 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py @@ -32,12 +32,10 @@ class TemplateResponseDocumentStaticFieldText(TemplateResponseDocumentStaticFieldBase): """ - This class extends `TemplateResponseDocumentStaticFieldBase` + _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS """ # noqa: E501 - type: StrictStr = Field( - description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" - ) + type: StrictStr = Field(description="_t__TemplateResponseDocumentStaticField::TYPE") __properties: ClassVar[List[str]] = [ "type", "api_id", diff --git a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py index 1936e75ee..1aa04e342 100644 --- a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py +++ b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py @@ -29,12 +29,15 @@ class TemplateResponseFieldAvgTextLength(BaseModel): """ - Average text length in this field. + _t__TemplateResponseFieldAvgTextLength::DESCRIPTION """ # noqa: E501 - num_lines: Optional[StrictInt] = Field(default=None, description="Number of lines.") + num_lines: Optional[StrictInt] = Field( + default=None, description="_t__TemplateResponseFieldAvgTextLength::NUM_LINES" + ) num_chars_per_line: Optional[StrictInt] = Field( - default=None, description="Number of characters per line." + default=None, + description="_t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE", ) __properties: ClassVar[List[str]] = ["num_lines", "num_chars_per_line"] diff --git a/sdks/python/dropbox_sign/models/template_response_signer_role.py b/sdks/python/dropbox_sign/models/template_response_signer_role.py index 2cada158d..b1d07186f 100644 --- a/sdks/python/dropbox_sign/models/template_response_signer_role.py +++ b/sdks/python/dropbox_sign/models/template_response_signer_role.py @@ -32,10 +32,11 @@ class TemplateResponseSignerRole(BaseModel): TemplateResponseSignerRole """ # noqa: E501 - name: Optional[StrictStr] = Field(default=None, description="The name of the Role.") + name: Optional[StrictStr] = Field( + default=None, description="_t__TemplateResponseSignerRole::NAME" + ) order: Optional[StrictInt] = Field( - default=None, - description="If signer order is assigned this is the 0-based index for this role.", + default=None, description="_t__TemplateResponseSignerRole::ORDER" ) __properties: ClassVar[List[str]] = ["name", "order"] diff --git a/sdks/python/dropbox_sign/models/template_update_files_response_template.py b/sdks/python/dropbox_sign/models/template_update_files_response_template.py index 2a8cd11ad..ba0cc72e6 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response_template.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response_template.py @@ -30,14 +30,14 @@ class TemplateUpdateFilesResponseTemplate(BaseModel): """ - Contains template id + _t__TemplateUpdateFilesResponseTemplate::DESCRIPTION """ # noqa: E501 template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." + default=None, description="_t__TemplateResponse::TEMPLATE_ID" ) warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["template_id", "warnings"] diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py index 53527e34c..dfb1fe95a 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py @@ -75,12 +75,16 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) + allow_form_view: Optional[StrictBool] = Field( + default=False, + description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", + ) allow_reassign: Optional[StrictBool] = Field( default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", ) attachments: Optional[List[SubAttachment]] = Field( - default=None, description="A list describing the attachments" + default=None, description="_t__SubAttachment::LIST_DESCRIPTION" ) cc_email_addresses: Optional[List[StrictStr]] = Field( default=None, description="The email addresses that should be CCed." @@ -128,8 +132,7 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) requesting_redirect_url: Optional[StrictStr] = Field( default=None, @@ -144,8 +147,7 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): description="When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.", ) signers: Optional[List[SubUnclaimedDraftSigner]] = Field( - default=None, - description="Add Signers to your Unclaimed Draft Signature Request.", + default=None, description="_t__Sub::UnclaimedDraftSigner::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None signing_redirect_url: Optional[StrictStr] = Field( @@ -191,6 +193,7 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): "file_urls", "allow_ccs", "allow_decline", + "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -361,6 +364,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), + "allow_form_view": ( + obj.get("allow_form_view") + if obj.get("allow_form_view") is not None + else False + ), "allow_reassign": ( obj.get("allow_reassign") if obj.get("allow_reassign") is not None @@ -512,6 +520,7 @@ def openapi_types(cls) -> Dict[str, str]: "file_urls": "(List[str],)", "allow_ccs": "(bool,)", "allow_decline": "(bool,)", + "allow_form_view": "(bool,)", "allow_reassign": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py index 3ab702393..c89110d3d 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py @@ -99,8 +99,7 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) preview_only: Optional[StrictBool] = Field( default=False, @@ -119,8 +118,7 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest(BaseModel): description="When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.", ) signers: Optional[List[SubUnclaimedDraftTemplateSigner]] = Field( - default=None, - description="Add Signers to your Templated-based Signature Request.", + default=None, description="_t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None signing_redirect_url: Optional[StrictStr] = Field( diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py index 49a7aeec3..c4ee0bb73 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py @@ -67,8 +67,12 @@ class UnclaimedDraftCreateRequest(BaseModel): default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) + allow_form_view: Optional[StrictBool] = Field( + default=False, + description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", + ) attachments: Optional[List[SubAttachment]] = Field( - default=None, description="A list describing the attachments" + default=None, description="_t__SubAttachment::LIST_DESCRIPTION" ) cc_email_addresses: Optional[List[StrictStr]] = Field( default=None, description="The email addresses that should be CCed." @@ -103,16 +107,14 @@ class UnclaimedDraftCreateRequest(BaseModel): description="The custom message in the email that will be sent to the signers.", ) metadata: Optional[Dict[str, Any]] = Field( - default=None, - description="Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.", + default=None, description="_t__Sub::Metadata::DESCRIPTION" ) show_progress_stepper: Optional[StrictBool] = Field( default=True, description="When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.", ) signers: Optional[List[SubUnclaimedDraftSigner]] = Field( - default=None, - description="Add Signers to your Unclaimed Draft Signature Request.", + default=None, description="_t__Sub::UnclaimedDraftSigner::DESCRIPTION" ) signing_options: Optional[SubSigningOptions] = None signing_redirect_url: Optional[StrictStr] = Field( @@ -144,6 +146,7 @@ class UnclaimedDraftCreateRequest(BaseModel): "files", "file_urls", "allow_decline", + "allow_form_view", "attachments", "cc_email_addresses", "client_id", @@ -294,6 +297,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), + "allow_form_view": ( + obj.get("allow_form_view") + if obj.get("allow_form_view") is not None + else False + ), "attachments": ( [SubAttachment.from_dict(_item) for _item in obj["attachments"]] if obj.get("attachments") is not None @@ -397,6 +405,7 @@ def openapi_types(cls) -> Dict[str, str]: "files": "(List[io.IOBase],)", "file_urls": "(List[str],)", "allow_decline": "(bool,)", + "allow_form_view": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", "client_id": "(str,)", diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py index 085e5b907..399b40123 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py @@ -36,7 +36,7 @@ class UnclaimedDraftCreateResponse(BaseModel): unclaimed_draft: UnclaimedDraftResponse warnings: Optional[List[WarningResponse]] = Field( - default=None, description="A list of warnings." + default=None, description="_t__WarningResponse::LIST_DESCRIPTION" ) __properties: ClassVar[List[str]] = ["unclaimed_draft", "warnings"] diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py index 51fdcfa9b..26df024ca 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py @@ -29,30 +29,26 @@ class UnclaimedDraftResponse(BaseModel): """ - A group of documents that a user can take ownership of via the claim URL. + _t__UnclaimedDraftResponse::DESCRIPTION """ # noqa: E501 signature_request_id: Optional[StrictStr] = Field( - default=None, - description="The ID of the signature request that is represented by this UnclaimedDraft.", + default=None, description="_t__UnclaimedDraft::SIGNATURE_REQUEST_ID" ) claim_url: Optional[StrictStr] = Field( - default=None, description="The URL to be used to claim this UnclaimedDraft." + default=None, description="_t__UnclaimedDraft::CLAIM_URL" ) signing_redirect_url: Optional[StrictStr] = Field( - default=None, - description="The URL you want signers redirected to after they successfully sign.", + default=None, description="_t__UnclaimedDraft::SIGNING_REDIRECT_URL" ) requesting_redirect_url: Optional[StrictStr] = Field( - default=None, - description="The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).", + default=None, description="_t__UnclaimedDraft::REQUESTING_REDIRECT_URL" ) expires_at: Optional[StrictInt] = Field( - default=None, description="When the link expires." + default=None, description="_t__UnclaimedDraft::EXPIRES_AT" ) test_mode: Optional[StrictBool] = Field( - default=None, - description="Whether this is a test draft. Signature requests made from test drafts have no legal value.", + default=None, description="_t__UnclaimedDraft::TEST_MODE" ) __properties: ClassVar[List[str]] = [ "signature_request_id", diff --git a/sdks/python/dropbox_sign/models/warning_response.py b/sdks/python/dropbox_sign/models/warning_response.py index d2a26d5c3..319b123d3 100644 --- a/sdks/python/dropbox_sign/models/warning_response.py +++ b/sdks/python/dropbox_sign/models/warning_response.py @@ -29,11 +29,11 @@ class WarningResponse(BaseModel): """ - A list of warnings. + _t__WarningResponse::LIST_DESCRIPTION """ # noqa: E501 - warning_msg: StrictStr = Field(description="Warning message") - warning_name: StrictStr = Field(description="Warning name") + warning_msg: StrictStr = Field(description="_t__WarningResponse::WARNING_MSG") + warning_name: StrictStr = Field(description="_t__WarningResponse::WARNING_NAME") __properties: ClassVar[List[str]] = ["warning_msg", "warning_name"] model_config = ConfigDict( diff --git a/sdks/ruby/docs/AccountCreateResponse.md b/sdks/ruby/docs/AccountCreateResponse.md index 0a15db35d..a1f8fb633 100644 --- a/sdks/ruby/docs/AccountCreateResponse.md +++ b/sdks/ruby/docs/AccountCreateResponse.md @@ -8,5 +8,5 @@ | ---- | ---- | ----------- | ----- | | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | | `oauth_data` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/AccountGetResponse.md b/sdks/ruby/docs/AccountGetResponse.md index f3b133461..c6ec35dc5 100644 --- a/sdks/ruby/docs/AccountGetResponse.md +++ b/sdks/ruby/docs/AccountGetResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/AccountResponse.md b/sdks/ruby/docs/AccountResponse.md index 294f29431..6d5bb1e3d 100644 --- a/sdks/ruby/docs/AccountResponse.md +++ b/sdks/ruby/docs/AccountResponse.md @@ -6,15 +6,15 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `account_id` | ```String``` | The ID of the Account | | -| `email_address` | ```String``` | The email address associated with the Account. | | -| `is_locked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `account_id` | ```String``` | _t__Account::ACCOUNT_ID | | +| `email_address` | ```String``` | _t__Account::EMAIL_ADDRESS | | +| `is_locked` | ```Boolean``` | _t__Account::IS_LOCKED | | +| `is_paid_hs` | ```Boolean``` | _t__Account::IS_PAID_HS | | +| `is_paid_hf` | ```Boolean``` | _t__Account::IS_PAID_HF | | | `quotas` | [```AccountResponseQuotas```](AccountResponseQuotas.md) | | | -| `callback_url` | ```String``` | The URL that Dropbox Sign events will `POST` to. | | -| `role_code` | ```String``` | The membership role for the team. | | -| `team_id` | ```String``` | The id of the team account belongs to. | | -| `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. | | +| `callback_url` | ```String``` | _t__Account::CALLBACK_URL | | +| `role_code` | ```String``` | _t__Account::ROLE_CODE | | +| `team_id` | ```String``` | _t__Account::TEAM_ID | | +| `locale` | ```String``` | _t__Account::LOCALE | | | `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | | diff --git a/sdks/ruby/docs/AccountResponseQuotas.md b/sdks/ruby/docs/AccountResponseQuotas.md index 2b96ba96b..404dc57d6 100644 --- a/sdks/ruby/docs/AccountResponseQuotas.md +++ b/sdks/ruby/docs/AccountResponseQuotas.md @@ -1,15 +1,15 @@ # Dropbox::Sign::AccountResponseQuotas -Details concerning remaining monthly quotas. +_t__Account::QUOTA ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | | -| `documents_left` | ```Integer``` | Signature requests remaining. | | -| `templates_total` | ```Integer``` | Total API templates allowed. | | -| `templates_left` | ```Integer``` | API templates remaining. | | -| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | | -| `num_fax_pages_left` | ```Integer``` | Number of fax pages left | | +| `api_signature_requests_left` | ```Integer``` | _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documents_left` | ```Integer``` | _t__AccountQuota::DOCUMENTS_LEFT | | +| `templates_total` | ```Integer``` | _t__AccountQuota::TEMPLATES_TOTAL | | +| `templates_left` | ```Integer``` | _t__AccountQuota::TEMPLATES_LEFT | | +| `sms_verifications_left` | ```Integer``` | _t__AccountQuota::SMS_VERIFICATIONS_LEFT | | +| `num_fax_pages_left` | ```Integer``` | _t__AccountQuota::NUM_FAX_PAGES_LEFT | | diff --git a/sdks/ruby/docs/AccountResponseUsage.md b/sdks/ruby/docs/AccountResponseUsage.md index 6dc2ddc21..cbea80695 100644 --- a/sdks/ruby/docs/AccountResponseUsage.md +++ b/sdks/ruby/docs/AccountResponseUsage.md @@ -1,10 +1,10 @@ # Dropbox::Sign::AccountResponseUsage -Details concerning monthly usage +_t__Account::USAGE ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `fax_pages_sent` | ```Integer``` | Number of fax pages sent | | +| `fax_pages_sent` | ```Integer``` | _t__AccountUsage::FAX_PAGES_SENT | | diff --git a/sdks/ruby/docs/AccountVerifyResponse.md b/sdks/ruby/docs/AccountVerifyResponse.md index a27dd8926..bb435c870 100644 --- a/sdks/ruby/docs/AccountVerifyResponse.md +++ b/sdks/ruby/docs/AccountVerifyResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account` | [```AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/AccountVerifyResponseAccount.md b/sdks/ruby/docs/AccountVerifyResponseAccount.md index 77023c06c..6b59c5703 100644 --- a/sdks/ruby/docs/AccountVerifyResponseAccount.md +++ b/sdks/ruby/docs/AccountVerifyResponseAccount.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `email_address` | ```String``` | The email address associated with the Account. | | +| `email_address` | ```String``` | _t__Account::EMAIL_ADDRESS | | diff --git a/sdks/ruby/docs/ApiAppGetResponse.md b/sdks/ruby/docs/ApiAppGetResponse.md index 51a6a9c60..90aa74b0e 100644 --- a/sdks/ruby/docs/ApiAppGetResponse.md +++ b/sdks/ruby/docs/ApiAppGetResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `api_app`*_required_ | [```ApiAppResponse```](ApiAppResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/ApiAppListResponse.md b/sdks/ruby/docs/ApiAppListResponse.md index fe9d1f067..54e21a20d 100644 --- a/sdks/ruby/docs/ApiAppListResponse.md +++ b/sdks/ruby/docs/ApiAppListResponse.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `api_apps`*_required_ | [```Array```](ApiAppResponse.md) | Contains information about API Apps. | | +| `api_apps`*_required_ | [```Array```](ApiAppResponse.md) | _t__ApiAppListResponse::DESCRIPTION | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/ApiAppResponse.md b/sdks/ruby/docs/ApiAppResponse.md index ff1067f07..ee7c70bc8 100644 --- a/sdks/ruby/docs/ApiAppResponse.md +++ b/sdks/ruby/docs/ApiAppResponse.md @@ -1,17 +1,17 @@ # Dropbox::Sign::ApiAppResponse -Contains information about an API App. +_t__ApiAppResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `callback_url` | ```String``` | The app's callback URL (for events) | | -| `client_id` | ```String``` | The app's client id | | -| `created_at` | ```Integer``` | The time that the app was created | | -| `domains` | ```Array``` | The domain name(s) associated with the app | | -| `name` | ```String``` | The name of the app | | -| `is_approved` | ```Boolean``` | Boolean to indicate if the app has been approved | | +| `callback_url` | ```String``` | _t__ApiAppResponse::CALLBACK_URL | | +| `client_id` | ```String``` | _t__ApiAppResponse::CLIENT_ID | | +| `created_at` | ```Integer``` | _t__ApiAppResponse::CREATED_AT | | +| `domains` | ```Array``` | _t__ApiAppResponse::DOMAINS | | +| `name` | ```String``` | _t__ApiAppResponse::NAME | | +| `is_approved` | ```Boolean``` | _t__ApiAppResponse::IS_APPROVED | | | `oauth` | [```ApiAppResponseOAuth```](ApiAppResponseOAuth.md) | | | | `options` | [```ApiAppResponseOptions```](ApiAppResponseOptions.md) | | | | `owner_account` | [```ApiAppResponseOwnerAccount```](ApiAppResponseOwnerAccount.md) | | | diff --git a/sdks/ruby/docs/ApiAppResponseOAuth.md b/sdks/ruby/docs/ApiAppResponseOAuth.md index b39bcc302..b676171e5 100644 --- a/sdks/ruby/docs/ApiAppResponseOAuth.md +++ b/sdks/ruby/docs/ApiAppResponseOAuth.md @@ -1,13 +1,13 @@ # Dropbox::Sign::ApiAppResponseOAuth -An object describing the app's OAuth properties, or null if OAuth is not configured for the app. +_t__ApiAppResponseOAuth::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `callback_url` | ```String``` | The app's OAuth callback URL. | | -| `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | | -| `scopes` | ```Array``` | Array of OAuth scopes used by the app. | | -| `charges_users` | ```Boolean``` | Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. | | +| `callback_url` | ```String``` | _t__ApiAppResponseOAuth::CALLBACK_URL | | +| `secret` | ```String``` | _t__ApiAppResponseOAuth::SECRET | | +| `scopes` | ```Array``` | _t__ApiAppResponseOAuth::SCOPES | | +| `charges_users` | ```Boolean``` | _t__ApiAppResponseOAuth::CHARGES_USERS | | diff --git a/sdks/ruby/docs/ApiAppResponseOptions.md b/sdks/ruby/docs/ApiAppResponseOptions.md index 6661e960f..60775ebb7 100644 --- a/sdks/ruby/docs/ApiAppResponseOptions.md +++ b/sdks/ruby/docs/ApiAppResponseOptions.md @@ -1,10 +1,10 @@ # Dropbox::Sign::ApiAppResponseOptions -An object with options that override account settings. +_t__ApiAppResponseOptions::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `can_insert_everywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | | +| `can_insert_everywhere` | ```Boolean``` | _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE | | diff --git a/sdks/ruby/docs/ApiAppResponseOwnerAccount.md b/sdks/ruby/docs/ApiAppResponseOwnerAccount.md index 6ae8b315d..55653cdfc 100644 --- a/sdks/ruby/docs/ApiAppResponseOwnerAccount.md +++ b/sdks/ruby/docs/ApiAppResponseOwnerAccount.md @@ -1,11 +1,11 @@ # Dropbox::Sign::ApiAppResponseOwnerAccount -An object describing the app's owner +_t__ApiAppResponseOwnerAccount::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `account_id` | ```String``` | The owner account's ID | | -| `email_address` | ```String``` | The owner account's email address | | +| `account_id` | ```String``` | _t__ApiAppResponseOwnerAccount::ACCOUNT_ID | | +| `email_address` | ```String``` | _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS | | diff --git a/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md b/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md index 3b02d6762..fb575f5db 100644 --- a/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md +++ b/sdks/ruby/docs/ApiAppResponseWhiteLabelingOptions.md @@ -1,6 +1,6 @@ # Dropbox::Sign::ApiAppResponseWhiteLabelingOptions -An object with options to customize the app's signer page +_t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION ## Properties diff --git a/sdks/ruby/docs/BulkSendJobGetResponse.md b/sdks/ruby/docs/BulkSendJobGetResponse.md index b110bcc5d..36efb77b1 100644 --- a/sdks/ruby/docs/BulkSendJobGetResponse.md +++ b/sdks/ruby/docs/BulkSendJobGetResponse.md @@ -8,6 +8,6 @@ | ---- | ---- | ----------- | ----- | | `bulk_send_job`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `signature_requests`*_required_ | [```Array```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `signature_requests`*_required_ | [```Array```](BulkSendJobGetResponseSignatureRequests.md) | _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/ruby/docs/BulkSendJobGetResponseSignatureRequests.md index 8491cfeeb..575458e06 100644 --- a/sdks/ruby/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/ruby/docs/BulkSendJobGetResponseSignatureRequests.md @@ -6,29 +6,29 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `test_mode` | ```Boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | -| `signature_request_id` | ```String``` | The id of the SignatureRequest. | | -| `requester_email_address` | ```String``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```String``` | The title the specified Account uses for the SignatureRequest. | | -| `original_title` | ```String``` | Default Label for account. | | -| `subject` | ```String``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```String``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```Hash``` | The metadata attached to the signature request. | | -| `created_at` | ```Integer``` | Time the signature request was created. | | -| `expires_at` | ```Integer``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `is_complete` | ```Boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `is_declined` | ```Boolean``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `has_error` | ```Boolean``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `files_url` | ```String``` | The URL where a copy of the request's documents can be downloaded. | | -| `signing_url` | ```String``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `details_url` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `cc_email_addresses` | ```Array``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signing_redirect_url` | ```String``` | The URL you want the signer redirected to after they successfully sign. | | -| `final_copy_uri` | ```String``` | The path where the completed document can be downloaded | | -| `template_ids` | ```Array``` | Templates IDs used in this SignatureRequest (if any). | | -| `custom_fields` | [```Array```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `response_data` | [```Array```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulk_send_job_id` | ```String``` | The id of the BulkSendJob. | | +| `test_mode` | ```Boolean``` | _t__SignatureRequestResponse::TEST_MODE | [default to false] | +| `signature_request_id` | ```String``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requester_email_address` | ```String``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```String``` | _t__SignatureRequestResponse::TITLE | | +| `original_title` | ```String``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```String``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```String``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```Hash``` | _t__SignatureRequestResponse::METADATA | | +| `created_at` | ```Integer``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expires_at` | ```Integer``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `is_complete` | ```Boolean``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `is_declined` | ```Boolean``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `has_error` | ```Boolean``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `files_url` | ```String``` | _t__SignatureRequestResponse::FILES_URL | | +| `signing_url` | ```String``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `details_url` | ```String``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `cc_email_addresses` | ```Array``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signing_redirect_url` | ```String``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `final_copy_uri` | ```String``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `template_ids` | ```Array``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `custom_fields` | [```Array```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `response_data` | [```Array```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulk_send_job_id` | ```String``` | _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID | | diff --git a/sdks/ruby/docs/BulkSendJobListResponse.md b/sdks/ruby/docs/BulkSendJobListResponse.md index deae21323..ca198d40c 100644 --- a/sdks/ruby/docs/BulkSendJobListResponse.md +++ b/sdks/ruby/docs/BulkSendJobListResponse.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `bulk_send_jobs`*_required_ | [```Array```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | | +| `bulk_send_jobs`*_required_ | [```Array```](BulkSendJobResponse.md) | _t__BulkSendJobListResponse::BULK_SEND_JOBS | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/BulkSendJobResponse.md b/sdks/ruby/docs/BulkSendJobResponse.md index 30b30234d..9f3ff0477 100644 --- a/sdks/ruby/docs/BulkSendJobResponse.md +++ b/sdks/ruby/docs/BulkSendJobResponse.md @@ -1,13 +1,13 @@ # Dropbox::Sign::BulkSendJobResponse -Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. +_t__BulkSendJobResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `bulk_send_job_id` | ```String``` | The id of the BulkSendJob. | | -| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | | -| `is_creator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | | -| `created_at` | ```Integer``` | Time that the BulkSendJob was created. | | +| `bulk_send_job_id` | ```String``` | _t__BulkSendJobResponse::BULK_SEND_JOB_ID | | +| `total` | ```Integer``` | _t__BulkSendJobResponse::TOTAL | | +| `is_creator` | ```Boolean``` | _t__BulkSendJobResponse::IS_CREATOR | | +| `created_at` | ```Integer``` | _t__BulkSendJobResponse::CREATED_AT | | diff --git a/sdks/ruby/docs/BulkSendJobSendResponse.md b/sdks/ruby/docs/BulkSendJobSendResponse.md index a352d838c..b0bb9adcd 100644 --- a/sdks/ruby/docs/BulkSendJobSendResponse.md +++ b/sdks/ruby/docs/BulkSendJobSendResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `bulk_send_job`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/EmbeddedEditUrlRequest.md b/sdks/ruby/docs/EmbeddedEditUrlRequest.md index a65ef4092..6395cb460 100644 --- a/sdks/ruby/docs/EmbeddedEditUrlRequest.md +++ b/sdks/ruby/docs/EmbeddedEditUrlRequest.md @@ -7,6 +7,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `allow_edit_ccs` | ```Boolean``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to false] | +| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `cc_roles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `force_signer_roles` | ```Boolean``` | Provide users the ability to review/edit the template signer roles. | [default to false] | diff --git a/sdks/ruby/docs/EmbeddedEditUrlResponse.md b/sdks/ruby/docs/EmbeddedEditUrlResponse.md index 00e1f28c3..c873c9504 100644 --- a/sdks/ruby/docs/EmbeddedEditUrlResponse.md +++ b/sdks/ruby/docs/EmbeddedEditUrlResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `embedded`*_required_ | [```EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/EmbeddedEditUrlResponseEmbedded.md b/sdks/ruby/docs/EmbeddedEditUrlResponseEmbedded.md index 3bd97d710..4471381fd 100644 --- a/sdks/ruby/docs/EmbeddedEditUrlResponseEmbedded.md +++ b/sdks/ruby/docs/EmbeddedEditUrlResponseEmbedded.md @@ -1,11 +1,11 @@ # Dropbox::Sign::EmbeddedEditUrlResponseEmbedded -An embedded template object. +_t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `edit_url` | ```String``` | A template url that can be opened in an iFrame. | | -| `expires_at` | ```Integer``` | The specific time that the the `edit_url` link expires, in epoch. | | +| `edit_url` | ```String``` | _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL | | +| `expires_at` | ```Integer``` | _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT | | diff --git a/sdks/ruby/docs/EmbeddedSignUrlResponse.md b/sdks/ruby/docs/EmbeddedSignUrlResponse.md index fcd693876..16aa4fc60 100644 --- a/sdks/ruby/docs/EmbeddedSignUrlResponse.md +++ b/sdks/ruby/docs/EmbeddedSignUrlResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `embedded`*_required_ | [```EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/EmbeddedSignUrlResponseEmbedded.md b/sdks/ruby/docs/EmbeddedSignUrlResponseEmbedded.md index b78b74a8a..7d0730a73 100644 --- a/sdks/ruby/docs/EmbeddedSignUrlResponseEmbedded.md +++ b/sdks/ruby/docs/EmbeddedSignUrlResponseEmbedded.md @@ -1,11 +1,11 @@ # Dropbox::Sign::EmbeddedSignUrlResponseEmbedded -An object that contains necessary information to set up embedded signing. +_t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `sign_url` | ```String``` | A signature url that can be opened in an iFrame. | | -| `expires_at` | ```Integer``` | The specific time that the the `sign_url` link expires, in epoch. | | +| `sign_url` | ```String``` | _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL | | +| `expires_at` | ```Integer``` | _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT | | diff --git a/sdks/ruby/docs/ErrorResponseError.md b/sdks/ruby/docs/ErrorResponseError.md index e18e4037e..bf12a7e33 100644 --- a/sdks/ruby/docs/ErrorResponseError.md +++ b/sdks/ruby/docs/ErrorResponseError.md @@ -1,12 +1,12 @@ # Dropbox::Sign::ErrorResponseError -Contains information about an error that occurred. +_t__ErrorResponseError::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `error_msg`*_required_ | ```String``` | Message describing an error. | | -| `error_name`*_required_ | ```String``` | Name of the error. | | -| `error_path` | ```String``` | Path at which an error occurred. | | +| `error_msg`*_required_ | ```String``` | _t__ErrorResponseError::ERROR_MSG | | +| `error_name`*_required_ | ```String``` | _t__ErrorResponseError::ERROR_NAME | | +| `error_path` | ```String``` | _t__ErrorResponseError::ERROR_PATH | | diff --git a/sdks/ruby/docs/EventCallbackRequestEvent.md b/sdks/ruby/docs/EventCallbackRequestEvent.md index 3bcfb7b0c..ef2f85878 100644 --- a/sdks/ruby/docs/EventCallbackRequestEvent.md +++ b/sdks/ruby/docs/EventCallbackRequestEvent.md @@ -1,13 +1,13 @@ # Dropbox::Sign::EventCallbackRequestEvent -Basic information about the event that occurred. +_t__EventCallbackRequestEvent::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `event_time`*_required_ | ```String``` | Time the event was created (using Unix time). | | -| `event_type`*_required_ | ```String``` | Type of callback event that was triggered. | | -| `event_hash`*_required_ | ```String``` | Generated hash used to verify source of event data. | | +| `event_time`*_required_ | ```String``` | _t__EventCallbackRequestEvent::EVENT_TIME | | +| `event_type`*_required_ | ```String``` | _t__EventCallbackRequestEvent::EVENT_TYPE | | +| `event_hash`*_required_ | ```String``` | _t__EventCallbackRequestEvent::EVENT_HASH | | | `event_metadata` | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | | diff --git a/sdks/ruby/docs/EventCallbackRequestEventMetadata.md b/sdks/ruby/docs/EventCallbackRequestEventMetadata.md index 7817d24ce..c8c7fceb1 100644 --- a/sdks/ruby/docs/EventCallbackRequestEventMetadata.md +++ b/sdks/ruby/docs/EventCallbackRequestEventMetadata.md @@ -1,13 +1,13 @@ # Dropbox::Sign::EventCallbackRequestEventMetadata -Specific metadata about the event. +_t__EventCallbackRequestEventMetadata::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `related_signature_id` | ```String``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | | -| `reported_for_account_id` | ```String``` | Account ID the event was reported for. | | -| `reported_for_app_id` | ```String``` | App ID the event was reported for. | | -| `event_message` | ```String``` | Message about a declined or failed (due to error) signature flow. | | +| `related_signature_id` | ```String``` | _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID | | +| `reported_for_account_id` | ```String``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID | | +| `reported_for_app_id` | ```String``` | _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID | | +| `event_message` | ```String``` | _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE | | diff --git a/sdks/ruby/docs/FaxGetResponse.md b/sdks/ruby/docs/FaxGetResponse.md index 397322654..f8a66d41d 100644 --- a/sdks/ruby/docs/FaxGetResponse.md +++ b/sdks/ruby/docs/FaxGetResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `fax`*_required_ | [```FaxResponse```](FaxResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/FileResponse.md b/sdks/ruby/docs/FileResponse.md index 0716b74a6..241a30665 100644 --- a/sdks/ruby/docs/FileResponse.md +++ b/sdks/ruby/docs/FileResponse.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `file_url`*_required_ | ```String``` | URL to the file. | | -| `expires_at`*_required_ | ```Integer``` | When the link expires. | | +| `file_url`*_required_ | ```String``` | _t__FileResponse::FILE_URL | | +| `expires_at`*_required_ | ```Integer``` | _t__FileResponse::EXPIRES_AT | | diff --git a/sdks/ruby/docs/FileResponseDataUri.md b/sdks/ruby/docs/FileResponseDataUri.md index 57ebb1e79..4600f0f2d 100644 --- a/sdks/ruby/docs/FileResponseDataUri.md +++ b/sdks/ruby/docs/FileResponseDataUri.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `data_uri`*_required_ | ```String``` | File as base64 encoded string. | | +| `data_uri`*_required_ | ```String``` | _t__FileResponse::DATA_URI | | diff --git a/sdks/ruby/docs/ListInfoResponse.md b/sdks/ruby/docs/ListInfoResponse.md index 99dd2ba7b..8dbf984c4 100644 --- a/sdks/ruby/docs/ListInfoResponse.md +++ b/sdks/ruby/docs/ListInfoResponse.md @@ -1,13 +1,13 @@ # Dropbox::Sign::ListInfoResponse -Contains pagination information about the data returned. +_t__ListInfoResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `num_pages` | ```Integer``` | Total number of pages available. | | -| `num_results` | ```Integer``` | Total number of objects available. | | -| `page` | ```Integer``` | Number of the page being returned. | | -| `page_size` | ```Integer``` | Objects returned per page. | | +| `num_pages` | ```Integer``` | _t__ListInfoResponse::NUM_PAGES | | +| `num_results` | ```Integer``` | _t__ListInfoResponse::NUM_RESULTS | | +| `page` | ```Integer``` | _t__ListInfoResponse::PAGE | | +| `page_size` | ```Integer``` | _t__ListInfoResponse::PAGE_SIZE | | diff --git a/sdks/ruby/docs/OAuthTokenResponse.md b/sdks/ruby/docs/OAuthTokenResponse.md index 8baf51323..aebd5524e 100644 --- a/sdks/ruby/docs/OAuthTokenResponse.md +++ b/sdks/ruby/docs/OAuthTokenResponse.md @@ -9,6 +9,6 @@ | `access_token` | ```String``` | | | | `token_type` | ```String``` | | | | `refresh_token` | ```String``` | | | -| `expires_in` | ```Integer``` | Number of seconds until the `access_token` expires. Uses epoch time. | | +| `expires_in` | ```Integer``` | _t__OAuthTokenResponse::EXPIRES_IN | | | `state` | ```String``` | | | diff --git a/sdks/ruby/docs/ReportCreateResponse.md b/sdks/ruby/docs/ReportCreateResponse.md index 970ef627f..49d9cc19e 100644 --- a/sdks/ruby/docs/ReportCreateResponse.md +++ b/sdks/ruby/docs/ReportCreateResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `report`*_required_ | [```ReportResponse```](ReportResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/ReportResponse.md b/sdks/ruby/docs/ReportResponse.md index 61b1bc43a..6a0029866 100644 --- a/sdks/ruby/docs/ReportResponse.md +++ b/sdks/ruby/docs/ReportResponse.md @@ -1,13 +1,13 @@ # Dropbox::Sign::ReportResponse -Contains information about the report request. +_t__ReportResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `success` | ```String``` | A message indicating the requested operation's success | | -| `start_date` | ```String``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | | -| `end_date` | ```String``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | | -| `report_type` | ```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). | | +| `success` | ```String``` | _t__ReportResponse::SUCCESS | | +| `start_date` | ```String``` | _t__ReportResponse::START_DATE | | +| `end_date` | ```String``` | _t__ReportResponse::END_DATE | | +| `report_type` | ```Array``` | _t__ReportResponse::REPORT_TYPE | | diff --git a/sdks/ruby/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index ac2c30e32..69275295f 100644 --- a/sdks/ruby/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -14,7 +14,7 @@ | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/SignatureRequestBulkSendWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestBulkSendWithTemplateRequest.md index b3afc36b9..86a487d4c 100644 --- a/sdks/ruby/docs/SignatureRequestBulkSendWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestBulkSendWithTemplateRequest.md @@ -14,7 +14,7 @@ | `client_id` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md index 72ba0eed1..850555843 100644 --- a/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md @@ -9,11 +9,12 @@ | `client_id`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | | `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -22,7 +23,7 @@ | `form_fields_per_document` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index a345e97b1..7bd7f0ee1 100644 --- a/sdks/ruby/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -8,14 +8,14 @@ | ---- | ---- | ----------- | ----- | | `template_ids`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `client_id`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `custom_fields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md index 383cd8e89..0777b9fa6 100644 --- a/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md @@ -9,11 +9,12 @@ | `client_id`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | | `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -22,7 +23,7 @@ | `form_fields_per_document` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index 736cbf786..64b44e0a0 100644 --- a/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -8,14 +8,14 @@ | ---- | ---- | ----------- | ----- | | `template_ids`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | | `client_id`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | -| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `custom_fields` | [```Array```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/SignatureRequestEditRequest.md b/sdks/ruby/docs/SignatureRequestEditRequest.md index 39d575aa3..949bd6b87 100644 --- a/sdks/ruby/docs/SignatureRequestEditRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditRequest.md @@ -8,11 +8,12 @@ | ---- | ---- | ----------- | ----- | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | | `client_id` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -23,7 +24,7 @@ | `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] | | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md index 12b4bee82..9a6d03cfd 100644 --- a/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md @@ -7,7 +7,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_ids`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `client_id` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -16,7 +16,7 @@ | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/ruby/docs/SignatureRequestGetResponse.md b/sdks/ruby/docs/SignatureRequestGetResponse.md index 8afab07d9..679d13afc 100644 --- a/sdks/ruby/docs/SignatureRequestGetResponse.md +++ b/sdks/ruby/docs/SignatureRequestGetResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `signature_request`*_required_ | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/SignatureRequestListResponse.md b/sdks/ruby/docs/SignatureRequestListResponse.md index 24dc69fbd..65db5470c 100644 --- a/sdks/ruby/docs/SignatureRequestListResponse.md +++ b/sdks/ruby/docs/SignatureRequestListResponse.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `signature_requests`*_required_ | [```Array```](SignatureRequestResponse.md) | Contains information about signature requests. | | +| `signature_requests`*_required_ | [```Array```](SignatureRequestResponse.md) | _t__SignatureRequestListResponse::DESCRIPTION | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/SignatureRequestResponse.md b/sdks/ruby/docs/SignatureRequestResponse.md index f3655a0a2..95a652529 100644 --- a/sdks/ruby/docs/SignatureRequestResponse.md +++ b/sdks/ruby/docs/SignatureRequestResponse.md @@ -1,34 +1,34 @@ # Dropbox::Sign::SignatureRequestResponse -Contains information about a signature request. +_t__SignatureRequestResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `test_mode` | ```Boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [default to false] | -| `signature_request_id` | ```String``` | The id of the SignatureRequest. | | -| `requester_email_address` | ```String``` | The email address of the initiator of the SignatureRequest. | | -| `title` | ```String``` | The title the specified Account uses for the SignatureRequest. | | -| `original_title` | ```String``` | Default Label for account. | | -| `subject` | ```String``` | The subject in the email that was initially sent to the signers. | | -| `message` | ```String``` | The custom message in the email that was initially sent to the signers. | | -| `metadata` | ```Hash``` | The metadata attached to the signature request. | | -| `created_at` | ```Integer``` | Time the signature request was created. | | -| `expires_at` | ```Integer``` | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | -| `is_complete` | ```Boolean``` | Whether or not the SignatureRequest has been fully executed by all signers. | | -| `is_declined` | ```Boolean``` | Whether or not the SignatureRequest has been declined by a signer. | | -| `has_error` | ```Boolean``` | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | | -| `files_url` | ```String``` | The URL where a copy of the request's documents can be downloaded. | | -| `signing_url` | ```String``` | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | | -| `details_url` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | | -| `cc_email_addresses` | ```Array``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | | -| `signing_redirect_url` | ```String``` | The URL you want the signer redirected to after they successfully sign. | | -| `final_copy_uri` | ```String``` | The path where the completed document can be downloaded | | -| `template_ids` | ```Array``` | Templates IDs used in this SignatureRequest (if any). | | -| `custom_fields` | [```Array```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | | -| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `response_data` | [```Array```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | -| `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | -| `bulk_send_job_id` | ```String``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `test_mode` | ```Boolean``` | _t__SignatureRequestResponse::TEST_MODE | [default to false] | +| `signature_request_id` | ```String``` | _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID | | +| `requester_email_address` | ```String``` | _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS | | +| `title` | ```String``` | _t__SignatureRequestResponse::TITLE | | +| `original_title` | ```String``` | _t__SignatureRequestResponse::ORIGINAL_TITLE | | +| `subject` | ```String``` | _t__SignatureRequestResponse::SUBJECT | | +| `message` | ```String``` | _t__SignatureRequestResponse::MESSAGE | | +| `metadata` | ```Hash``` | _t__SignatureRequestResponse::METADATA | | +| `created_at` | ```Integer``` | _t__SignatureRequestResponse::CREATED_AT | | +| `expires_at` | ```Integer``` | _t__SignatureRequestResponse::EXPIRES_AT | | +| `is_complete` | ```Boolean``` | _t__SignatureRequestResponse::IS_COMPLETE | | +| `is_declined` | ```Boolean``` | _t__SignatureRequestResponse::IS_DECLINED | | +| `has_error` | ```Boolean``` | _t__SignatureRequestResponse::HAS_ERROR | | +| `files_url` | ```String``` | _t__SignatureRequestResponse::FILES_URL | | +| `signing_url` | ```String``` | _t__SignatureRequestResponse::SIGNING_URL | | +| `details_url` | ```String``` | _t__SignatureRequestResponse::DETAILS_URL | | +| `cc_email_addresses` | ```Array``` | _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES | | +| `signing_redirect_url` | ```String``` | _t__SignatureRequestResponse::SIGNING_REDIRECT_URL | | +| `final_copy_uri` | ```String``` | _t__SignatureRequestResponse::FINAL_COPY_URI | | +| `template_ids` | ```Array``` | _t__SignatureRequestResponse::TEMPLATE_IDS | | +| `custom_fields` | [```Array```](SignatureRequestResponseCustomFieldBase.md) | _t__SignatureRequestResponseCustomField::DESCRIPTION | | +| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | +| `response_data` | [```Array```](SignatureRequestResponseDataBase.md) | _t__SignatureRequestResponseData::DESCRIPTION | | +| `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | _t__SignatureRequestResponseSignatures::DESCRIPTION | | +| `bulk_send_job_id` | ```String``` | _t__SignatureRequestResponse::BULK_SEND_JOB_ID | | diff --git a/sdks/ruby/docs/SignatureRequestResponseAttachment.md b/sdks/ruby/docs/SignatureRequestResponseAttachment.md index c965dfcd0..9d126431e 100644 --- a/sdks/ruby/docs/SignatureRequestResponseAttachment.md +++ b/sdks/ruby/docs/SignatureRequestResponseAttachment.md @@ -1,15 +1,15 @@ # Dropbox::Sign::SignatureRequestResponseAttachment -Signer attachments. +_t__SignatureRequestResponseAttachment::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `id`*_required_ | ```String``` | The unique ID for this attachment. | | -| `signer`*_required_ | ```String``` | The Signer this attachment is assigned to. | | -| `name`*_required_ | ```String``` | The name of this attachment. | | -| `required`*_required_ | ```Boolean``` | A boolean value denoting if this attachment is required. | | -| `instructions` | ```String``` | Instructions for Signer. | | -| `uploaded_at` | ```Integer``` | Timestamp when attachment was uploaded by Signer. | | +| `id`*_required_ | ```String``` | _t__SignatureRequestResponseAttachment::ID | | +| `signer`*_required_ | ```String``` | _t__SignatureRequestResponseAttachment::SIGNER | | +| `name`*_required_ | ```String``` | _t__SignatureRequestResponseAttachment::NAME | | +| `required`*_required_ | ```Boolean``` | _t__SignatureRequestResponseAttachment::REQUIRED | | +| `instructions` | ```String``` | _t__SignatureRequestResponseAttachment::INSTRUCTIONS | | +| `uploaded_at` | ```Integer``` | _t__SignatureRequestResponseAttachment::UPLOADED_AT | | diff --git a/sdks/ruby/docs/SignatureRequestResponseCustomFieldBase.md b/sdks/ruby/docs/SignatureRequestResponseCustomFieldBase.md index 423098809..b03efe088 100644 --- a/sdks/ruby/docs/SignatureRequestResponseCustomFieldBase.md +++ b/sdks/ruby/docs/SignatureRequestResponseCustomFieldBase.md @@ -1,17 +1,14 @@ # Dropbox::Sign::SignatureRequestResponseCustomFieldBase -An array of Custom Field objects containing the name and type of each custom field. - -* Text Field uses `SignatureRequestResponseCustomFieldText` -* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` +_t__SignatureRequestResponseCustomField::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | | -| `name`*_required_ | ```String``` | The name of the Custom Field. | | -| `required` | ```Boolean``` | A boolean value denoting if this field is required. | | -| `api_id` | ```String``` | The unique ID for this field. | | -| `editor` | ```String``` | The name of the Role that is able to edit this field. | | +| `type`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::TYPE | | +| `name`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::NAME | | +| `required` | ```Boolean``` | _t__SignatureRequestResponseCustomField::REQUIRED | | +| `api_id` | ```String``` | _t__SignatureRequestResponseCustomField::API_ID | | +| `editor` | ```String``` | _t__SignatureRequestResponseCustomField::EDITOR | | diff --git a/sdks/ruby/docs/SignatureRequestResponseCustomFieldCheckbox.md b/sdks/ruby/docs/SignatureRequestResponseCustomFieldCheckbox.md index c207439ba..451492d74 100644 --- a/sdks/ruby/docs/SignatureRequestResponseCustomFieldCheckbox.md +++ b/sdks/ruby/docs/SignatureRequestResponseCustomFieldCheckbox.md @@ -1,11 +1,11 @@ # Dropbox::Sign::SignatureRequestResponseCustomFieldCheckbox -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'checkbox'] | -| `value` | ```Boolean``` | A true/false for checkbox fields | | +| `type`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::TYPE | [default to 'checkbox'] | +| `value` | ```Boolean``` | _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX | | diff --git a/sdks/ruby/docs/SignatureRequestResponseCustomFieldText.md b/sdks/ruby/docs/SignatureRequestResponseCustomFieldText.md index d385c869f..0016bd741 100644 --- a/sdks/ruby/docs/SignatureRequestResponseCustomFieldText.md +++ b/sdks/ruby/docs/SignatureRequestResponseCustomFieldText.md @@ -1,11 +1,11 @@ # Dropbox::Sign::SignatureRequestResponseCustomFieldText -This class extends `SignatureRequestResponseCustomFieldBase`. +_t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | [default to 'text'] | -| `value` | ```String``` | A text string for text fields | | +| `type`*_required_ | ```String``` | _t__SignatureRequestResponseCustomField::TYPE | [default to 'text'] | +| `value` | ```String``` | _t__SignatureRequestResponseCustomField::VALUE_TEXT | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataBase.md b/sdks/ruby/docs/SignatureRequestResponseDataBase.md index 19715a4e8..1ff24ab0e 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataBase.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataBase.md @@ -1,14 +1,14 @@ # Dropbox::Sign::SignatureRequestResponseDataBase -An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. +_t__SignatureRequestResponseData::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `api_id` | ```String``` | The unique ID for this field. | | -| `signature_id` | ```String``` | The ID of the signature to which this response is linked. | | -| `name` | ```String``` | The name of the form field. | | -| `required` | ```Boolean``` | A boolean value denoting if this field is required. | | +| `api_id` | ```String``` | _t__SignatureRequestResponseData::API_ID | | +| `signature_id` | ```String``` | _t__SignatureRequestResponseData::SIGNATURE_ID | | +| `name` | ```String``` | _t__SignatureRequestResponseData::NAME | | +| `required` | ```Boolean``` | _t__SignatureRequestResponseData::REQUIRED | | | `type` | ```String``` | | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataValueCheckbox.md b/sdks/ruby/docs/SignatureRequestResponseDataValueCheckbox.md index 0c5176d66..aa462f65c 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataValueCheckbox.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataValueCheckbox.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type` | ```String``` | A yes/no checkbox | [default to 'checkbox'] | -| `value` | ```Boolean``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE | [default to 'checkbox'] | +| `value` | ```Boolean``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataValueCheckboxMerge.md b/sdks/ruby/docs/SignatureRequestResponseDataValueCheckboxMerge.md index ea575da05..67ad02acd 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataValueCheckboxMerge.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataValueCheckboxMerge.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type` | ```String``` | A checkbox field that has default value set by the api | [default to 'checkbox-merge'] | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE | [default to 'checkbox-merge'] | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataValueDateSigned.md b/sdks/ruby/docs/SignatureRequestResponseDataValueDateSigned.md index 184688ccd..c35d9e9f8 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataValueDateSigned.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataValueDateSigned.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type` | ```String``` | A date | [default to 'date_signed'] | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE | [default to 'date_signed'] | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataValueDropdown.md b/sdks/ruby/docs/SignatureRequestResponseDataValueDropdown.md index fd39c857a..8c87eeb6d 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataValueDropdown.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataValueDropdown.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type` | ```String``` | An input field for dropdowns | [default to 'dropdown'] | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE | [default to 'dropdown'] | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataValueInitials.md b/sdks/ruby/docs/SignatureRequestResponseDataValueInitials.md index 348042eed..86346c3f4 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataValueInitials.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataValueInitials.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type` | ```String``` | An input field for initials | [default to 'initials'] | -| `value` | ```String``` | The value of the form field. | | -| `is_signed` | ```Boolean``` | This field contains the boolean true if the field is signed. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::INITIAL_TYPE | [default to 'initials'] | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `is_signed` | ```Boolean``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataValueRadio.md b/sdks/ruby/docs/SignatureRequestResponseDataValueRadio.md index f4592c9df..0878e50fe 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataValueRadio.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataValueRadio.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type` | ```String``` | An input field for radios | [default to 'radio'] | -| `value` | ```Boolean``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::RADIO_TYPE | [default to 'radio'] | +| `value` | ```Boolean``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataValueSignature.md b/sdks/ruby/docs/SignatureRequestResponseDataValueSignature.md index 78eb1d732..7f1dec2ae 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataValueSignature.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataValueSignature.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type` | ```String``` | A signature input field | [default to 'signature'] | -| `value` | ```String``` | The value of the form field. | | -| `is_signed` | ```Boolean``` | This field contains the boolean true if the field is signed. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE | [default to 'signature'] | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | +| `is_signed` | ```Boolean``` | _t__SignatureRequestResponseDataValue::IS_SIGNED | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataValueText.md b/sdks/ruby/docs/SignatureRequestResponseDataValueText.md index 6903fa8ef..08c3a98ea 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataValueText.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataValueText.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type` | ```String``` | A text input field | [default to 'text'] | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::TEXT_TYPE | [default to 'text'] | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/ruby/docs/SignatureRequestResponseDataValueTextMerge.md b/sdks/ruby/docs/SignatureRequestResponseDataValueTextMerge.md index b81b2814a..5f054c8da 100644 --- a/sdks/ruby/docs/SignatureRequestResponseDataValueTextMerge.md +++ b/sdks/ruby/docs/SignatureRequestResponseDataValueTextMerge.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type` | ```String``` | A text field that has default text set by the api | [default to 'text-merge'] | -| `value` | ```String``` | The value of the form field. | | +| `type` | ```String``` | _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE | [default to 'text-merge'] | +| `value` | ```String``` | _t__SignatureRequestResponseDataValue::VALUE | | diff --git a/sdks/ruby/docs/SignatureRequestResponseSignatures.md b/sdks/ruby/docs/SignatureRequestResponseSignatures.md index 7dfa8aa87..acbe75dd0 100644 --- a/sdks/ruby/docs/SignatureRequestResponseSignatures.md +++ b/sdks/ruby/docs/SignatureRequestResponseSignatures.md @@ -1,28 +1,28 @@ # Dropbox::Sign::SignatureRequestResponseSignatures -An array of signature objects, 1 for each signer. +_t__SignatureRequestResponseSignatures::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `signature_id` | ```String``` | Signature identifier. | | -| `signer_group_guid` | ```String``` | Signer Group GUID | | -| `signer_email_address` | ```String``` | The email address of the signer. | | -| `signer_name` | ```String``` | The name of the signer. | | -| `signer_role` | ```String``` | The role of the signer. | | -| `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this signer. | | -| `status_code` | ```String``` | The current status of the signature. eg: awaiting_signature, signed, declined. | | -| `decline_reason` | ```String``` | The reason provided by the signer for declining the request. | | -| `signed_at` | ```Integer``` | Time that the document was signed or null. | | -| `last_viewed_at` | ```Integer``` | The time that the document was last viewed by this signer or null. | | -| `last_reminded_at` | ```Integer``` | The time the last reminder email was sent to the signer or null. | | -| `has_pin` | ```Boolean``` | Boolean to indicate whether this signature requires a PIN to access. | | -| `has_sms_auth` | ```Boolean``` | Boolean to indicate whether this signature has SMS authentication enabled. | | -| `has_sms_delivery` | ```Boolean``` | Boolean to indicate whether this signature has SMS delivery enabled. | | -| `sms_phone_number` | ```String``` | The SMS phone number used for authentication or signature request delivery. | | -| `reassigned_by` | ```String``` | Email address of original signer who reassigned to this signer. | | -| `reassignment_reason` | ```String``` | Reason provided by original signer who reassigned to this signer. | | -| `reassigned_from` | ```String``` | Previous signature identifier. | | -| `error` | ```String``` | Error message pertaining to this signer, or null. | | +| `signature_id` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNATURE_ID | | +| `signer_group_guid` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID | | +| `signer_email_address` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS | | +| `signer_name` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_NAME | | +| `signer_role` | ```String``` | _t__SignatureRequestResponseSignatures::SIGNER_ROLE | | +| `order` | ```Integer``` | _t__SignatureRequestResponseSignatures::ORDER | | +| `status_code` | ```String``` | _t__SignatureRequestResponseSignatures::STATUS_CODE | | +| `decline_reason` | ```String``` | _t__SignatureRequestResponseSignatures::DECLINE_REASON | | +| `signed_at` | ```Integer``` | _t__SignatureRequestResponseSignatures::SIGNED_AT | | +| `last_viewed_at` | ```Integer``` | _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT | | +| `last_reminded_at` | ```Integer``` | _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT | | +| `has_pin` | ```Boolean``` | _t__SignatureRequestResponseSignatures::HAS_PIN | | +| `has_sms_auth` | ```Boolean``` | _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH | | +| `has_sms_delivery` | ```Boolean``` | _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY | | +| `sms_phone_number` | ```String``` | _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER | | +| `reassigned_by` | ```String``` | _t__SignatureRequestResponseSignatures::REASSIGNED_BY | | +| `reassignment_reason` | ```String``` | _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON | | +| `reassigned_from` | ```String``` | _t__SignatureRequestResponseSignatures::REASSIGNED_FROM | | +| `error` | ```String``` | _t__SignatureRequestResponseSignatures::ERROR | | diff --git a/sdks/ruby/docs/SignatureRequestSendRequest.md b/sdks/ruby/docs/SignatureRequestSendRequest.md index 683075e13..b9b0e0fc0 100644 --- a/sdks/ruby/docs/SignatureRequestSendRequest.md +++ b/sdks/ruby/docs/SignatureRequestSendRequest.md @@ -8,11 +8,12 @@ | ---- | ---- | ----------- | ----- | | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | -| `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | -| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `signers` | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestSigner::DESCRIPTION | | +| `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | | `client_id` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -24,7 +25,7 @@ | `is_qualified_signature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md index 94e17b8bf..134a99fc9 100644 --- a/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md @@ -7,7 +7,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_ids`*_required_ | ```Array``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | -| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers`*_required_ | [```Array```](SubSignatureRequestTemplateSigner.md) | _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `ccs` | [```Array```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | | `client_id` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | @@ -17,7 +17,7 @@ | `is_qualified_signature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/ruby/docs/SubFormFieldsPerDocumentBase.md b/sdks/ruby/docs/SubFormFieldsPerDocumentBase.md index 8abb6ed34..f11c32cbf 100644 --- a/sdks/ruby/docs/SubFormFieldsPerDocumentBase.md +++ b/sdks/ruby/docs/SubFormFieldsPerDocumentBase.md @@ -25,9 +25,9 @@ The fields that should appear on the document, expressed as an array of objects. | `required`*_required_ | ```Boolean``` | Whether this field is required. | | | `signer`*_required_ | ```String``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.

**NOTE:** To set the value of the field as the preparer you must set this to `me_now`

**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | | | `type`*_required_ | ```String``` | | | -| `width`*_required_ | ```Integer``` | Size of the field in pixels. | | -| `x`*_required_ | ```Integer``` | Location coordinates of the field in pixels. | | -| `y`*_required_ | ```Integer``` | Location coordinates of the field in pixels. | | +| `width`*_required_ | ```Integer``` | _t__Sub::FormFieldsPerDocument::WIDTH | | +| `x`*_required_ | ```Integer``` | _t__Sub::FormFieldsPerDocument::X | | +| `y`*_required_ | ```Integer``` | _t__Sub::FormFieldsPerDocument::Y | | | `name` | ```String``` | Display name for the field. | | | `page` | ```Integer``` | Page in the document where the field should be placed (requires documents be PDF files).

- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | | diff --git a/sdks/ruby/docs/SubFormFieldsPerDocumentText.md b/sdks/ruby/docs/SubFormFieldsPerDocumentText.md index 6bc69e10b..3b92adb76 100644 --- a/sdks/ruby/docs/SubFormFieldsPerDocumentText.md +++ b/sdks/ruby/docs/SubFormFieldsPerDocumentText.md @@ -11,7 +11,7 @@ This class extends `SubFormFieldsPerDocumentBase`. | `auto_fill_type` | ```String``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | | | `link_id` | ```String``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | | | `masked` | ```Boolean``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | | -| `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.

**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | | +| `validation_type` | ```String``` | _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE | | | `validation_custom_regex` | ```String``` | | | | `validation_custom_regex_format_label` | ```String``` | | | | `content` | ```String``` | Content of a `me_now` text field | | diff --git a/sdks/ruby/docs/SubFormFieldsPerDocumentTextMerge.md b/sdks/ruby/docs/SubFormFieldsPerDocumentTextMerge.md index 00e694b1d..4e3517fd7 100644 --- a/sdks/ruby/docs/SubFormFieldsPerDocumentTextMerge.md +++ b/sdks/ruby/docs/SubFormFieldsPerDocumentTextMerge.md @@ -6,7 +6,7 @@ This class extends `SubFormFieldsPerDocumentBase`. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] | +| `type`*_required_ | ```String``` | _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE | [default to 'text-merge'] | | `font_family` | ```String``` | Font family for the field. | | | `font_size` | ```Integer``` | 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] | diff --git a/sdks/ruby/docs/SubMergeField.md b/sdks/ruby/docs/SubMergeField.md index 19fdca3d5..51f4e8d0f 100644 --- a/sdks/ruby/docs/SubMergeField.md +++ b/sdks/ruby/docs/SubMergeField.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name`*_required_ | ```String``` | The name of the merge field. Must be unique. | | -| `type`*_required_ | ```String``` | The type of merge field. | | +| `name`*_required_ | ```String``` | _t__Sub::MergeField::NAME | | +| `type`*_required_ | ```String``` | _t__Sub::MergeField::TYPE | | diff --git a/sdks/ruby/docs/SubOAuth.md b/sdks/ruby/docs/SubOAuth.md index e6ed2b617..e218bb0ba 100644 --- a/sdks/ruby/docs/SubOAuth.md +++ b/sdks/ruby/docs/SubOAuth.md @@ -1,11 +1,11 @@ # Dropbox::Sign::SubOAuth -OAuth related parameters. +_t__Sub::OAuth::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `callback_url` | ```String``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | | -| `scopes` | ```Array``` | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | | +| `callback_url` | ```String``` | _t__Sub::OAuth::CALLBACK_URL | | +| `scopes` | ```Array``` | _t__Sub::OAuth::SCOPES | | diff --git a/sdks/ruby/docs/SubOptions.md b/sdks/ruby/docs/SubOptions.md index 3aee10a43..8ac55a7cb 100644 --- a/sdks/ruby/docs/SubOptions.md +++ b/sdks/ruby/docs/SubOptions.md @@ -1,10 +1,10 @@ # Dropbox::Sign::SubOptions -Additional options supported by API App. +_t__Sub::Options::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `can_insert_everywhere` | ```Boolean``` | Determines if signers can use "Insert Everywhere" when signing a document. | [default to false] | +| `can_insert_everywhere` | ```Boolean``` | _t__Sub::Options::CAN_INSERT_EVERYWHERE | [default to false] | diff --git a/sdks/ruby/docs/SubSignatureRequestGroupedSigners.md b/sdks/ruby/docs/SubSignatureRequestGroupedSigners.md index 7686dcdac..c7ba1bb2f 100644 --- a/sdks/ruby/docs/SubSignatureRequestGroupedSigners.md +++ b/sdks/ruby/docs/SubSignatureRequestGroupedSigners.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `group`*_required_ | ```String``` | The name of the group. | | -| `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. | | -| `order` | ```Integer``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | | +| `group`*_required_ | ```String``` | _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME | | +| `signers`*_required_ | [```Array```](SubSignatureRequestSigner.md) | _t__Sub::SignatureRequestGroupedSigners::SIGNERS | | +| `order` | ```Integer``` | _t__Sub::SignatureRequestGroupedSigners::ORDER | | diff --git a/sdks/ruby/docs/SubSignatureRequestSigner.md b/sdks/ruby/docs/SubSignatureRequestSigner.md index 6fe7e89f5..f4d4f10d4 100644 --- a/sdks/ruby/docs/SubSignatureRequestSigner.md +++ b/sdks/ruby/docs/SubSignatureRequestSigner.md @@ -6,10 +6,10 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name`*_required_ | ```String``` | The name of the signer. | | -| `email_address`*_required_ | ```String``` | The email address of the signer. | | -| `order` | ```Integer``` | The order the signer is required to sign in. | | -| `pin` | ```String``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `sms_phone_number` | ```String``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `sms_phone_number_type` | ```String``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `name`*_required_ | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_NAME | | +| `email_address`*_required_ | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS | | +| `order` | ```Integer``` | _t__Sub::SignatureRequestSigner::SIGNER_ORDER | | +| `pin` | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_PIN | | +| `sms_phone_number` | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER | | +| `sms_phone_number_type` | ```String``` | _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | diff --git a/sdks/ruby/docs/SubSignatureRequestTemplateSigner.md b/sdks/ruby/docs/SubSignatureRequestTemplateSigner.md index 1f624da7d..0ca8b0112 100644 --- a/sdks/ruby/docs/SubSignatureRequestTemplateSigner.md +++ b/sdks/ruby/docs/SubSignatureRequestTemplateSigner.md @@ -6,10 +6,10 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `role`*_required_ | ```String``` | Must match an existing role in chosen Template(s). It's case-sensitive. | | -| `name`*_required_ | ```String``` | The name of the signer. | | -| `email_address`*_required_ | ```String``` | The email address of the signer. | | -| `pin` | ```String``` | The 4- to 12-character access code that will secure this signer's signature page. | | -| `sms_phone_number` | ```String``` | An E.164 formatted phone number.

By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).

**NOTE:** Not available in test mode and requires a Standard plan or higher. | | -| `sms_phone_number_type` | ```String``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.

If `authentication`, signer is sent a verification code via SMS that is required to access the document.

If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | | +| `role`*_required_ | ```String``` | _t__Sub::SignatureRequestTemplateSigner::ROLE | | +| `name`*_required_ | ```String``` | _t__Sub::SignatureRequestTemplateSigner::NAME | | +| `email_address`*_required_ | ```String``` | _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS | | +| `pin` | ```String``` | _t__Sub::SignatureRequestTemplateSigner::PIN | | +| `sms_phone_number` | ```String``` | _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER | | +| `sms_phone_number_type` | ```String``` | _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE | | diff --git a/sdks/ruby/docs/SubSigningOptions.md b/sdks/ruby/docs/SubSigningOptions.md index d2eb449f7..92778b18c 100644 --- a/sdks/ruby/docs/SubSigningOptions.md +++ b/sdks/ruby/docs/SubSigningOptions.md @@ -1,16 +1,14 @@ # Dropbox::Sign::SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. - -**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +_t__Sub::SigningOptions::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `default_type`*_required_ | ```String``` | The default type shown (limited to the listed types) | | -| `draw` | ```Boolean``` | Allows drawing the signature | [default to false] | -| `phone` | ```Boolean``` | Allows using a smartphone to email the signature | [default to false] | -| `type` | ```Boolean``` | Allows typing the signature | [default to false] | -| `upload` | ```Boolean``` | Allows uploading the signature | [default to false] | +| `default_type`*_required_ | ```String``` | _t__Sub::SigningOptions::DEFAULT | | +| `draw` | ```Boolean``` | _t__Sub::SigningOptions::DRAW | [default to false] | +| `phone` | ```Boolean``` | _t__Sub::SigningOptions::PHONE | [default to false] | +| `type` | ```Boolean``` | _t__Sub::SigningOptions::TYPE | [default to false] | +| `upload` | ```Boolean``` | _t__Sub::SigningOptions::UPLOAD | [default to false] | diff --git a/sdks/ruby/docs/SubTeamResponse.md b/sdks/ruby/docs/SubTeamResponse.md index 78e2016bb..7ec9e990a 100644 --- a/sdks/ruby/docs/SubTeamResponse.md +++ b/sdks/ruby/docs/SubTeamResponse.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `team_id` | ```String``` | The id of a team | | -| `name` | ```String``` | The name of a team | | +| `team_id` | ```String``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```String``` | _t__TeamGeneral::NAME | | diff --git a/sdks/ruby/docs/SubTemplateRole.md b/sdks/ruby/docs/SubTemplateRole.md index 27eb6c794..335e1ab26 100644 --- a/sdks/ruby/docs/SubTemplateRole.md +++ b/sdks/ruby/docs/SubTemplateRole.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The role name of the signer that will be displayed when the template is used to create a signature request. | | -| `order` | ```Integer``` | The order in which this signer role is required to sign. | | +| `name` | ```String``` | _t__Sub::SignerRole::NAME | | +| `order` | ```Integer``` | _t__Sub::SignerRole::ORDER | | diff --git a/sdks/ruby/docs/SubUnclaimedDraftSigner.md b/sdks/ruby/docs/SubUnclaimedDraftSigner.md index 971dd134c..22895e432 100644 --- a/sdks/ruby/docs/SubUnclaimedDraftSigner.md +++ b/sdks/ruby/docs/SubUnclaimedDraftSigner.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `email_address`*_required_ | ```String``` | The email address of the signer. | | -| `name`*_required_ | ```String``` | The name of the signer. | | -| `order` | ```Integer``` | The order the signer is required to sign in. | | +| `email_address`*_required_ | ```String``` | _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS | | +| `name`*_required_ | ```String``` | _t__Sub::UnclaimedDraftSigner::NAME | | +| `order` | ```Integer``` | _t__Sub::UnclaimedDraftSigner::ORDER | | diff --git a/sdks/ruby/docs/SubUnclaimedDraftTemplateSigner.md b/sdks/ruby/docs/SubUnclaimedDraftTemplateSigner.md index 9c5fd8763..fe94035bc 100644 --- a/sdks/ruby/docs/SubUnclaimedDraftTemplateSigner.md +++ b/sdks/ruby/docs/SubUnclaimedDraftTemplateSigner.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `role`*_required_ | ```String``` | Must match an existing role in chosen Template(s). | | -| `name`*_required_ | ```String``` | The name of the signer filling the role of `role`. | | -| `email_address`*_required_ | ```String``` | The email address of the signer filling the role of `role`. | | +| `role`*_required_ | ```String``` | _t__Sub::UnclaimedDraftTemplateSigner::ROLE | | +| `name`*_required_ | ```String``` | _t__Sub::UnclaimedDraftTemplateSigner::NAME | | +| `email_address`*_required_ | ```String``` | _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS | | diff --git a/sdks/ruby/docs/SubWhiteLabelingOptions.md b/sdks/ruby/docs/SubWhiteLabelingOptions.md index 5be083c58..40cd05511 100644 --- a/sdks/ruby/docs/SubWhiteLabelingOptions.md +++ b/sdks/ruby/docs/SubWhiteLabelingOptions.md @@ -1,8 +1,6 @@ # Dropbox::Sign::SubWhiteLabelingOptions -An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) - -Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. +_t__Sub::WhiteLabelingOptions::DESCRIPTION ## Properties @@ -22,5 +20,5 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r | `secondary_button_text_color_hover` | ```String``` | | [default to '#0061FE'] | | `text_color1` | ```String``` | | [default to '#808080'] | | `text_color2` | ```String``` | | [default to '#ffffff'] | -| `reset_to_default` | ```Boolean``` | Resets white labeling options to defaults. Only useful when updating an API App. | | +| `reset_to_default` | ```Boolean``` | _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT | | diff --git a/sdks/ruby/docs/TeamGetInfoResponse.md b/sdks/ruby/docs/TeamGetInfoResponse.md index f2ed62785..5a4fd678f 100644 --- a/sdks/ruby/docs/TeamGetInfoResponse.md +++ b/sdks/ruby/docs/TeamGetInfoResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `team`*_required_ | [```TeamInfoResponse```](TeamInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/TeamGetResponse.md b/sdks/ruby/docs/TeamGetResponse.md index 9c5bd49a6..23862dbc3 100644 --- a/sdks/ruby/docs/TeamGetResponse.md +++ b/sdks/ruby/docs/TeamGetResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `team`*_required_ | [```TeamResponse```](TeamResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/TeamInfoResponse.md b/sdks/ruby/docs/TeamInfoResponse.md index 482c6ac37..db8bb9510 100644 --- a/sdks/ruby/docs/TeamInfoResponse.md +++ b/sdks/ruby/docs/TeamInfoResponse.md @@ -6,9 +6,9 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `team_id` | ```String``` | The id of a team | | +| `team_id` | ```String``` | _t__TeamGeneral::TEAM_ID | | | `team_parent` | [```TeamParentResponse```](TeamParentResponse.md) | | | -| `name` | ```String``` | The name of a team | | -| `num_members` | ```Integer``` | Number of members within a team | | -| `num_sub_teams` | ```Integer``` | Number of sub teams within a team | | +| `name` | ```String``` | _t__TeamGeneral::NAME | | +| `num_members` | ```Integer``` | _t__TeamGeneral::NUM_MEMBERS | | +| `num_sub_teams` | ```Integer``` | _t__TeamGeneral::NUM_SUB_TEAMS | | diff --git a/sdks/ruby/docs/TeamParentResponse.md b/sdks/ruby/docs/TeamParentResponse.md index 3383063db..089e4f682 100644 --- a/sdks/ruby/docs/TeamParentResponse.md +++ b/sdks/ruby/docs/TeamParentResponse.md @@ -6,6 +6,6 @@ Information about the parent team if a team has one, set to `null` otherwise. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `team_id` | ```String``` | The id of a team | | -| `name` | ```String``` | The name of a team | | +| `team_id` | ```String``` | _t__TeamGeneral::TEAM_ID | | +| `name` | ```String``` | _t__TeamGeneral::NAME | | diff --git a/sdks/ruby/docs/TeamResponse.md b/sdks/ruby/docs/TeamResponse.md index b7b847604..32ce869f1 100644 --- a/sdks/ruby/docs/TeamResponse.md +++ b/sdks/ruby/docs/TeamResponse.md @@ -1,13 +1,13 @@ # Dropbox::Sign::TeamResponse -Contains information about your team and its members +_t__TeamResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of your Team | | +| `name` | ```String``` | _t__Team::NAME | | | `accounts` | [```Array```](AccountResponse.md) | | | -| `invited_accounts` | [```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`. | | -| `invited_emails` | ```Array``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | | +| `invited_accounts` | [```Array```](AccountResponse.md) | _t__Team::INVITED_ACCOUNTS | | +| `invited_emails` | ```Array``` | _t__Team::INVITED_EMAILS | | diff --git a/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md index d23e4cea8..5a0a36a0f 100644 --- a/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md @@ -11,7 +11,8 @@ | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to true] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_roles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -22,7 +23,7 @@ | `form_fields_per_document` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `merge_fields` | [```Array```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```String``` | The default template email message. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `show_preview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | | `show_progress_stepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | | `signer_roles` | [```Array```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | diff --git a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponse.md b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponse.md index 74fdd9ff4..b6664c2ce 100644 --- a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponse.md +++ b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template`*_required_ | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 9006aa0f8..91249d308 100644 --- a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -1,13 +1,13 @@ # Dropbox::Sign::TemplateCreateEmbeddedDraftResponseTemplate -Template object with parameters: `template_id`, `edit_url`, `expires_at`. +_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | -| `edit_url` | ```String``` | Link to edit the template. | | -| `expires_at` | ```Integer``` | When the link expires. | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `template_id` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | +| `edit_url` | ```String``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL | | +| `expires_at` | ```Integer``` | _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/TemplateCreateRequest.md b/sdks/ruby/docs/TemplateCreateRequest.md index 35e9df09e..018143002 100644 --- a/sdks/ruby/docs/TemplateCreateRequest.md +++ b/sdks/ruby/docs/TemplateCreateRequest.md @@ -11,7 +11,8 @@ | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_roles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `client_id` | ```String``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | | @@ -19,7 +20,7 @@ | `form_field_rules` | [```Array```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | | `merge_fields` | [```Array```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | | | `message` | ```String``` | The default template email message. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `subject` | ```String``` | The template title (alias). | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | diff --git a/sdks/ruby/docs/TemplateCreateResponse.md b/sdks/ruby/docs/TemplateCreateResponse.md index 217f81d55..632c4864c 100644 --- a/sdks/ruby/docs/TemplateCreateResponse.md +++ b/sdks/ruby/docs/TemplateCreateResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template`*_required_ | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/TemplateCreateResponseTemplate.md b/sdks/ruby/docs/TemplateCreateResponseTemplate.md index 4d9488de7..754f340b4 100644 --- a/sdks/ruby/docs/TemplateCreateResponseTemplate.md +++ b/sdks/ruby/docs/TemplateCreateResponseTemplate.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateCreateResponseTemplate -Template object with parameters: `template_id`. +_t__TemplateCreateResponseTemplate::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | +| `template_id` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | diff --git a/sdks/ruby/docs/TemplateEditResponse.md b/sdks/ruby/docs/TemplateEditResponse.md index 5b46080d2..f5f1c1efe 100644 --- a/sdks/ruby/docs/TemplateEditResponse.md +++ b/sdks/ruby/docs/TemplateEditResponse.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id`*_required_ | ```String``` | The id of the Template. | | +| `template_id`*_required_ | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | diff --git a/sdks/ruby/docs/TemplateGetResponse.md b/sdks/ruby/docs/TemplateGetResponse.md index 73127d1b7..6489af337 100644 --- a/sdks/ruby/docs/TemplateGetResponse.md +++ b/sdks/ruby/docs/TemplateGetResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template`*_required_ | [```TemplateResponse```](TemplateResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/TemplateListResponse.md b/sdks/ruby/docs/TemplateListResponse.md index 7708321ae..d7a0cda3c 100644 --- a/sdks/ruby/docs/TemplateListResponse.md +++ b/sdks/ruby/docs/TemplateListResponse.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `templates`*_required_ | [```Array```](TemplateResponse.md) | List of templates that the API caller has access to. | | +| `templates`*_required_ | [```Array```](TemplateResponse.md) | _t__TemplateListResponse::DESCRIPTION | | | `list_info`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/TemplateResponse.md b/sdks/ruby/docs/TemplateResponse.md index f5a661e9c..570676b58 100644 --- a/sdks/ruby/docs/TemplateResponse.md +++ b/sdks/ruby/docs/TemplateResponse.md @@ -1,25 +1,25 @@ # Dropbox::Sign::TemplateResponse -Contains information about the templates you and your team have created. +_t__TemplateResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | -| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `updated_at` | ```Integer``` | Time the template was last updated. | | -| `is_embedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | -| `is_creator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | -| `metadata` | ```Hash``` | The metadata attached to the template. | | -| `signer_roles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | -| `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `named_form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | -| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | +| `template_id` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | +| `title` | ```String``` | _t__TemplateResponse::TITLE | | +| `message` | ```String``` | _t__TemplateResponse::MESSAGE | | +| `updated_at` | ```Integer``` | _t__TemplateResponse::UPDATED_AT | | +| `is_embedded` | ```Boolean``` | _t__TemplateResponse::IS_EMBEDDED | | +| `is_creator` | ```Boolean``` | _t__TemplateResponse::IS_CREATOR | | +| `can_edit` | ```Boolean``` | _t__TemplateResponse::CAN_EDIT | | +| `is_locked` | ```Boolean``` | _t__TemplateResponse::IS_LOCKED | | +| `metadata` | ```Hash``` | _t__TemplateResponse::METADATA | | +| `signer_roles` | [```Array```](TemplateResponseSignerRole.md) | _t__TemplateResponse::SIGNER_ROLES | | +| `cc_roles` | [```Array```](TemplateResponseCCRole.md) | _t__TemplateResponse::CC_ROLES | | +| `documents` | [```Array```](TemplateResponseDocument.md) | _t__TemplateResponse::DOCUMENTS | | +| `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseCustomField::DESCRIPTION | | +| `named_form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseNamedFormField::DESCRIPTION | | +| `accounts` | [```Array```](TemplateResponseAccount.md) | _t__TemplateResponse::ACCOUNTS | | +| `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | _t__SignatureRequestResponseAttachment::DESCRIPTION | | diff --git a/sdks/ruby/docs/TemplateResponseAccount.md b/sdks/ruby/docs/TemplateResponseAccount.md index dcb2bc328..db17a50e0 100644 --- a/sdks/ruby/docs/TemplateResponseAccount.md +++ b/sdks/ruby/docs/TemplateResponseAccount.md @@ -6,10 +6,10 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `account_id` | ```String``` | The id of the Account. | | -| `email_address` | ```String``` | The email address associated with the Account. | | -| `is_locked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `account_id` | ```String``` | _t__TemplateResponseAccount::ACCOUNT_ID | | +| `email_address` | ```String``` | _t__TemplateResponseAccount::EMAIL_ADDRESS | | +| `is_locked` | ```Boolean``` | _t__TemplateResponseAccount::IS_LOCKED | | +| `is_paid_hs` | ```Boolean``` | _t__TemplateResponseAccount::IS_PAID_HS | | +| `is_paid_hf` | ```Boolean``` | _t__TemplateResponseAccount::IS_PAID_HF | | | `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/ruby/docs/TemplateResponseAccountQuota.md b/sdks/ruby/docs/TemplateResponseAccountQuota.md index 8e314836a..6a42a9507 100644 --- a/sdks/ruby/docs/TemplateResponseAccountQuota.md +++ b/sdks/ruby/docs/TemplateResponseAccountQuota.md @@ -1,13 +1,13 @@ # Dropbox::Sign::TemplateResponseAccountQuota -An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. +_t__TemplateResponseAccountQuota::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `templates_left` | ```Integer``` | API templates remaining. | | -| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | | -| `documents_left` | ```Integer``` | Signature requests remaining. | | -| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | | +| `templates_left` | ```Integer``` | _t__TemplateResponseAccountQuota::TEMPLATES_LEFT | | +| `api_signature_requests_left` | ```Integer``` | _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT | | +| `documents_left` | ```Integer``` | _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT | | +| `sms_verifications_left` | ```Integer``` | _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT | | diff --git a/sdks/ruby/docs/TemplateResponseCCRole.md b/sdks/ruby/docs/TemplateResponseCCRole.md index b8c9b08f8..797e20b9b 100644 --- a/sdks/ruby/docs/TemplateResponseCCRole.md +++ b/sdks/ruby/docs/TemplateResponseCCRole.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of the Role. | | +| `name` | ```String``` | _t__TemplateResponseCCRole::NAME | | diff --git a/sdks/ruby/docs/TemplateResponseDocument.md b/sdks/ruby/docs/TemplateResponseDocument.md index 5b9a105ae..a73f116e2 100644 --- a/sdks/ruby/docs/TemplateResponseDocument.md +++ b/sdks/ruby/docs/TemplateResponseDocument.md @@ -6,10 +6,10 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | Name of the associated file. | | -| `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | +| `name` | ```String``` | _t__TemplateResponseDocument::NAME | | +| `index` | ```Integer``` | _t__TemplateResponseDocument::INDEX | | +| `field_groups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | _t__TemplateResponseDocument::FIELD_GROUPS | | +| `form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | _t__TemplateResponseDocumentFormField::DESCRIPTION | | +| `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | _t__TemplateResponseDocumentCustomField::DESCRIPTION | | +| `static_fields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | _t__TemplateResponseDocumentStaticField::DESCRIPTION | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md index 53f1fae78..bf32b0779 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md @@ -1,19 +1,19 @@ # Dropbox::Sign::TemplateResponseDocumentCustomFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentCustomField::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | | | -| `api_id` | ```String``` | The unique ID for this field. | | -| `name` | ```String``` | The name of the Custom Field. | | -| `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `api_id` | ```String``` | _t__TemplateResponseDocumentCustomField::API_ID | | +| `name` | ```String``` | _t__TemplateResponseDocumentCustomField::NAME | | +| `signer` | ```String``` | _t__TemplateResponseDocumentCustomField::SIGNER | | +| `x` | ```Integer``` | _t__TemplateResponseDocumentCustomField::X | | +| `y` | ```Integer``` | _t__TemplateResponseDocumentCustomField::Y | | +| `width` | ```Integer``` | _t__TemplateResponseDocumentCustomField::WIDTH | | +| `height` | ```Integer``` | _t__TemplateResponseDocumentCustomField::HEIGHT | | +| `required` | ```Boolean``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```String``` | _t__TemplateResponseDocumentCustomField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldCheckbox.md index bd8834cd2..8f246f79f 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateResponseDocumentCustomFieldCheckbox -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `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'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentCustomField::TYPE | [default to 'checkbox'] | diff --git a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md index 52138173c..a9d0c7582 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md @@ -1,14 +1,14 @@ # Dropbox::Sign::TemplateResponseDocumentCustomFieldText -This class extends `TemplateResponseDocumentCustomFieldBase` +_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentCustomField::TYPE | [default to 'text'] | | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | -| `font_family` | ```String``` | Font family used in this form field's text. | | +| `is_multiline` | ```Boolean``` | _t__TemplateResponseDocumentCustomField::IS_MULTILINE | | +| `original_font_size` | ```Integer``` | _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE | | +| `font_family` | ```String``` | _t__TemplateResponseDocumentCustomField::FONT_FAMILY | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md b/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md index 114dba8b6..224f91a4b 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of the form field group. | | +| `name` | ```String``` | _t__TemplateResponseDocumentFieldGroup::NAME | | | `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md index 601ef69a3..93e667e7f 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md @@ -1,11 +1,11 @@ # Dropbox::Sign::TemplateResponseDocumentFieldGroupRule -The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). +_t__TemplateResponseDocumentFieldGroup::RULE ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `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. | | -| `group_label` | ```String``` | Name of the group | | +| `requirement` | ```String``` | _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT | | +| `group_label` | ```String``` | _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md index 381c4814b..d9c2beaa2 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md @@ -1,18 +1,18 @@ # Dropbox::Sign::TemplateResponseDocumentFormFieldBase -An array of Form Field objects containing the name and type of each named field. +_t__TemplateResponseDocumentFormField::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | | | -| `api_id` | ```String``` | A unique id for the form field. | | -| `name` | ```String``` | The name of the form field. | | -| `signer` | ```String``` | The signer of the Form Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `api_id` | ```String``` | _t__TemplateResponseDocumentFormField::API_ID | | +| `name` | ```String``` | _t__TemplateResponseDocumentFormField::NAME | | +| `signer` | ```String``` | _t__TemplateResponseDocumentFormField::SIGNER | | +| `x` | ```Integer``` | _t__TemplateResponseDocumentFormField::X | | +| `y` | ```Integer``` | _t__TemplateResponseDocumentFormField::Y | | +| `width` | ```Integer``` | _t__TemplateResponseDocumentFormField::WIDTH | | +| `height` | ```Integer``` | _t__TemplateResponseDocumentFormField::HEIGHT | | +| `required` | ```Boolean``` | _t__TemplateResponseDocumentFormField::REQUIRED | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md index 13dd5cb48..134f54515 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -1,11 +1,11 @@ # Dropbox::Sign::TemplateResponseDocumentFormFieldCheckbox -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'checkbox'] | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md index 253d8b41e..7359df40c 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -1,11 +1,11 @@ # Dropbox::Sign::TemplateResponseDocumentFormFieldDateSigned -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'date_signed'] | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md index b224d1011..2bb8e4650 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -1,11 +1,11 @@ # Dropbox::Sign::TemplateResponseDocumentFormFieldDropdown -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'dropdown'] | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md index 2bf06c0c0..1614120eb 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -1,15 +1,15 @@ # Dropbox::Sign::TemplateResponseDocumentFormFieldHyperlink -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'hyperlink'] | | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | -| `font_family` | ```String``` | Font family used in this form field's text. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `is_multiline` | ```Boolean``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `original_font_size` | ```Integer``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `font_family` | ```String``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md index 63387d36e..f8e070176 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md @@ -1,11 +1,11 @@ # Dropbox::Sign::TemplateResponseDocumentFormFieldInitials -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'initials'] | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md index fcdc459aa..addeede1f 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md @@ -1,11 +1,11 @@ # Dropbox::Sign::TemplateResponseDocumentFormFieldRadio -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | -| `group`*_required_ | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'radio'] | +| `group`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md index 552a3c814..11d2a8ba7 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md @@ -1,11 +1,11 @@ # Dropbox::Sign::TemplateResponseDocumentFormFieldSignature -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'signature'] | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md index f63026a61..e5d852eea 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md @@ -1,18 +1,18 @@ # Dropbox::Sign::TemplateResponseDocumentFormFieldText -This class extends `TemplateResponseDocumentFormFieldBase` +_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentFormField::TYPE | [default to 'text'] | | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | -| `font_family` | ```String``` | Font family used in this form field's text. | | -| `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | -| `validation_custom_regex` | ```String``` | When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. | | -| `validation_custom_regex_format_label` | ```String``` | When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `is_multiline` | ```Boolean``` | _t__TemplateResponseDocumentFormField::IS_MULTILINE | | +| `original_font_size` | ```Integer``` | _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE | | +| `font_family` | ```String``` | _t__TemplateResponseDocumentFormField::FONT_FAMILY | | +| `validation_type` | ```String``` | _t__TemplateResponseDocumentFormField::VALIDATION_TYPE | | +| `validation_custom_regex` | ```String``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX | | +| `validation_custom_regex_format_label` | ```String``` | _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL | | +| `group` | ```String``` | _t__TemplateResponseDocumentFormField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md index 49696a59f..de2ff23da 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md @@ -1,19 +1,19 @@ # Dropbox::Sign::TemplateResponseDocumentStaticFieldBase -An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. +_t__TemplateResponseDocumentStaticField::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | | | -| `api_id` | ```String``` | A unique id for the static field. | | -| `name` | ```String``` | The name of the static field. | | -| `signer` | ```String``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width` | ```Integer``` | The width in pixels of this static field. | | -| `height` | ```Integer``` | The height in pixels of this static field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | +| `api_id` | ```String``` | _t__TemplateResponseDocumentStaticField::API_ID | | +| `name` | ```String``` | _t__TemplateResponseDocumentStaticField::NAME | | +| `signer` | ```String``` | _t__TemplateResponseDocumentStaticField::SIGNER | [default to 'me_now'] | +| `x` | ```Integer``` | _t__TemplateResponseDocumentStaticField::X | | +| `y` | ```Integer``` | _t__TemplateResponseDocumentStaticField::Y | | +| `width` | ```Integer``` | _t__TemplateResponseDocumentStaticField::WIDTH | | +| `height` | ```Integer``` | _t__TemplateResponseDocumentStaticField::HEIGHT | | +| `required` | ```Boolean``` | _t__TemplateResponseDocumentStaticField::REQUIRED | | +| `group` | ```String``` | _t__TemplateResponseDocumentStaticField::GROUP | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldCheckbox.md index ba4a23e1b..77ab2f067 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateResponseDocumentStaticFieldCheckbox -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'checkbox'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'checkbox'] | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldDateSigned.md index 2d5cf1839..aec043df7 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateResponseDocumentStaticFieldDateSigned -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'date_signed'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'date_signed'] | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldDropdown.md index fd76a6ff3..f7ac1ed68 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateResponseDocumentStaticFieldDropdown -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'dropdown'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'dropdown'] | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldHyperlink.md index df80401ce..53080ef6e 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateResponseDocumentStaticFieldHyperlink -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'hyperlink'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'hyperlink'] | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldInitials.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldInitials.md index 9cd4cc8bb..06b046245 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateResponseDocumentStaticFieldInitials -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'initials'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'initials'] | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldRadio.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldRadio.md index 5fb668d3b..8912aaa78 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateResponseDocumentStaticFieldRadio -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'radio'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'radio'] | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldSignature.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldSignature.md index 287ff95fb..87d1615a6 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateResponseDocumentStaticFieldSignature -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'signature'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'signature'] | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldText.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldText.md index df35ddb9b..77a757e87 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldText.md @@ -1,10 +1,10 @@ # Dropbox::Sign::TemplateResponseDocumentStaticFieldText -This class extends `TemplateResponseDocumentStaticFieldBase` +_t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'text'] | +| `type`*_required_ | ```String``` | _t__TemplateResponseDocumentStaticField::TYPE | [default to 'text'] | diff --git a/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md b/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md index 923bc0fc1..c5038876b 100644 --- a/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md @@ -1,11 +1,11 @@ # Dropbox::Sign::TemplateResponseFieldAvgTextLength -Average text length in this field. +_t__TemplateResponseFieldAvgTextLength::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `num_lines` | ```Integer``` | Number of lines. | | -| `num_chars_per_line` | ```Integer``` | Number of characters per line. | | +| `num_lines` | ```Integer``` | _t__TemplateResponseFieldAvgTextLength::NUM_LINES | | +| `num_chars_per_line` | ```Integer``` | _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE | | diff --git a/sdks/ruby/docs/TemplateResponseSignerRole.md b/sdks/ruby/docs/TemplateResponseSignerRole.md index e61e1ef66..b5e9ce7ed 100644 --- a/sdks/ruby/docs/TemplateResponseSignerRole.md +++ b/sdks/ruby/docs/TemplateResponseSignerRole.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of the Role. | | -| `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | +| `name` | ```String``` | _t__TemplateResponseSignerRole::NAME | | +| `order` | ```Integer``` | _t__TemplateResponseSignerRole::ORDER | | diff --git a/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md index f0964f519..5ab9baf6c 100644 --- a/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md @@ -1,11 +1,11 @@ # Dropbox::Sign::TemplateUpdateFilesResponseTemplate -Contains template id +_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `template_id` | ```String``` | _t__TemplateResponse::TEMPLATE_ID | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md index 47acc3977..5dee46faa 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -12,8 +12,9 @@ | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to true] | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | +| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | | `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -27,11 +28,11 @@ | `hold_request` | ```Boolean``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | | `is_for_embedded_signing` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `requesting_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully request a signature. | | | `show_preview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | | | `show_progress_stepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```Array```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```Array```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `skip_me_now` | ```Boolean``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md index d0cd4b018..85e937dc6 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md @@ -22,12 +22,12 @@ | `hold_request` | ```Boolean``` | The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] | | `is_for_embedded_signing` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `preview_only` | ```Boolean``` | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.

**NOTE:** This parameter overwrites `show_preview=1` (if set). | [default to false] | | `requesting_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully request a signature. | | | `show_preview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] | | `show_progress_stepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```Array```](SubUnclaimedDraftTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `signers` | [```Array```](SubUnclaimedDraftTemplateSigner.md) | _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `skip_me_now` | ```Boolean``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateRequest.md b/sdks/ruby/docs/UnclaimedDraftCreateRequest.md index 3eeacd59f..71104e1c8 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateRequest.md @@ -10,7 +10,8 @@ | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | +| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | +| `attachments` | [```Array```](SubAttachment.md) | _t__SubAttachment::LIST_DESCRIPTION | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | | `client_id` | ```String``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | | `custom_fields` | [```Array```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | @@ -20,9 +21,9 @@ | `form_fields_per_document` | [```Array```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | | `hide_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] | | `message` | ```String``` | The custom message in the email that will be sent to the signers. | | -| `metadata` | ```Hash``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `metadata` | ```Hash``` | _t__Sub::Metadata::DESCRIPTION | | | `show_progress_stepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | -| `signers` | [```Array```](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | | +| `signers` | [```Array```](SubUnclaimedDraftSigner.md) | _t__Sub::UnclaimedDraftSigner::DESCRIPTION | | | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | | | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateResponse.md b/sdks/ruby/docs/UnclaimedDraftCreateResponse.md index 33608757c..ad0a580f5 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateResponse.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateResponse.md @@ -7,5 +7,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `unclaimed_draft`*_required_ | [```UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | | -| `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | +| `warnings` | [```Array```](WarningResponse.md) | _t__WarningResponse::LIST_DESCRIPTION | | diff --git a/sdks/ruby/docs/UnclaimedDraftResponse.md b/sdks/ruby/docs/UnclaimedDraftResponse.md index 14ab90f0f..41573c71d 100644 --- a/sdks/ruby/docs/UnclaimedDraftResponse.md +++ b/sdks/ruby/docs/UnclaimedDraftResponse.md @@ -1,15 +1,15 @@ # Dropbox::Sign::UnclaimedDraftResponse -A group of documents that a user can take ownership of via the claim URL. +_t__UnclaimedDraftResponse::DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `signature_request_id` | ```String``` | The ID of the signature request that is represented by this UnclaimedDraft. | | -| `claim_url` | ```String``` | The URL to be used to claim this UnclaimedDraft. | | -| `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | | -| `requesting_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). | | -| `expires_at` | ```Integer``` | When the link expires. | | -| `test_mode` | ```Boolean``` | Whether this is a test draft. Signature requests made from test drafts have no legal value. | | +| `signature_request_id` | ```String``` | _t__UnclaimedDraft::SIGNATURE_REQUEST_ID | | +| `claim_url` | ```String``` | _t__UnclaimedDraft::CLAIM_URL | | +| `signing_redirect_url` | ```String``` | _t__UnclaimedDraft::SIGNING_REDIRECT_URL | | +| `requesting_redirect_url` | ```String``` | _t__UnclaimedDraft::REQUESTING_REDIRECT_URL | | +| `expires_at` | ```Integer``` | _t__UnclaimedDraft::EXPIRES_AT | | +| `test_mode` | ```Boolean``` | _t__UnclaimedDraft::TEST_MODE | | diff --git a/sdks/ruby/docs/WarningResponse.md b/sdks/ruby/docs/WarningResponse.md index 09f61c088..c03f153b7 100644 --- a/sdks/ruby/docs/WarningResponse.md +++ b/sdks/ruby/docs/WarningResponse.md @@ -1,11 +1,11 @@ # Dropbox::Sign::WarningResponse -A list of warnings. +_t__WarningResponse::LIST_DESCRIPTION ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `warning_msg`*_required_ | ```String``` | Warning message | | -| `warning_name`*_required_ | ```String``` | Warning name | | +| `warning_msg`*_required_ | ```String``` | _t__WarningResponse::WARNING_MSG | | +| `warning_name`*_required_ | ```String``` | _t__WarningResponse::WARNING_NAME | | diff --git a/sdks/ruby/lib/dropbox-sign/models/account_create_response.rb b/sdks/ruby/lib/dropbox-sign/models/account_create_response.rb index 868cd74b8..4b85f785f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_create_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_create_response.rb @@ -24,7 +24,7 @@ class AccountCreateResponse # @return [OAuthTokenResponse] attr_accessor :oauth_data - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/account_get_response.rb b/sdks/ruby/lib/dropbox-sign/models/account_get_response.rb index cf00b1be9..e26830910 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_get_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_get_response.rb @@ -21,7 +21,7 @@ class AccountGetResponse # @return [AccountResponse] attr_accessor :account - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response.rb b/sdks/ruby/lib/dropbox-sign/models/account_response.rb index 4e96e470d..646a64345 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response.rb @@ -18,42 +18,42 @@ module Dropbox module Dropbox::Sign class AccountResponse - # The ID of the Account + # _t__Account::ACCOUNT_ID # @return [String] attr_accessor :account_id - # The email address associated with the Account. + # _t__Account::EMAIL_ADDRESS # @return [String] attr_accessor :email_address - # Returns `true` if the user has been locked out of their account by a team admin. + # _t__Account::IS_LOCKED # @return [Boolean] attr_accessor :is_locked - # Returns `true` if the user has a paid Dropbox Sign account. + # _t__Account::IS_PAID_HS # @return [Boolean] attr_accessor :is_paid_hs - # Returns `true` if the user has a paid HelloFax account. + # _t__Account::IS_PAID_HF # @return [Boolean] attr_accessor :is_paid_hf # @return [AccountResponseQuotas] attr_accessor :quotas - # The URL that Dropbox Sign events will `POST` to. + # _t__Account::CALLBACK_URL # @return [String, nil] attr_accessor :callback_url - # The membership role for the team. + # _t__Account::ROLE_CODE # @return [String, nil] attr_accessor :role_code - # The id of the team account belongs to. + # _t__Account::TEAM_ID # @return [String, nil] attr_accessor :team_id - # 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. + # _t__Account::LOCALE # @return [String, nil] attr_accessor :locale diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb index 8fab66aeb..11bcbd2c0 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_quotas.rb @@ -17,29 +17,29 @@ module Dropbox end module Dropbox::Sign - # Details concerning remaining monthly quotas. + # _t__Account::QUOTA class AccountResponseQuotas - # API signature requests remaining. + # _t__AccountQuota::API_SIGNATURE_REQUESTS_LEFT # @return [Integer, nil] attr_accessor :api_signature_requests_left - # Signature requests remaining. + # _t__AccountQuota::DOCUMENTS_LEFT # @return [Integer, nil] attr_accessor :documents_left - # Total API templates allowed. + # _t__AccountQuota::TEMPLATES_TOTAL # @return [Integer, nil] attr_accessor :templates_total - # API templates remaining. + # _t__AccountQuota::TEMPLATES_LEFT # @return [Integer, nil] attr_accessor :templates_left - # SMS verifications remaining. + # _t__AccountQuota::SMS_VERIFICATIONS_LEFT # @return [Integer, nil] attr_accessor :sms_verifications_left - # Number of fax pages left + # _t__AccountQuota::NUM_FAX_PAGES_LEFT # @return [Integer, nil] attr_accessor :num_fax_pages_left diff --git a/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb b/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb index a888f45e6..dfffb428f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_response_usage.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # Details concerning monthly usage + # _t__Account::USAGE class AccountResponseUsage - # Number of fax pages sent + # _t__AccountUsage::FAX_PAGES_SENT # @return [Integer, nil] attr_accessor :fax_pages_sent diff --git a/sdks/ruby/lib/dropbox-sign/models/account_verify_response.rb b/sdks/ruby/lib/dropbox-sign/models/account_verify_response.rb index 9cb98eef7..f727f26b8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_verify_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_verify_response.rb @@ -21,7 +21,7 @@ class AccountVerifyResponse # @return [AccountVerifyResponseAccount] attr_accessor :account - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/account_verify_response_account.rb b/sdks/ruby/lib/dropbox-sign/models/account_verify_response_account.rb index a4f225ef0..33cf9801c 100644 --- a/sdks/ruby/lib/dropbox-sign/models/account_verify_response_account.rb +++ b/sdks/ruby/lib/dropbox-sign/models/account_verify_response_account.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class AccountVerifyResponseAccount - # The email address associated with the Account. + # _t__Account::EMAIL_ADDRESS # @return [String] attr_accessor :email_address diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_create_request.rb index f37d1a2fc..c9cf7bf08 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_create_request.rb @@ -165,8 +165,8 @@ def list_invalid_properties invalid_properties.push('invalid value for "domains", domains cannot be nil.') end - if @domains.length > 2 - invalid_properties.push('invalid value for "domains", number of items must be less than or equal to 2.') + if @domains.length > 10 + invalid_properties.push('invalid value for "domains", number of items must be less than or equal to 10.') end if @domains.length < 1 @@ -184,7 +184,7 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @domains.nil? - return false if @domains.length > 2 + return false if @domains.length > 10 return false if @domains.length < 1 return false if @name.nil? true @@ -196,8 +196,8 @@ def domains=(domains) if domains.nil? fail ArgumentError, 'domains cannot be nil' end - if domains.length > 2 - fail ArgumentError, 'invalid value for "domains", number of items must be less than or equal to 2.' + if domains.length > 10 + fail ArgumentError, 'invalid value for "domains", number of items must be less than or equal to 10.' end if domains.length < 1 diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_get_response.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_get_response.rb index 2b22f7b64..58f71459b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_get_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_get_response.rb @@ -21,7 +21,7 @@ class ApiAppGetResponse # @return [ApiAppResponse] attr_accessor :api_app - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_list_response.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_list_response.rb index 5d034c11b..ce5bc2329 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_list_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_list_response.rb @@ -18,14 +18,14 @@ module Dropbox module Dropbox::Sign class ApiAppListResponse - # Contains information about API Apps. + # _t__ApiAppListResponse::DESCRIPTION # @return [Array] attr_accessor :api_apps # @return [ListInfoResponse] attr_accessor :list_info - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb index 17c9da0b3..aa6142d4c 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response.rb @@ -17,29 +17,29 @@ module Dropbox end module Dropbox::Sign - # Contains information about an API App. + # _t__ApiAppResponse::DESCRIPTION class ApiAppResponse - # The app's callback URL (for events) + # _t__ApiAppResponse::CALLBACK_URL # @return [String, nil] attr_accessor :callback_url - # The app's client id + # _t__ApiAppResponse::CLIENT_ID # @return [String] attr_accessor :client_id - # The time that the app was created + # _t__ApiAppResponse::CREATED_AT # @return [Integer] attr_accessor :created_at - # The domain name(s) associated with the app + # _t__ApiAppResponse::DOMAINS # @return [Array] attr_accessor :domains - # The name of the app + # _t__ApiAppResponse::NAME # @return [String] attr_accessor :name - # Boolean to indicate if the app has been approved + # _t__ApiAppResponse::IS_APPROVED # @return [Boolean] attr_accessor :is_approved diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb index d96568182..4a6c6a4f1 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_o_auth.rb @@ -17,21 +17,21 @@ module Dropbox end module Dropbox::Sign - # An object describing the app's OAuth properties, or null if OAuth is not configured for the app. + # _t__ApiAppResponseOAuth::DESCRIPTION class ApiAppResponseOAuth - # The app's OAuth callback URL. + # _t__ApiAppResponseOAuth::CALLBACK_URL # @return [String] attr_accessor :callback_url - # The app's OAuth secret, or null if the app does not belong to user. + # _t__ApiAppResponseOAuth::SECRET # @return [String, nil] attr_accessor :secret - # Array of OAuth scopes used by the app. + # _t__ApiAppResponseOAuth::SCOPES # @return [Array] attr_accessor :scopes - # Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. + # _t__ApiAppResponseOAuth::CHARGES_USERS # @return [Boolean] attr_accessor :charges_users diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb index ba9838751..48dd39d26 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_options.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # An object with options that override account settings. + # _t__ApiAppResponseOptions::DESCRIPTION class ApiAppResponseOptions - # Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document + # _t__ApiAppResponseOptions::CAN_INSERT_EVERYWHERE # @return [Boolean] attr_accessor :can_insert_everywhere diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb index 495c770f9..dfe7f7e68 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_owner_account.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # An object describing the app's owner + # _t__ApiAppResponseOwnerAccount::DESCRIPTION class ApiAppResponseOwnerAccount - # The owner account's ID + # _t__ApiAppResponseOwnerAccount::ACCOUNT_ID # @return [String] attr_accessor :account_id - # The owner account's email address + # _t__ApiAppResponseOwnerAccount::EMAIL_ADDRESS # @return [String] attr_accessor :email_address diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb index d1990e632..d2522a69d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb @@ -17,7 +17,7 @@ module Dropbox end module Dropbox::Sign - # An object with options to customize the app's signer page + # _t__ApiAppResponseWhiteLabelingOptions::DESCRIPTION class ApiAppResponseWhiteLabelingOptions # @return [String] attr_accessor :header_background_color diff --git a/sdks/ruby/lib/dropbox-sign/models/api_app_update_request.rb b/sdks/ruby/lib/dropbox-sign/models/api_app_update_request.rb index 45b38ce82..4e04ba155 100644 --- a/sdks/ruby/lib/dropbox-sign/models/api_app_update_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/api_app_update_request.rb @@ -161,8 +161,8 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if !@domains.nil? && @domains.length > 2 - invalid_properties.push('invalid value for "domains", number of items must be less than or equal to 2.') + if !@domains.nil? && @domains.length > 10 + invalid_properties.push('invalid value for "domains", number of items must be less than or equal to 10.') end invalid_properties @@ -171,15 +171,15 @@ def list_invalid_properties # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? - return false if !@domains.nil? && @domains.length > 2 + return false if !@domains.nil? && @domains.length > 10 true end # Custom attribute writer method with validation # @param [Object] domains Value to be assigned def domains=(domains) - if domains.length > 2 - fail ArgumentError, 'invalid value for "domains", number of items must be less than or equal to 2.' + if domains.length > 10 + fail ArgumentError, 'invalid value for "domains", number of items must be less than or equal to 10.' end @domains = domains diff --git a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response.rb b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response.rb index 113311e4d..3263b9faa 100644 --- a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response.rb @@ -24,11 +24,11 @@ class BulkSendJobGetResponse # @return [ListInfoResponse] attr_accessor :list_info - # Contains information about the Signature Requests sent in bulk. + # _t__BulkSendJobGetResponse::SIGNATURE_REQUESTS # @return [Array] attr_accessor :signature_requests - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb index 603f9e568..cc735b51f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +++ b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb @@ -18,103 +18,103 @@ module Dropbox module Dropbox::Sign class BulkSendJobGetResponseSignatureRequests - # Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + # _t__SignatureRequestResponse::TEST_MODE # @return [Boolean] attr_accessor :test_mode - # The id of the SignatureRequest. + # _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID # @return [String] attr_accessor :signature_request_id - # The email address of the initiator of the SignatureRequest. + # _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS # @return [String, nil] attr_accessor :requester_email_address - # The title the specified Account uses for the SignatureRequest. + # _t__SignatureRequestResponse::TITLE # @return [String] attr_accessor :title - # Default Label for account. + # _t__SignatureRequestResponse::ORIGINAL_TITLE # @return [String] attr_accessor :original_title - # The subject in the email that was initially sent to the signers. + # _t__SignatureRequestResponse::SUBJECT # @return [String, nil] attr_accessor :subject - # The custom message in the email that was initially sent to the signers. + # _t__SignatureRequestResponse::MESSAGE # @return [String, nil] attr_accessor :message - # The metadata attached to the signature request. + # _t__SignatureRequestResponse::METADATA # @return [Hash] attr_accessor :metadata - # Time the signature request was created. + # _t__SignatureRequestResponse::CREATED_AT # @return [Integer] attr_accessor :created_at - # The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + # _t__SignatureRequestResponse::EXPIRES_AT # @return [Integer, nil] attr_accessor :expires_at - # Whether or not the SignatureRequest has been fully executed by all signers. + # _t__SignatureRequestResponse::IS_COMPLETE # @return [Boolean] attr_accessor :is_complete - # Whether or not the SignatureRequest has been declined by a signer. + # _t__SignatureRequestResponse::IS_DECLINED # @return [Boolean] attr_accessor :is_declined - # Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + # _t__SignatureRequestResponse::HAS_ERROR # @return [Boolean] attr_accessor :has_error - # The URL where a copy of the request's documents can be downloaded. + # _t__SignatureRequestResponse::FILES_URL # @return [String] attr_accessor :files_url - # The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + # _t__SignatureRequestResponse::SIGNING_URL # @return [String, nil] attr_accessor :signing_url - # The URL where the requester and the signers can view the current status of the SignatureRequest. + # _t__SignatureRequestResponse::DETAILS_URL # @return [String] attr_accessor :details_url - # A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + # _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES # @return [Array] attr_accessor :cc_email_addresses - # The URL you want the signer redirected to after they successfully sign. + # _t__SignatureRequestResponse::SIGNING_REDIRECT_URL # @return [String, nil] attr_accessor :signing_redirect_url - # The path where the completed document can be downloaded + # _t__SignatureRequestResponse::FINAL_COPY_URI # @return [String, nil] attr_accessor :final_copy_uri - # Templates IDs used in this SignatureRequest (if any). + # _t__SignatureRequestResponse::TEMPLATE_IDS # @return [Array, nil] attr_accessor :template_ids - # An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + # _t__SignatureRequestResponseCustomField::DESCRIPTION # @return [Array, nil] attr_accessor :custom_fields - # Signer attachments. + # _t__SignatureRequestResponseAttachment::DESCRIPTION # @return [Array, nil] attr_accessor :attachments - # An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + # _t__SignatureRequestResponseData::DESCRIPTION # @return [Array, nil] attr_accessor :response_data - # An array of signature objects, 1 for each signer. + # _t__SignatureRequestResponseSignatures::DESCRIPTION # @return [Array] attr_accessor :signatures - # The id of the BulkSendJob. + # _t__BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID # @return [String] attr_accessor :bulk_send_job_id diff --git a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_list_response.rb b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_list_response.rb index 0f04a4ec3..71447f14a 100644 --- a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_list_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_list_response.rb @@ -18,14 +18,14 @@ module Dropbox module Dropbox::Sign class BulkSendJobListResponse - # Contains a list of BulkSendJobs that the API caller has access to. + # _t__BulkSendJobListResponse::BULK_SEND_JOBS # @return [Array] attr_accessor :bulk_send_jobs # @return [ListInfoResponse] attr_accessor :list_info - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb index cba78bfbe..afee7783b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_response.rb @@ -17,21 +17,21 @@ module Dropbox end module Dropbox::Sign - # Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. + # _t__BulkSendJobResponse::DESCRIPTION class BulkSendJobResponse - # The id of the BulkSendJob. + # _t__BulkSendJobResponse::BULK_SEND_JOB_ID # @return [String, nil] attr_accessor :bulk_send_job_id - # The total amount of Signature Requests queued for sending. + # _t__BulkSendJobResponse::TOTAL # @return [Integer] attr_accessor :total - # True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. + # _t__BulkSendJobResponse::IS_CREATOR # @return [Boolean] attr_accessor :is_creator - # Time that the BulkSendJob was created. + # _t__BulkSendJobResponse::CREATED_AT # @return [Integer] attr_accessor :created_at diff --git a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_send_response.rb b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_send_response.rb index 27e6921af..ec3eb2055 100644 --- a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_send_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_send_response.rb @@ -21,7 +21,7 @@ class BulkSendJobSendResponse # @return [BulkSendJobResponse] attr_accessor :bulk_send_job - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_request.rb b/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_request.rb index d192c0da3..64667e5f8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_request.rb @@ -22,6 +22,10 @@ class EmbeddedEditUrlRequest # @return [Boolean] attr_accessor :allow_edit_ccs + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + # The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. # @return [Array] attr_accessor :cc_roles @@ -61,6 +65,7 @@ class EmbeddedEditUrlRequest def self.attribute_map { :'allow_edit_ccs' => :'allow_edit_ccs', + :'allow_form_view' => :'allow_form_view', :'cc_roles' => :'cc_roles', :'editor_options' => :'editor_options', :'force_signer_roles' => :'force_signer_roles', @@ -87,6 +92,7 @@ def self.acceptable_attributes def self.openapi_types { :'allow_edit_ccs' => :'Boolean', + :'allow_form_view' => :'Boolean', :'cc_roles' => :'Array', :'editor_options' => :'SubEditorOptions', :'force_signer_roles' => :'Boolean', @@ -152,6 +158,12 @@ def initialize(attributes = {}) self.allow_edit_ccs = false end + if attributes.key?(:'allow_form_view') + self.allow_form_view = attributes[:'allow_form_view'] + else + self.allow_form_view = false + end + if attributes.key?(:'cc_roles') if (value = attributes[:'cc_roles']).is_a?(Array) self.cc_roles = value @@ -224,6 +236,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && allow_edit_ccs == o.allow_edit_ccs && + allow_form_view == o.allow_form_view && cc_roles == o.cc_roles && editor_options == o.editor_options && force_signer_roles == o.force_signer_roles && @@ -244,7 +257,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [allow_edit_ccs, cc_roles, editor_options, force_signer_roles, force_subject_message, merge_fields, preview_only, show_preview, show_progress_stepper, test_mode].hash + [allow_edit_ccs, allow_form_view, cc_roles, editor_options, force_signer_roles, force_subject_message, merge_fields, preview_only, show_preview, show_progress_stepper, test_mode].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_response.rb b/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_response.rb index 34a94f0af..d52b09558 100644 --- a/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_response.rb @@ -21,7 +21,7 @@ class EmbeddedEditUrlResponse # @return [EmbeddedEditUrlResponseEmbedded] attr_accessor :embedded - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb b/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb index 552543b33..6ae98e02b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +++ b/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # An embedded template object. + # _t__EmbeddedEditUrlResponseEmbedded::DESCRIPTION class EmbeddedEditUrlResponseEmbedded - # A template url that can be opened in an iFrame. + # _t__EmbeddedEditUrlResponseEmbedded::EDIT_URL # @return [String] attr_accessor :edit_url - # The specific time that the the `edit_url` link expires, in epoch. + # _t__EmbeddedEditUrlResponseEmbedded::EXPIRES_AT # @return [Integer] attr_accessor :expires_at diff --git a/sdks/ruby/lib/dropbox-sign/models/embedded_sign_url_response.rb b/sdks/ruby/lib/dropbox-sign/models/embedded_sign_url_response.rb index ac6fcd23f..a116702a1 100644 --- a/sdks/ruby/lib/dropbox-sign/models/embedded_sign_url_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/embedded_sign_url_response.rb @@ -21,7 +21,7 @@ class EmbeddedSignUrlResponse # @return [EmbeddedSignUrlResponseEmbedded] attr_accessor :embedded - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb b/sdks/ruby/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb index a6770f325..1a1a79630 100644 --- a/sdks/ruby/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +++ b/sdks/ruby/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # An object that contains necessary information to set up embedded signing. + # _t__EmbeddedSignUrlResponseEmbedded::DESCRIPTION class EmbeddedSignUrlResponseEmbedded - # A signature url that can be opened in an iFrame. + # _t__EmbeddedSignUrlResponseEmbedded::SIGN_URL # @return [String] attr_accessor :sign_url - # The specific time that the the `sign_url` link expires, in epoch. + # _t__EmbeddedSignUrlResponseEmbedded::EXPIRES_AT # @return [Integer] attr_accessor :expires_at diff --git a/sdks/ruby/lib/dropbox-sign/models/error_response_error.rb b/sdks/ruby/lib/dropbox-sign/models/error_response_error.rb index b1b85ff45..df1aa9d84 100644 --- a/sdks/ruby/lib/dropbox-sign/models/error_response_error.rb +++ b/sdks/ruby/lib/dropbox-sign/models/error_response_error.rb @@ -17,17 +17,17 @@ module Dropbox end module Dropbox::Sign - # Contains information about an error that occurred. + # _t__ErrorResponseError::DESCRIPTION class ErrorResponseError - # Message describing an error. + # _t__ErrorResponseError::ERROR_MSG # @return [String] attr_accessor :error_msg - # Name of the error. + # _t__ErrorResponseError::ERROR_NAME # @return [String] attr_accessor :error_name - # Path at which an error occurred. + # _t__ErrorResponseError::ERROR_PATH # @return [String] attr_accessor :error_path diff --git a/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event.rb b/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event.rb index 134eceee0..deb311466 100644 --- a/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event.rb +++ b/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event.rb @@ -17,17 +17,17 @@ module Dropbox end module Dropbox::Sign - # Basic information about the event that occurred. + # _t__EventCallbackRequestEvent::DESCRIPTION class EventCallbackRequestEvent - # Time the event was created (using Unix time). + # _t__EventCallbackRequestEvent::EVENT_TIME # @return [String] attr_accessor :event_time - # Type of callback event that was triggered. + # _t__EventCallbackRequestEvent::EVENT_TYPE # @return [String] attr_accessor :event_type - # Generated hash used to verify source of event data. + # _t__EventCallbackRequestEvent::EVENT_HASH # @return [String] attr_accessor :event_hash diff --git a/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event_metadata.rb b/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event_metadata.rb index a21984fd3..6e1cce8f4 100644 --- a/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +++ b/sdks/ruby/lib/dropbox-sign/models/event_callback_request_event_metadata.rb @@ -17,21 +17,21 @@ module Dropbox end module Dropbox::Sign - # Specific metadata about the event. + # _t__EventCallbackRequestEventMetadata::DESCRIPTION class EventCallbackRequestEventMetadata - # Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. + # _t__EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID # @return [String, nil] attr_accessor :related_signature_id - # Account ID the event was reported for. + # _t__EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID # @return [String, nil] attr_accessor :reported_for_account_id - # App ID the event was reported for. + # _t__EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID # @return [String, nil] attr_accessor :reported_for_app_id - # Message about a declined or failed (due to error) signature flow. + # _t__EventCallbackRequestEventMetadata::EVENT_MESSAGE # @return [String, nil] attr_accessor :event_message diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_get_response.rb b/sdks/ruby/lib/dropbox-sign/models/fax_get_response.rb index 20ed3843a..b52acb8a8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_get_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_get_response.rb @@ -21,7 +21,7 @@ class FaxGetResponse # @return [FaxResponse] attr_accessor :fax - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/file_response.rb b/sdks/ruby/lib/dropbox-sign/models/file_response.rb index 5d4ed8cad..32b3a77b3 100644 --- a/sdks/ruby/lib/dropbox-sign/models/file_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/file_response.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class FileResponse - # URL to the file. + # _t__FileResponse::FILE_URL # @return [String] attr_accessor :file_url - # When the link expires. + # _t__FileResponse::EXPIRES_AT # @return [Integer] attr_accessor :expires_at diff --git a/sdks/ruby/lib/dropbox-sign/models/file_response_data_uri.rb b/sdks/ruby/lib/dropbox-sign/models/file_response_data_uri.rb index 5db69e37c..af4b2ac8b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/file_response_data_uri.rb +++ b/sdks/ruby/lib/dropbox-sign/models/file_response_data_uri.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FileResponseDataUri - # File as base64 encoded string. + # _t__FileResponse::DATA_URI # @return [String] attr_accessor :data_uri diff --git a/sdks/ruby/lib/dropbox-sign/models/list_info_response.rb b/sdks/ruby/lib/dropbox-sign/models/list_info_response.rb index 6063b2666..4af333d5e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/list_info_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/list_info_response.rb @@ -17,21 +17,21 @@ module Dropbox end module Dropbox::Sign - # Contains pagination information about the data returned. + # _t__ListInfoResponse::DESCRIPTION class ListInfoResponse - # Total number of pages available. + # _t__ListInfoResponse::NUM_PAGES # @return [Integer] attr_accessor :num_pages - # Total number of objects available. + # _t__ListInfoResponse::NUM_RESULTS # @return [Integer, nil] attr_accessor :num_results - # Number of the page being returned. + # _t__ListInfoResponse::PAGE # @return [Integer] attr_accessor :page - # Objects returned per page. + # _t__ListInfoResponse::PAGE_SIZE # @return [Integer] attr_accessor :page_size diff --git a/sdks/ruby/lib/dropbox-sign/models/o_auth_token_response.rb b/sdks/ruby/lib/dropbox-sign/models/o_auth_token_response.rb index 1e35f0cc2..e72aab891 100644 --- a/sdks/ruby/lib/dropbox-sign/models/o_auth_token_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/o_auth_token_response.rb @@ -27,7 +27,7 @@ class OAuthTokenResponse # @return [String] attr_accessor :refresh_token - # Number of seconds until the `access_token` expires. Uses epoch time. + # _t__OAuthTokenResponse::EXPIRES_IN # @return [Integer] attr_accessor :expires_in diff --git a/sdks/ruby/lib/dropbox-sign/models/report_create_response.rb b/sdks/ruby/lib/dropbox-sign/models/report_create_response.rb index b65383f7b..6402f6226 100644 --- a/sdks/ruby/lib/dropbox-sign/models/report_create_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/report_create_response.rb @@ -21,7 +21,7 @@ class ReportCreateResponse # @return [ReportResponse] attr_accessor :report - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/report_response.rb b/sdks/ruby/lib/dropbox-sign/models/report_response.rb index 0cf3b7604..a3fd584d7 100644 --- a/sdks/ruby/lib/dropbox-sign/models/report_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/report_response.rb @@ -17,21 +17,21 @@ module Dropbox end module Dropbox::Sign - # Contains information about the report request. + # _t__ReportResponse::DESCRIPTION class ReportResponse - # A message indicating the requested operation's success + # _t__ReportResponse::SUCCESS # @return [String] attr_accessor :success - # The (inclusive) start date for the report data in MM/DD/YYYY format. + # _t__ReportResponse::START_DATE # @return [String] attr_accessor :start_date - # The (inclusive) end date for the report data in MM/DD/YYYY format. + # _t__ReportResponse::END_DATE # @return [String] attr_accessor :end_date - # 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). + # _t__ReportResponse::REPORT_TYPE # @return [Array] attr_accessor :report_type diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb index 138175730..73aff3d17 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb @@ -50,7 +50,7 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb index 1cc28d608..1f6c017ea 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb @@ -50,7 +50,7 @@ class SignatureRequestBulkSendWithTemplateRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb index 9ea538769..aa170f2b2 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb @@ -30,11 +30,11 @@ class SignatureRequestCreateEmbeddedRequest # @return [Array] attr_accessor :file_urls - # Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # _t__Sub::SignatureRequestSigner::DESCRIPTION # @return [Array] attr_accessor :signers - # Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION # @return [Array] attr_accessor :grouped_signers @@ -42,11 +42,15 @@ class SignatureRequestCreateEmbeddedRequest # @return [Boolean] attr_accessor :allow_decline + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. # @return [Boolean] attr_accessor :allow_reassign - # A list describing the attachments + # _t__SubAttachment::LIST_DESCRIPTION # @return [Array] attr_accessor :attachments @@ -81,7 +85,7 @@ class SignatureRequestCreateEmbeddedRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata @@ -121,6 +125,7 @@ def self.attribute_map :'signers' => :'signers', :'grouped_signers' => :'grouped_signers', :'allow_decline' => :'allow_decline', + :'allow_form_view' => :'allow_form_view', :'allow_reassign' => :'allow_reassign', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', @@ -161,6 +166,7 @@ def self.openapi_types :'signers' => :'Array', :'grouped_signers' => :'Array', :'allow_decline' => :'Boolean', + :'allow_form_view' => :'Boolean', :'allow_reassign' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', @@ -264,6 +270,12 @@ def initialize(attributes = {}) self.allow_decline = false end + if attributes.key?(:'allow_form_view') + self.allow_form_view = attributes[:'allow_form_view'] + else + self.allow_form_view = false + end + if attributes.key?(:'allow_reassign') self.allow_reassign = attributes[:'allow_reassign'] else @@ -451,6 +463,7 @@ def ==(o) signers == o.signers && grouped_signers == o.grouped_signers && allow_decline == o.allow_decline && + allow_form_view == o.allow_form_view && allow_reassign == o.allow_reassign && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && @@ -480,7 +493,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash + [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_form_view, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb index 8fdc7b267..d82ec9953 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb @@ -26,7 +26,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest # @return [String] attr_accessor :client_id - # Add Signers to your Templated-based Signature Request. + # _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION # @return [Array] attr_accessor :signers @@ -54,7 +54,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb index eb9ece9ee..bd523fe25 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb @@ -30,11 +30,11 @@ class SignatureRequestEditEmbeddedRequest # @return [Array] attr_accessor :file_urls - # Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # _t__Sub::SignatureRequestSigner::DESCRIPTION # @return [Array] attr_accessor :signers - # Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION # @return [Array] attr_accessor :grouped_signers @@ -42,11 +42,15 @@ class SignatureRequestEditEmbeddedRequest # @return [Boolean] attr_accessor :allow_decline + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. # @return [Boolean] attr_accessor :allow_reassign - # A list describing the attachments + # _t__SubAttachment::LIST_DESCRIPTION # @return [Array] attr_accessor :attachments @@ -81,7 +85,7 @@ class SignatureRequestEditEmbeddedRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata @@ -121,6 +125,7 @@ def self.attribute_map :'signers' => :'signers', :'grouped_signers' => :'grouped_signers', :'allow_decline' => :'allow_decline', + :'allow_form_view' => :'allow_form_view', :'allow_reassign' => :'allow_reassign', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', @@ -161,6 +166,7 @@ def self.openapi_types :'signers' => :'Array', :'grouped_signers' => :'Array', :'allow_decline' => :'Boolean', + :'allow_form_view' => :'Boolean', :'allow_reassign' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', @@ -264,6 +270,12 @@ def initialize(attributes = {}) self.allow_decline = false end + if attributes.key?(:'allow_form_view') + self.allow_form_view = attributes[:'allow_form_view'] + else + self.allow_form_view = false + end + if attributes.key?(:'allow_reassign') self.allow_reassign = attributes[:'allow_reassign'] else @@ -451,6 +463,7 @@ def ==(o) signers == o.signers && grouped_signers == o.grouped_signers && allow_decline == o.allow_decline && + allow_form_view == o.allow_form_view && allow_reassign == o.allow_reassign && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && @@ -480,7 +493,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash + [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_form_view, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb index 8bc7d63dc..2f02b3f1b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb @@ -26,7 +26,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest # @return [String] attr_accessor :client_id - # Add Signers to your Templated-based Signature Request. + # _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION # @return [Array] attr_accessor :signers @@ -54,7 +54,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb index 299dc7033..bffeb0fdc 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb @@ -26,11 +26,11 @@ class SignatureRequestEditRequest # @return [Array] attr_accessor :file_urls - # Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # _t__Sub::SignatureRequestSigner::DESCRIPTION # @return [Array] attr_accessor :signers - # Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION # @return [Array] attr_accessor :grouped_signers @@ -38,11 +38,15 @@ class SignatureRequestEditRequest # @return [Boolean] attr_accessor :allow_decline + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. # @return [Boolean] attr_accessor :allow_reassign - # A list describing the attachments + # _t__SubAttachment::LIST_DESCRIPTION # @return [Array] attr_accessor :attachments @@ -85,7 +89,7 @@ class SignatureRequestEditRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata @@ -124,6 +128,7 @@ def self.attribute_map :'signers' => :'signers', :'grouped_signers' => :'grouped_signers', :'allow_decline' => :'allow_decline', + :'allow_form_view' => :'allow_form_view', :'allow_reassign' => :'allow_reassign', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', @@ -165,6 +170,7 @@ def self.openapi_types :'signers' => :'Array', :'grouped_signers' => :'Array', :'allow_decline' => :'Boolean', + :'allow_form_view' => :'Boolean', :'allow_reassign' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', @@ -266,6 +272,12 @@ def initialize(attributes = {}) self.allow_decline = false end + if attributes.key?(:'allow_form_view') + self.allow_form_view = attributes[:'allow_form_view'] + else + self.allow_form_view = false + end + if attributes.key?(:'allow_reassign') self.allow_reassign = attributes[:'allow_reassign'] else @@ -445,6 +457,7 @@ def ==(o) signers == o.signers && grouped_signers == o.grouped_signers && allow_decline == o.allow_decline && + allow_form_view == o.allow_form_view && allow_reassign == o.allow_reassign && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && @@ -476,7 +489,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash + [files, file_urls, signers, grouped_signers, allow_decline, allow_form_view, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb index ea8f2a943..faaf70ebd 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb @@ -23,7 +23,7 @@ class SignatureRequestEditWithTemplateRequest # @return [Array] attr_accessor :template_ids - # Add Signers to your Templated-based Signature Request. + # _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION # @return [Array] attr_accessor :signers @@ -59,7 +59,7 @@ class SignatureRequestEditWithTemplateRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_get_response.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_get_response.rb index f3195ac50..1f8bba029 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_get_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_get_response.rb @@ -21,7 +21,7 @@ class SignatureRequestGetResponse # @return [SignatureRequestResponse] attr_accessor :signature_request - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_list_response.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_list_response.rb index 48897f6ca..b494d4876 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_list_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_list_response.rb @@ -18,14 +18,14 @@ module Dropbox module Dropbox::Sign class SignatureRequestListResponse - # Contains information about signature requests. + # _t__SignatureRequestListResponse::DESCRIPTION # @return [Array] attr_accessor :signature_requests # @return [ListInfoResponse] attr_accessor :list_info - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response.rb index e8bd41887..f1dd07410 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response.rb @@ -17,105 +17,105 @@ module Dropbox end module Dropbox::Sign - # Contains information about a signature request. + # _t__SignatureRequestResponse::DESCRIPTION class SignatureRequestResponse - # Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. + # _t__SignatureRequestResponse::TEST_MODE # @return [Boolean] attr_accessor :test_mode - # The id of the SignatureRequest. + # _t__SignatureRequestResponse::SIGNATURE_REQUEST_ID # @return [String] attr_accessor :signature_request_id - # The email address of the initiator of the SignatureRequest. + # _t__SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS # @return [String, nil] attr_accessor :requester_email_address - # The title the specified Account uses for the SignatureRequest. + # _t__SignatureRequestResponse::TITLE # @return [String] attr_accessor :title - # Default Label for account. + # _t__SignatureRequestResponse::ORIGINAL_TITLE # @return [String] attr_accessor :original_title - # The subject in the email that was initially sent to the signers. + # _t__SignatureRequestResponse::SUBJECT # @return [String, nil] attr_accessor :subject - # The custom message in the email that was initially sent to the signers. + # _t__SignatureRequestResponse::MESSAGE # @return [String, nil] attr_accessor :message - # The metadata attached to the signature request. + # _t__SignatureRequestResponse::METADATA # @return [Hash] attr_accessor :metadata - # Time the signature request was created. + # _t__SignatureRequestResponse::CREATED_AT # @return [Integer] attr_accessor :created_at - # The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. + # _t__SignatureRequestResponse::EXPIRES_AT # @return [Integer, nil] attr_accessor :expires_at - # Whether or not the SignatureRequest has been fully executed by all signers. + # _t__SignatureRequestResponse::IS_COMPLETE # @return [Boolean] attr_accessor :is_complete - # Whether or not the SignatureRequest has been declined by a signer. + # _t__SignatureRequestResponse::IS_DECLINED # @return [Boolean] attr_accessor :is_declined - # Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). + # _t__SignatureRequestResponse::HAS_ERROR # @return [Boolean] attr_accessor :has_error - # The URL where a copy of the request's documents can be downloaded. + # _t__SignatureRequestResponse::FILES_URL # @return [String] attr_accessor :files_url - # The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. + # _t__SignatureRequestResponse::SIGNING_URL # @return [String, nil] attr_accessor :signing_url - # The URL where the requester and the signers can view the current status of the SignatureRequest. + # _t__SignatureRequestResponse::DETAILS_URL # @return [String] attr_accessor :details_url - # A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. + # _t__SignatureRequestResponse::CC_EMAIL_ADDRESSES # @return [Array] attr_accessor :cc_email_addresses - # The URL you want the signer redirected to after they successfully sign. + # _t__SignatureRequestResponse::SIGNING_REDIRECT_URL # @return [String, nil] attr_accessor :signing_redirect_url - # The path where the completed document can be downloaded + # _t__SignatureRequestResponse::FINAL_COPY_URI # @return [String, nil] attr_accessor :final_copy_uri - # Templates IDs used in this SignatureRequest (if any). + # _t__SignatureRequestResponse::TEMPLATE_IDS # @return [Array, nil] attr_accessor :template_ids - # An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + # _t__SignatureRequestResponseCustomField::DESCRIPTION # @return [Array, nil] attr_accessor :custom_fields - # Signer attachments. + # _t__SignatureRequestResponseAttachment::DESCRIPTION # @return [Array, nil] attr_accessor :attachments - # An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + # _t__SignatureRequestResponseData::DESCRIPTION # @return [Array, nil] attr_accessor :response_data - # An array of signature objects, 1 for each signer. + # _t__SignatureRequestResponseSignatures::DESCRIPTION # @return [Array] attr_accessor :signatures - # The ID of the Bulk Send job which sent the signature request, if applicable. + # _t__SignatureRequestResponse::BULK_SEND_JOB_ID # @return [String, nil] attr_accessor :bulk_send_job_id diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_attachment.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_attachment.rb index 7fb408b25..1dbbb374b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_attachment.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_attachment.rb @@ -17,29 +17,29 @@ module Dropbox end module Dropbox::Sign - # Signer attachments. + # _t__SignatureRequestResponseAttachment::DESCRIPTION class SignatureRequestResponseAttachment - # The unique ID for this attachment. + # _t__SignatureRequestResponseAttachment::ID # @return [String] attr_accessor :id - # The Signer this attachment is assigned to. + # _t__SignatureRequestResponseAttachment::SIGNER # @return [Integer, String] attr_accessor :signer - # The name of this attachment. + # _t__SignatureRequestResponseAttachment::NAME # @return [String] attr_accessor :name - # A boolean value denoting if this attachment is required. + # _t__SignatureRequestResponseAttachment::REQUIRED # @return [Boolean] attr_accessor :required - # Instructions for Signer. + # _t__SignatureRequestResponseAttachment::INSTRUCTIONS # @return [String, nil] attr_accessor :instructions - # Timestamp when attachment was uploaded by Signer. + # _t__SignatureRequestResponseAttachment::UPLOADED_AT # @return [Integer, nil] attr_accessor :uploaded_at diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb index bbf68fb59..41beca564 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb @@ -17,25 +17,25 @@ module Dropbox end module Dropbox::Sign - # An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` + # _t__SignatureRequestResponseCustomField::DESCRIPTION class SignatureRequestResponseCustomFieldBase - # The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + # _t__SignatureRequestResponseCustomField::TYPE # @return [String] attr_accessor :type - # The name of the Custom Field. + # _t__SignatureRequestResponseCustomField::NAME # @return [String] attr_accessor :name - # A boolean value denoting if this field is required. + # _t__SignatureRequestResponseCustomField::REQUIRED # @return [Boolean] attr_accessor :required - # The unique ID for this field. + # _t__SignatureRequestResponseCustomField::API_ID # @return [String] attr_accessor :api_id - # The name of the Role that is able to edit this field. + # _t__SignatureRequestResponseCustomField::EDITOR # @return [String, nil] attr_accessor :editor diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb index c29f4bb15..de90f4870 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # This class extends `SignatureRequestResponseCustomFieldBase`. + # _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS class SignatureRequestResponseCustomFieldCheckbox < SignatureRequestResponseCustomFieldBase - # The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + # _t__SignatureRequestResponseCustomField::TYPE # @return [String] attr_accessor :type - # A true/false for checkbox fields + # _t__SignatureRequestResponseCustomField::VALUE_CHECKBOX # @return [Boolean] attr_accessor :value diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb index 5af516683..fc83995bd 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # This class extends `SignatureRequestResponseCustomFieldBase`. + # _t__SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS class SignatureRequestResponseCustomFieldText < SignatureRequestResponseCustomFieldBase - # The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. + # _t__SignatureRequestResponseCustomField::TYPE # @return [String] attr_accessor :type - # A text string for text fields + # _t__SignatureRequestResponseCustomField::VALUE_TEXT # @return [String] attr_accessor :value diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_base.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_base.rb index 929022017..cee0d66f2 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_base.rb @@ -17,21 +17,21 @@ module Dropbox end module Dropbox::Sign - # An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. + # _t__SignatureRequestResponseData::DESCRIPTION class SignatureRequestResponseDataBase - # The unique ID for this field. + # _t__SignatureRequestResponseData::API_ID # @return [String] attr_accessor :api_id - # The ID of the signature to which this response is linked. + # _t__SignatureRequestResponseData::SIGNATURE_ID # @return [String] attr_accessor :signature_id - # The name of the form field. + # _t__SignatureRequestResponseData::NAME # @return [String] attr_accessor :name - # A boolean value denoting if this field is required. + # _t__SignatureRequestResponseData::REQUIRED # @return [Boolean] attr_accessor :required diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb index 620a25b84..2435be70f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SignatureRequestResponseDataValueCheckbox < SignatureRequestResponseDataBase - # A yes/no checkbox + # _t__SignatureRequestResponseDataValue::CHECKBOX_TYPE # @return [String] attr_accessor :type - # The value of the form field. + # _t__SignatureRequestResponseDataValue::VALUE # @return [Boolean] attr_accessor :value diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb index 8c51b79fc..74557f769 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SignatureRequestResponseDataValueCheckboxMerge < SignatureRequestResponseDataBase - # A checkbox field that has default value set by the api + # _t__SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE # @return [String] attr_accessor :type - # The value of the form field. + # _t__SignatureRequestResponseDataValue::VALUE # @return [String] attr_accessor :value diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb index 27eb89df1..0231a6bc3 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SignatureRequestResponseDataValueDateSigned < SignatureRequestResponseDataBase - # A date + # _t__SignatureRequestResponseDataValue::DATESIGNED_TYPE # @return [String] attr_accessor :type - # The value of the form field. + # _t__SignatureRequestResponseDataValue::VALUE # @return [String] attr_accessor :value diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb index a8c8890fd..95ac49b93 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SignatureRequestResponseDataValueDropdown < SignatureRequestResponseDataBase - # An input field for dropdowns + # _t__SignatureRequestResponseDataValue::DROPDOWN_TYPE # @return [String] attr_accessor :type - # The value of the form field. + # _t__SignatureRequestResponseDataValue::VALUE # @return [String] attr_accessor :value diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb index b3828e4c4..53d19b9bb 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb @@ -18,15 +18,15 @@ module Dropbox module Dropbox::Sign class SignatureRequestResponseDataValueInitials < SignatureRequestResponseDataBase - # An input field for initials + # _t__SignatureRequestResponseDataValue::INITIAL_TYPE # @return [String] attr_accessor :type - # The value of the form field. + # _t__SignatureRequestResponseDataValue::VALUE # @return [String] attr_accessor :value - # This field contains the boolean true if the field is signed. + # _t__SignatureRequestResponseDataValue::IS_SIGNED # @return [Boolean, nil] attr_accessor :is_signed diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb index da06fdd08..502649752 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SignatureRequestResponseDataValueRadio < SignatureRequestResponseDataBase - # An input field for radios + # _t__SignatureRequestResponseDataValue::RADIO_TYPE # @return [String] attr_accessor :type - # The value of the form field. + # _t__SignatureRequestResponseDataValue::VALUE # @return [Boolean] attr_accessor :value diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb index 1d24ea005..fa8f8e723 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb @@ -18,15 +18,15 @@ module Dropbox module Dropbox::Sign class SignatureRequestResponseDataValueSignature < SignatureRequestResponseDataBase - # A signature input field + # _t__SignatureRequestResponseDataValue::SIGNATURE_TYPE # @return [String] attr_accessor :type - # The value of the form field. + # _t__SignatureRequestResponseDataValue::VALUE # @return [String] attr_accessor :value - # This field contains the boolean true if the field is signed. + # _t__SignatureRequestResponseDataValue::IS_SIGNED # @return [Boolean, nil] attr_accessor :is_signed diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_text.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_text.rb index 60ea7d9ed..dcfca4ad9 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_text.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SignatureRequestResponseDataValueText < SignatureRequestResponseDataBase - # A text input field + # _t__SignatureRequestResponseDataValue::TEXT_TYPE # @return [String] attr_accessor :type - # The value of the form field. + # _t__SignatureRequestResponseDataValue::VALUE # @return [String] attr_accessor :value diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb index e78f7d275..b786e66db 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SignatureRequestResponseDataValueTextMerge < SignatureRequestResponseDataBase - # A text field that has default text set by the api + # _t__SignatureRequestResponseDataValue::TEXTMERGE_TYPE # @return [String] attr_accessor :type - # The value of the form field. + # _t__SignatureRequestResponseDataValue::VALUE # @return [String] attr_accessor :value diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_signatures.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_signatures.rb index 99602a22f..5bd771fc8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response_signatures.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response_signatures.rb @@ -17,81 +17,81 @@ module Dropbox end module Dropbox::Sign - # An array of signature objects, 1 for each signer. + # _t__SignatureRequestResponseSignatures::DESCRIPTION class SignatureRequestResponseSignatures - # Signature identifier. + # _t__SignatureRequestResponseSignatures::SIGNATURE_ID # @return [String] attr_accessor :signature_id - # Signer Group GUID + # _t__SignatureRequestResponseSignatures::SIGNER_GROUP_GUID # @return [String, nil] attr_accessor :signer_group_guid - # The email address of the signer. + # _t__SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS # @return [String] attr_accessor :signer_email_address - # The name of the signer. + # _t__SignatureRequestResponseSignatures::SIGNER_NAME # @return [String, nil] attr_accessor :signer_name - # The role of the signer. + # _t__SignatureRequestResponseSignatures::SIGNER_ROLE # @return [String, nil] attr_accessor :signer_role - # If signer order is assigned this is the 0-based index for this signer. + # _t__SignatureRequestResponseSignatures::ORDER # @return [Integer, nil] attr_accessor :order - # The current status of the signature. eg: awaiting_signature, signed, declined. + # _t__SignatureRequestResponseSignatures::STATUS_CODE # @return [String] attr_accessor :status_code - # The reason provided by the signer for declining the request. + # _t__SignatureRequestResponseSignatures::DECLINE_REASON # @return [String, nil] attr_accessor :decline_reason - # Time that the document was signed or null. + # _t__SignatureRequestResponseSignatures::SIGNED_AT # @return [Integer, nil] attr_accessor :signed_at - # The time that the document was last viewed by this signer or null. + # _t__SignatureRequestResponseSignatures::LAST_VIEWED_AT # @return [Integer, nil] attr_accessor :last_viewed_at - # The time the last reminder email was sent to the signer or null. + # _t__SignatureRequestResponseSignatures::LAST_REMINDED_AT # @return [Integer, nil] attr_accessor :last_reminded_at - # Boolean to indicate whether this signature requires a PIN to access. + # _t__SignatureRequestResponseSignatures::HAS_PIN # @return [Boolean] attr_accessor :has_pin - # Boolean to indicate whether this signature has SMS authentication enabled. + # _t__SignatureRequestResponseSignatures::HAS_SMS_AUTH # @return [Boolean, nil] attr_accessor :has_sms_auth - # Boolean to indicate whether this signature has SMS delivery enabled. + # _t__SignatureRequestResponseSignatures::HAS_SMS_DELIVERY # @return [Boolean, nil] attr_accessor :has_sms_delivery - # The SMS phone number used for authentication or signature request delivery. + # _t__SignatureRequestResponseSignatures::SMS_PHONE_NUMBER # @return [String, nil] attr_accessor :sms_phone_number - # Email address of original signer who reassigned to this signer. + # _t__SignatureRequestResponseSignatures::REASSIGNED_BY # @return [String, nil] attr_accessor :reassigned_by - # Reason provided by original signer who reassigned to this signer. + # _t__SignatureRequestResponseSignatures::REASSIGNMENT_REASON # @return [String, nil] attr_accessor :reassignment_reason - # Previous signature identifier. + # _t__SignatureRequestResponseSignatures::REASSIGNED_FROM # @return [String, nil] attr_accessor :reassigned_from - # Error message pertaining to this signer, or null. + # _t__SignatureRequestResponseSignatures::ERROR # @return [String, nil] attr_accessor :error diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb index 1bfe729ab..3f1f8f2c6 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb @@ -26,11 +26,11 @@ class SignatureRequestSendRequest # @return [Array] attr_accessor :file_urls - # Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # _t__Sub::SignatureRequestSigner::DESCRIPTION # @return [Array] attr_accessor :signers - # Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + # _t__Sub::SignatureRequestGroupedSigners::DESCRIPTION # @return [Array] attr_accessor :grouped_signers @@ -42,7 +42,11 @@ class SignatureRequestSendRequest # @return [Boolean] attr_accessor :allow_reassign - # A list describing the attachments + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + + # _t__SubAttachment::LIST_DESCRIPTION # @return [Array] attr_accessor :attachments @@ -89,7 +93,7 @@ class SignatureRequestSendRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata @@ -129,6 +133,7 @@ def self.attribute_map :'grouped_signers' => :'grouped_signers', :'allow_decline' => :'allow_decline', :'allow_reassign' => :'allow_reassign', + :'allow_form_view' => :'allow_form_view', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', :'client_id' => :'client_id', @@ -171,6 +176,7 @@ def self.openapi_types :'grouped_signers' => :'Array', :'allow_decline' => :'Boolean', :'allow_reassign' => :'Boolean', + :'allow_form_view' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', :'client_id' => :'String', @@ -278,6 +284,12 @@ def initialize(attributes = {}) self.allow_reassign = false end + if attributes.key?(:'allow_form_view') + self.allow_form_view = attributes[:'allow_form_view'] + else + self.allow_form_view = false + end + if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value @@ -458,6 +470,7 @@ def ==(o) grouped_signers == o.grouped_signers && allow_decline == o.allow_decline && allow_reassign == o.allow_reassign && + allow_form_view == o.allow_form_view && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && client_id == o.client_id && @@ -489,7 +502,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash + [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, allow_form_view, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb index ac2647256..d3b116891 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb @@ -23,7 +23,7 @@ class SignatureRequestSendWithTemplateRequest # @return [Array] attr_accessor :template_ids - # Add Signers to your Templated-based Signature Request. + # _t__Sub::SignatureRequestTemplateSigner::DESCRIPTION # @return [Array] attr_accessor :signers @@ -63,7 +63,7 @@ class SignatureRequestSendWithTemplateRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb b/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb index ee41c08a0..a99b9f33f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb @@ -42,15 +42,15 @@ class SubFormFieldsPerDocumentBase # @return [String] attr_accessor :type - # Size of the field in pixels. + # _t__Sub::FormFieldsPerDocument::WIDTH # @return [Integer] attr_accessor :width - # Location coordinates of the field in pixels. + # _t__Sub::FormFieldsPerDocument::X # @return [Integer] attr_accessor :x - # Location coordinates of the field in pixels. + # _t__Sub::FormFieldsPerDocument::Y # @return [Integer] attr_accessor :y diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb b/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb index 167b7f0b5..698c38a62 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb @@ -39,7 +39,7 @@ class SubFormFieldsPerDocumentText < SubFormFieldsPerDocumentBase # @return [Boolean] attr_accessor :masked - # Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. + # _t__Sub::FormFieldsPerDocument::VALIDATION_TYPE # @return [String] attr_accessor :validation_type diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb b/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb index edab85f0c..044e9b892 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb @@ -19,7 +19,7 @@ module Dropbox module Dropbox::Sign # This class extends `SubFormFieldsPerDocumentBase`. class SubFormFieldsPerDocumentTextMerge < SubFormFieldsPerDocumentBase - # A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. + # _t__Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_merge_field.rb b/sdks/ruby/lib/dropbox-sign/models/sub_merge_field.rb index b894cf9e8..a79c074ee 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_merge_field.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_merge_field.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SubMergeField - # The name of the merge field. Must be unique. + # _t__Sub::MergeField::NAME # @return [String] attr_accessor :name - # The type of merge field. + # _t__Sub::MergeField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_o_auth.rb b/sdks/ruby/lib/dropbox-sign/models/sub_o_auth.rb index ca6b55bf2..40cf8e517 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_o_auth.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_o_auth.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # OAuth related parameters. + # _t__Sub::OAuth::DESCRIPTION class SubOAuth - # The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) + # _t__Sub::OAuth::CALLBACK_URL # @return [String] attr_accessor :callback_url - # A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). + # _t__Sub::OAuth::SCOPES # @return [Array] attr_accessor :scopes diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_options.rb b/sdks/ruby/lib/dropbox-sign/models/sub_options.rb index a2f2df245..0e3068619 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_options.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # Additional options supported by API App. + # _t__Sub::Options::DESCRIPTION class SubOptions - # Determines if signers can use \"Insert Everywhere\" when signing a document. + # _t__Sub::Options::CAN_INSERT_EVERYWHERE # @return [Boolean] attr_accessor :can_insert_everywhere diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb b/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb index 23615d577..8507eb1ba 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb @@ -18,15 +18,15 @@ module Dropbox module Dropbox::Sign class SubSignatureRequestGroupedSigners - # The name of the group. + # _t__Sub::SignatureRequestGroupedSigners::GROUP_NAME # @return [String] attr_accessor :group - # 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. + # _t__Sub::SignatureRequestGroupedSigners::SIGNERS # @return [Array] attr_accessor :signers - # The order the group is required to sign in. Use this instead of Signer-level `order`. + # _t__Sub::SignatureRequestGroupedSigners::ORDER # @return [Integer, nil] attr_accessor :order diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_signer.rb b/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_signer.rb index 2a4eaed72..0c7029131 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_signer.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_signer.rb @@ -18,27 +18,27 @@ module Dropbox module Dropbox::Sign class SubSignatureRequestSigner - # The name of the signer. + # _t__Sub::SignatureRequestSigner::SIGNER_NAME # @return [String] attr_accessor :name - # The email address of the signer. + # _t__Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS # @return [String] attr_accessor :email_address - # The order the signer is required to sign in. + # _t__Sub::SignatureRequestSigner::SIGNER_ORDER # @return [Integer, nil] attr_accessor :order - # The 4- to 12-character access code that will secure this signer's signature page. + # _t__Sub::SignatureRequestSigner::SIGNER_PIN # @return [String] attr_accessor :pin - # An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + # _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER # @return [String] attr_accessor :sms_phone_number - # Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + # _t__Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE # @return [String] attr_accessor :sms_phone_number_type diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_template_signer.rb b/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_template_signer.rb index eb52b71ba..472859861 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_signature_request_template_signer.rb @@ -18,27 +18,27 @@ module Dropbox module Dropbox::Sign class SubSignatureRequestTemplateSigner - # Must match an existing role in chosen Template(s). It's case-sensitive. + # _t__Sub::SignatureRequestTemplateSigner::ROLE # @return [String] attr_accessor :role - # The name of the signer. + # _t__Sub::SignatureRequestTemplateSigner::NAME # @return [String] attr_accessor :name - # The email address of the signer. + # _t__Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS # @return [String] attr_accessor :email_address - # The 4- to 12-character access code that will secure this signer's signature page. + # _t__Sub::SignatureRequestTemplateSigner::PIN # @return [String] attr_accessor :pin - # An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). **NOTE:** Not available in test mode and requires a Standard plan or higher. + # _t__Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER # @return [String] attr_accessor :sms_phone_number - # Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). + # _t__Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE # @return [String] attr_accessor :sms_phone_number_type diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_signing_options.rb b/sdks/ruby/lib/dropbox-sign/models/sub_signing_options.rb index 26a6406f7..3b9db9f4b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_signing_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_signing_options.rb @@ -17,25 +17,25 @@ module Dropbox end module Dropbox::Sign - # This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + # _t__Sub::SigningOptions::DESCRIPTION class SubSigningOptions - # The default type shown (limited to the listed types) + # _t__Sub::SigningOptions::DEFAULT # @return [String] attr_accessor :default_type - # Allows drawing the signature + # _t__Sub::SigningOptions::DRAW # @return [Boolean] attr_accessor :draw - # Allows using a smartphone to email the signature + # _t__Sub::SigningOptions::PHONE # @return [Boolean] attr_accessor :phone - # Allows typing the signature + # _t__Sub::SigningOptions::TYPE # @return [Boolean] attr_accessor :type - # Allows uploading the signature + # _t__Sub::SigningOptions::UPLOAD # @return [Boolean] attr_accessor :upload diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_team_response.rb b/sdks/ruby/lib/dropbox-sign/models/sub_team_response.rb index 7ee4be8fc..d76cd33a5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_team_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_team_response.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SubTeamResponse - # The id of a team + # _t__TeamGeneral::TEAM_ID # @return [String] attr_accessor :team_id - # The name of a team + # _t__TeamGeneral::NAME # @return [String] attr_accessor :name diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_template_role.rb b/sdks/ruby/lib/dropbox-sign/models/sub_template_role.rb index ff16168ac..f09260d53 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_template_role.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_template_role.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class SubTemplateRole - # The role name of the signer that will be displayed when the template is used to create a signature request. + # _t__Sub::SignerRole::NAME # @return [String] attr_accessor :name - # The order in which this signer role is required to sign. + # _t__Sub::SignerRole::ORDER # @return [Integer, nil] attr_accessor :order diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb b/sdks/ruby/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb index f77ddb142..5acc8597b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb @@ -18,15 +18,15 @@ module Dropbox module Dropbox::Sign class SubUnclaimedDraftSigner - # The email address of the signer. + # _t__Sub::UnclaimedDraftSigner::EMAIL_ADDRESS # @return [String] attr_accessor :email_address - # The name of the signer. + # _t__Sub::UnclaimedDraftSigner::NAME # @return [String] attr_accessor :name - # The order the signer is required to sign in. + # _t__Sub::UnclaimedDraftSigner::ORDER # @return [Integer, nil] attr_accessor :order diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb b/sdks/ruby/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb index 61fe5d8c5..6c4c5de5d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb @@ -18,15 +18,15 @@ module Dropbox module Dropbox::Sign class SubUnclaimedDraftTemplateSigner - # Must match an existing role in chosen Template(s). + # _t__Sub::UnclaimedDraftTemplateSigner::ROLE # @return [String] attr_accessor :role - # The name of the signer filling the role of `role`. + # _t__Sub::UnclaimedDraftTemplateSigner::NAME # @return [String] attr_accessor :name - # The email address of the signer filling the role of `role`. + # _t__Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS # @return [String] attr_accessor :email_address diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_white_labeling_options.rb b/sdks/ruby/lib/dropbox-sign/models/sub_white_labeling_options.rb index 0878b3d71..c90787ff0 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_white_labeling_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_white_labeling_options.rb @@ -17,7 +17,7 @@ module Dropbox end module Dropbox::Sign - # An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. + # _t__Sub::WhiteLabelingOptions::DESCRIPTION class SubWhiteLabelingOptions # @return [String] attr_accessor :header_background_color @@ -61,7 +61,7 @@ class SubWhiteLabelingOptions # @return [String] attr_accessor :text_color2 - # Resets white labeling options to defaults. Only useful when updating an API App. + # _t__Sub::WhiteLabelingOptions::RESET_TO_DEFAULT # @return [Boolean] attr_accessor :reset_to_default diff --git a/sdks/ruby/lib/dropbox-sign/models/team_get_info_response.rb b/sdks/ruby/lib/dropbox-sign/models/team_get_info_response.rb index 6dda33ae5..156f80508 100644 --- a/sdks/ruby/lib/dropbox-sign/models/team_get_info_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/team_get_info_response.rb @@ -21,7 +21,7 @@ class TeamGetInfoResponse # @return [TeamInfoResponse] attr_accessor :team - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/team_get_response.rb b/sdks/ruby/lib/dropbox-sign/models/team_get_response.rb index 50c0ac70e..c610006c4 100644 --- a/sdks/ruby/lib/dropbox-sign/models/team_get_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/team_get_response.rb @@ -21,7 +21,7 @@ class TeamGetResponse # @return [TeamResponse] attr_accessor :team - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/team_info_response.rb b/sdks/ruby/lib/dropbox-sign/models/team_info_response.rb index 5231ddfe8..b4faec1b7 100644 --- a/sdks/ruby/lib/dropbox-sign/models/team_info_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/team_info_response.rb @@ -18,22 +18,22 @@ module Dropbox module Dropbox::Sign class TeamInfoResponse - # The id of a team + # _t__TeamGeneral::TEAM_ID # @return [String] attr_accessor :team_id # @return [TeamParentResponse, nil] attr_accessor :team_parent - # The name of a team + # _t__TeamGeneral::NAME # @return [String] attr_accessor :name - # Number of members within a team + # _t__TeamGeneral::NUM_MEMBERS # @return [Integer] attr_accessor :num_members - # Number of sub teams within a team + # _t__TeamGeneral::NUM_SUB_TEAMS # @return [Integer] attr_accessor :num_sub_teams diff --git a/sdks/ruby/lib/dropbox-sign/models/team_parent_response.rb b/sdks/ruby/lib/dropbox-sign/models/team_parent_response.rb index 48cf5f159..dcb51af6f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/team_parent_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/team_parent_response.rb @@ -19,11 +19,11 @@ module Dropbox module Dropbox::Sign # Information about the parent team if a team has one, set to `null` otherwise. class TeamParentResponse - # The id of a team + # _t__TeamGeneral::TEAM_ID # @return [String] attr_accessor :team_id - # The name of a team + # _t__TeamGeneral::NAME # @return [String] attr_accessor :name diff --git a/sdks/ruby/lib/dropbox-sign/models/team_response.rb b/sdks/ruby/lib/dropbox-sign/models/team_response.rb index c239735dd..c4c2f82e3 100644 --- a/sdks/ruby/lib/dropbox-sign/models/team_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/team_response.rb @@ -17,20 +17,20 @@ module Dropbox end module Dropbox::Sign - # Contains information about your team and its members + # _t__TeamResponse::DESCRIPTION class TeamResponse - # The name of your Team + # _t__Team::NAME # @return [String] attr_accessor :name # @return [Array] attr_accessor :accounts - # 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`. + # _t__Team::INVITED_ACCOUNTS # @return [Array] attr_accessor :invited_accounts - # A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. + # _t__Team::INVITED_EMAILS # @return [Array] attr_accessor :invited_emails diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb index 4b006bdac..3a989a0d9 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb @@ -38,7 +38,11 @@ class TemplateCreateEmbeddedDraftRequest # @return [Boolean] attr_accessor :allow_reassign - # A list describing the attachments + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + + # _t__SubAttachment::LIST_DESCRIPTION # @return [Array] attr_accessor :attachments @@ -80,7 +84,7 @@ class TemplateCreateEmbeddedDraftRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata @@ -124,6 +128,7 @@ def self.attribute_map :'file_urls' => :'file_urls', :'allow_ccs' => :'allow_ccs', :'allow_reassign' => :'allow_reassign', + :'allow_form_view' => :'allow_form_view', :'attachments' => :'attachments', :'cc_roles' => :'cc_roles', :'editor_options' => :'editor_options', @@ -165,6 +170,7 @@ def self.openapi_types :'file_urls' => :'Array', :'allow_ccs' => :'Boolean', :'allow_reassign' => :'Boolean', + :'allow_form_view' => :'Boolean', :'attachments' => :'Array', :'cc_roles' => :'Array', :'editor_options' => :'SubEditorOptions', @@ -263,6 +269,12 @@ def initialize(attributes = {}) self.allow_reassign = false end + if attributes.key?(:'allow_form_view') + self.allow_form_view = attributes[:'allow_form_view'] + else + self.allow_form_view = false + end + if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value @@ -448,6 +460,7 @@ def ==(o) file_urls == o.file_urls && allow_ccs == o.allow_ccs && allow_reassign == o.allow_reassign && + allow_form_view == o.allow_form_view && attachments == o.attachments && cc_roles == o.cc_roles && editor_options == o.editor_options && @@ -479,7 +492,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, files, file_urls, allow_ccs, allow_reassign, attachments, cc_roles, editor_options, field_options, force_signer_roles, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, merge_fields, message, metadata, show_preview, show_progress_stepper, signer_roles, skip_me_now, subject, test_mode, title, use_preexisting_fields].hash + [client_id, files, file_urls, allow_ccs, allow_reassign, allow_form_view, attachments, cc_roles, editor_options, field_options, force_signer_roles, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, merge_fields, message, metadata, show_preview, show_progress_stepper, signer_roles, skip_me_now, subject, test_mode, title, use_preexisting_fields].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response.rb index 540a70012..0ebbf6b0c 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response.rb @@ -21,7 +21,7 @@ class TemplateCreateEmbeddedDraftResponse # @return [TemplateCreateEmbeddedDraftResponseTemplate] attr_accessor :template - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb index 354ad0df0..1ea8f99eb 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb @@ -17,21 +17,21 @@ module Dropbox end module Dropbox::Sign - # Template object with parameters: `template_id`, `edit_url`, `expires_at`. + # _t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION class TemplateCreateEmbeddedDraftResponseTemplate - # The id of the Template. + # _t__TemplateResponse::TEMPLATE_ID # @return [String] attr_accessor :template_id - # Link to edit the template. + # _t__TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL # @return [String] attr_accessor :edit_url - # When the link expires. + # _t__TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT # @return [Integer] attr_accessor :expires_at - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb index 2376b7867..bf937d736 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb @@ -38,7 +38,11 @@ class TemplateCreateRequest # @return [Boolean] attr_accessor :allow_reassign - # A list describing the attachments + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + + # _t__SubAttachment::LIST_DESCRIPTION # @return [Array] attr_accessor :attachments @@ -69,7 +73,7 @@ class TemplateCreateRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata @@ -97,6 +101,7 @@ def self.attribute_map :'files' => :'files', :'file_urls' => :'file_urls', :'allow_reassign' => :'allow_reassign', + :'allow_form_view' => :'allow_form_view', :'attachments' => :'attachments', :'cc_roles' => :'cc_roles', :'client_id' => :'client_id', @@ -131,6 +136,7 @@ def self.openapi_types :'files' => :'Array', :'file_urls' => :'Array', :'allow_reassign' => :'Boolean', + :'allow_form_view' => :'Boolean', :'attachments' => :'Array', :'cc_roles' => :'Array', :'client_id' => :'String', @@ -224,6 +230,12 @@ def initialize(attributes = {}) self.allow_reassign = false end + if attributes.key?(:'allow_form_view') + self.allow_form_view = attributes[:'allow_form_view'] + else + self.allow_form_view = false + end + if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value @@ -382,6 +394,7 @@ def ==(o) files == o.files && file_urls == o.file_urls && allow_reassign == o.allow_reassign && + allow_form_view == o.allow_form_view && attachments == o.attachments && cc_roles == o.cc_roles && client_id == o.client_id && @@ -406,7 +419,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [form_fields_per_document, signer_roles, files, file_urls, allow_reassign, attachments, cc_roles, client_id, field_options, form_field_groups, form_field_rules, merge_fields, message, metadata, subject, test_mode, title, use_preexisting_fields].hash + [form_fields_per_document, signer_roles, files, file_urls, allow_reassign, allow_form_view, attachments, cc_roles, client_id, field_options, form_field_groups, form_field_rules, merge_fields, message, metadata, subject, test_mode, title, use_preexisting_fields].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_response.rb index 5ca1bcb85..f4d1b859d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_response.rb @@ -21,7 +21,7 @@ class TemplateCreateResponse # @return [TemplateCreateResponseTemplate] attr_accessor :template - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb index 1ffeb1092..e4da232a8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # Template object with parameters: `template_id`. + # _t__TemplateCreateResponseTemplate::DESCRIPTION class TemplateCreateResponseTemplate - # The id of the Template. + # _t__TemplateResponse::TEMPLATE_ID # @return [String] attr_accessor :template_id diff --git a/sdks/ruby/lib/dropbox-sign/models/template_edit_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_edit_response.rb index 9a4996745..107a838b8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_edit_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_edit_response.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class TemplateEditResponse - # The id of the Template. + # _t__TemplateResponse::TEMPLATE_ID # @return [String] attr_accessor :template_id diff --git a/sdks/ruby/lib/dropbox-sign/models/template_get_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_get_response.rb index dcbc14b67..4f0dc636b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_get_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_get_response.rb @@ -21,7 +21,7 @@ class TemplateGetResponse # @return [TemplateResponse] attr_accessor :template - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/template_list_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_list_response.rb index aea5a64df..16ebde6a0 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_list_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_list_response.rb @@ -18,14 +18,14 @@ module Dropbox module Dropbox::Sign class TemplateListResponse - # List of templates that the API caller has access to. + # _t__TemplateListResponse::DESCRIPTION # @return [Array] attr_accessor :templates # @return [ListInfoResponse] attr_accessor :list_info - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_response.rb index fdf944631..e35bf2e55 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response.rb @@ -17,69 +17,69 @@ module Dropbox end module Dropbox::Sign - # Contains information about the templates you and your team have created. + # _t__TemplateResponse::DESCRIPTION class TemplateResponse - # The id of the Template. + # _t__TemplateResponse::TEMPLATE_ID # @return [String] attr_accessor :template_id - # The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + # _t__TemplateResponse::TITLE # @return [String] attr_accessor :title - # The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + # _t__TemplateResponse::MESSAGE # @return [String] attr_accessor :message - # Time the template was last updated. + # _t__TemplateResponse::UPDATED_AT # @return [Integer] attr_accessor :updated_at - # `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. + # _t__TemplateResponse::IS_EMBEDDED # @return [Boolean, nil] attr_accessor :is_embedded - # `true` if you are the owner of this template, `false` if it's been shared with you by a team member. + # _t__TemplateResponse::IS_CREATOR # @return [Boolean] attr_accessor :is_creator - # Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). + # _t__TemplateResponse::CAN_EDIT # @return [Boolean] attr_accessor :can_edit - # Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + # _t__TemplateResponse::IS_LOCKED # @return [Boolean] attr_accessor :is_locked - # The metadata attached to the template. + # _t__TemplateResponse::METADATA # @return [Hash] attr_accessor :metadata - # An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + # _t__TemplateResponse::SIGNER_ROLES # @return [Array] attr_accessor :signer_roles - # An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + # _t__TemplateResponse::CC_ROLES # @return [Array] attr_accessor :cc_roles - # An array describing each document associated with this Template. Includes form field data for each document. + # _t__TemplateResponse::DOCUMENTS # @return [Array] attr_accessor :documents - # Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + # _t__TemplateResponseCustomField::DESCRIPTION # @return [Array, nil] attr_accessor :custom_fields - # Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. + # _t__TemplateResponseNamedFormField::DESCRIPTION # @return [Array, nil] attr_accessor :named_form_fields - # An array of the Accounts that can use this Template. + # _t__TemplateResponse::ACCOUNTS # @return [Array] attr_accessor :accounts - # Signer attachments. + # _t__SignatureRequestResponseAttachment::DESCRIPTION # @return [Array] attr_accessor :attachments diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb index 9bdf49e69..e8e4b8ff5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb @@ -18,23 +18,23 @@ module Dropbox module Dropbox::Sign class TemplateResponseAccount - # The id of the Account. + # _t__TemplateResponseAccount::ACCOUNT_ID # @return [String] attr_accessor :account_id - # The email address associated with the Account. + # _t__TemplateResponseAccount::EMAIL_ADDRESS # @return [String] attr_accessor :email_address - # Returns `true` if the user has been locked out of their account by a team admin. + # _t__TemplateResponseAccount::IS_LOCKED # @return [Boolean] attr_accessor :is_locked - # Returns `true` if the user has a paid Dropbox Sign account. + # _t__TemplateResponseAccount::IS_PAID_HS # @return [Boolean] attr_accessor :is_paid_hs - # Returns `true` if the user has a paid HelloFax account. + # _t__TemplateResponseAccount::IS_PAID_HF # @return [Boolean] attr_accessor :is_paid_hf diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb index d8631da5c..1da5460a8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb @@ -17,21 +17,21 @@ module Dropbox end module Dropbox::Sign - # An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + # _t__TemplateResponseAccountQuota::DESCRIPTION class TemplateResponseAccountQuota - # API templates remaining. + # _t__TemplateResponseAccountQuota::TEMPLATES_LEFT # @return [Integer] attr_accessor :templates_left - # API signature requests remaining. + # _t__TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT # @return [Integer] attr_accessor :api_signature_requests_left - # Signature requests remaining. + # _t__TemplateResponseAccountQuota::DOCUMENTS_LEFT # @return [Integer] attr_accessor :documents_left - # SMS verifications remaining. + # _t__TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT # @return [Integer] attr_accessor :sms_verifications_left diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb index a5cf632bf..bf8fe74da 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class TemplateResponseCCRole - # The name of the Role. + # _t__TemplateResponseCCRole::NAME # @return [String] attr_accessor :name diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb index 2c0f02d5f..d66d1365e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb @@ -18,27 +18,27 @@ module Dropbox module Dropbox::Sign class TemplateResponseDocument - # Name of the associated file. + # _t__TemplateResponseDocument::NAME # @return [String] attr_accessor :name - # Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + # _t__TemplateResponseDocument::INDEX # @return [Integer] attr_accessor :index - # An array of Form Field Group objects. + # _t__TemplateResponseDocument::FIELD_GROUPS # @return [Array] attr_accessor :field_groups - # An array of Form Field objects containing the name and type of each named field. + # _t__TemplateResponseDocumentFormField::DESCRIPTION # @return [Array] attr_accessor :form_fields - # An array of Form Field objects containing the name and type of each named field. + # _t__TemplateResponseDocumentCustomField::DESCRIPTION # @return [Array] attr_accessor :custom_fields - # An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + # _t__TemplateResponseDocumentStaticField::DESCRIPTION # @return [Array] attr_accessor :static_fields diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb index 6ad8697d5..075f5e4a5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb @@ -17,44 +17,44 @@ module Dropbox end module Dropbox::Sign - # An array of Form Field objects containing the name and type of each named field. + # _t__TemplateResponseDocumentCustomField::DESCRIPTION class TemplateResponseDocumentCustomFieldBase # @return [String] attr_accessor :type - # The unique ID for this field. + # _t__TemplateResponseDocumentCustomField::API_ID # @return [String] attr_accessor :api_id - # The name of the Custom Field. + # _t__TemplateResponseDocumentCustomField::NAME # @return [String] attr_accessor :name - # The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + # _t__TemplateResponseDocumentCustomField::SIGNER # @return [Integer, String, nil] attr_accessor :signer - # The horizontal offset in pixels for this form field. + # _t__TemplateResponseDocumentCustomField::X # @return [Integer] attr_accessor :x - # The vertical offset in pixels for this form field. + # _t__TemplateResponseDocumentCustomField::Y # @return [Integer] attr_accessor :y - # The width in pixels of this form field. + # _t__TemplateResponseDocumentCustomField::WIDTH # @return [Integer] attr_accessor :width - # The height in pixels of this form field. + # _t__TemplateResponseDocumentCustomField::HEIGHT # @return [Integer] attr_accessor :height - # Boolean showing whether or not this field is required. + # _t__TemplateResponseDocumentStaticField::REQUIRED # @return [Boolean] attr_accessor :required - # The name of the group this field is in. If this field is not a group, this defaults to `null`. + # _t__TemplateResponseDocumentCustomField::GROUP # @return [String, nil] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb index 0f4f3402b..b67f96895 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentCustomFieldBase` + # _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS class TemplateResponseDocumentCustomFieldCheckbox < TemplateResponseDocumentCustomFieldBase - # The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + # _t__TemplateResponseDocumentCustomField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb index 7799d711e..6033a3ab5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb @@ -17,24 +17,24 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentCustomFieldBase` + # _t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS class TemplateResponseDocumentCustomFieldText < TemplateResponseDocumentCustomFieldBase - # The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` + # _t__TemplateResponseDocumentCustomField::TYPE # @return [String] attr_accessor :type # @return [TemplateResponseFieldAvgTextLength] attr_accessor :avg_text_length - # Whether this form field is multiline text. + # _t__TemplateResponseDocumentCustomField::IS_MULTILINE # @return [Boolean] attr_accessor :is_multiline - # Original font size used in this form field's text. + # _t__TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE # @return [Integer] attr_accessor :original_font_size - # Font family used in this form field's text. + # _t__TemplateResponseDocumentCustomField::FONT_FAMILY # @return [String] attr_accessor :font_family diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb index c879c28f0..3056f9fe5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class TemplateResponseDocumentFieldGroup - # The name of the form field group. + # _t__TemplateResponseDocumentFieldGroup::NAME # @return [String] attr_accessor :name diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb index e80370faa..2801f8650 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). + # _t__TemplateResponseDocumentFieldGroup::RULE class TemplateResponseDocumentFieldGroupRule - # 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. + # _t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT # @return [String] attr_accessor :requirement - # Name of the group + # _t__TemplateResponseDocumentFieldGroupRule::GROUP_LABEL # @return [String] attr_accessor :group_label diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb index 4676fd1e0..9a4ccd4c6 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb @@ -17,40 +17,40 @@ module Dropbox end module Dropbox::Sign - # An array of Form Field objects containing the name and type of each named field. + # _t__TemplateResponseDocumentFormField::DESCRIPTION class TemplateResponseDocumentFormFieldBase # @return [String] attr_accessor :type - # A unique id for the form field. + # _t__TemplateResponseDocumentFormField::API_ID # @return [String] attr_accessor :api_id - # The name of the form field. + # _t__TemplateResponseDocumentFormField::NAME # @return [String] attr_accessor :name - # The signer of the Form Field. + # _t__TemplateResponseDocumentFormField::SIGNER # @return [Integer, String] attr_accessor :signer - # The horizontal offset in pixels for this form field. + # _t__TemplateResponseDocumentFormField::X # @return [Integer] attr_accessor :x - # The vertical offset in pixels for this form field. + # _t__TemplateResponseDocumentFormField::Y # @return [Integer] attr_accessor :y - # The width in pixels of this form field. + # _t__TemplateResponseDocumentFormField::WIDTH # @return [Integer] attr_accessor :width - # The height in pixels of this form field. + # _t__TemplateResponseDocumentFormField::HEIGHT # @return [Integer] attr_accessor :height - # Boolean showing whether or not this field is required. + # _t__TemplateResponseDocumentFormField::REQUIRED # @return [Boolean] attr_accessor :required diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb index 628758f5f..de5d5f4ec 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentFormFieldBase` + # _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS class TemplateResponseDocumentFormFieldCheckbox < TemplateResponseDocumentFormFieldBase - # The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + # _t__TemplateResponseDocumentFormField::TYPE # @return [String] attr_accessor :type - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # _t__TemplateResponseDocumentFormField::GROUP # @return [String, nil] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb index 268700045..b39f72327 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentFormFieldBase` + # _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS class TemplateResponseDocumentFormFieldDateSigned < TemplateResponseDocumentFormFieldBase - # The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + # _t__TemplateResponseDocumentFormField::TYPE # @return [String] attr_accessor :type - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # _t__TemplateResponseDocumentFormField::GROUP # @return [String, nil] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb index 3d6e664e9..152bc70e6 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentFormFieldBase` + # _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS class TemplateResponseDocumentFormFieldDropdown < TemplateResponseDocumentFormFieldBase - # The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + # _t__TemplateResponseDocumentFormField::TYPE # @return [String] attr_accessor :type - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # _t__TemplateResponseDocumentFormField::GROUP # @return [String, nil] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb index 579494f1a..90f52cdb3 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb @@ -17,28 +17,28 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentFormFieldBase` + # _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS class TemplateResponseDocumentFormFieldHyperlink < TemplateResponseDocumentFormFieldBase - # The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + # _t__TemplateResponseDocumentFormField::TYPE # @return [String] attr_accessor :type # @return [TemplateResponseFieldAvgTextLength] attr_accessor :avg_text_length - # Whether this form field is multiline text. + # _t__TemplateResponseDocumentFormField::IS_MULTILINE # @return [Boolean] attr_accessor :is_multiline - # Original font size used in this form field's text. + # _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE # @return [Integer] attr_accessor :original_font_size - # Font family used in this form field's text. + # _t__TemplateResponseDocumentFormField::FONT_FAMILY # @return [String] attr_accessor :font_family - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # _t__TemplateResponseDocumentFormField::GROUP # @return [String, nil] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb index 961155290..0b34c8f8e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentFormFieldBase` + # _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS class TemplateResponseDocumentFormFieldInitials < TemplateResponseDocumentFormFieldBase - # The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + # _t__TemplateResponseDocumentFormField::TYPE # @return [String] attr_accessor :type - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # _t__TemplateResponseDocumentFormField::GROUP # @return [String, nil] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb index 6e99534d7..52860a8b0 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentFormFieldBase` + # _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS class TemplateResponseDocumentFormFieldRadio < TemplateResponseDocumentFormFieldBase - # The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + # _t__TemplateResponseDocumentFormField::TYPE # @return [String] attr_accessor :type - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # _t__TemplateResponseDocumentFormField::GROUP # @return [String] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb index dcfed475e..37b5c5abc 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentFormFieldBase` + # _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS class TemplateResponseDocumentFormFieldSignature < TemplateResponseDocumentFormFieldBase - # The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + # _t__TemplateResponseDocumentFormField::TYPE # @return [String] attr_accessor :type - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # _t__TemplateResponseDocumentFormField::GROUP # @return [String, nil] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb index 11d6178bb..97df0daa1 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb @@ -17,40 +17,40 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentFormFieldBase` + # _t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS class TemplateResponseDocumentFormFieldText < TemplateResponseDocumentFormFieldBase - # The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` + # _t__TemplateResponseDocumentFormField::TYPE # @return [String] attr_accessor :type # @return [TemplateResponseFieldAvgTextLength] attr_accessor :avg_text_length - # Whether this form field is multiline text. + # _t__TemplateResponseDocumentFormField::IS_MULTILINE # @return [Boolean] attr_accessor :is_multiline - # Original font size used in this form field's text. + # _t__TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE # @return [Integer] attr_accessor :original_font_size - # Font family used in this form field's text. + # _t__TemplateResponseDocumentFormField::FONT_FAMILY # @return [String] attr_accessor :font_family - # Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. + # _t__TemplateResponseDocumentFormField::VALIDATION_TYPE # @return [String, nil] attr_accessor :validation_type - # When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. + # _t__TemplateResponseDocumentFormField::CUSTOM_REGEX # @return [String, nil] attr_accessor :validation_custom_regex - # When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. + # _t__TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL # @return [String, nil] attr_accessor :validation_custom_regex_format_label - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # _t__TemplateResponseDocumentFormField::GROUP # @return [String, nil] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb index 89606c7b9..b37264f47 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb @@ -17,44 +17,44 @@ module Dropbox end module Dropbox::Sign - # An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + # _t__TemplateResponseDocumentStaticField::DESCRIPTION class TemplateResponseDocumentStaticFieldBase # @return [String] attr_accessor :type - # A unique id for the static field. + # _t__TemplateResponseDocumentStaticField::API_ID # @return [String] attr_accessor :api_id - # The name of the static field. + # _t__TemplateResponseDocumentStaticField::NAME # @return [String] attr_accessor :name - # The signer of the Static Field. + # _t__TemplateResponseDocumentStaticField::SIGNER # @return [String] attr_accessor :signer - # The horizontal offset in pixels for this static field. + # _t__TemplateResponseDocumentStaticField::X # @return [Integer] attr_accessor :x - # The vertical offset in pixels for this static field. + # _t__TemplateResponseDocumentStaticField::Y # @return [Integer] attr_accessor :y - # The width in pixels of this static field. + # _t__TemplateResponseDocumentStaticField::WIDTH # @return [Integer] attr_accessor :width - # The height in pixels of this static field. + # _t__TemplateResponseDocumentStaticField::HEIGHT # @return [Integer] attr_accessor :height - # Boolean showing whether or not this field is required. + # _t__TemplateResponseDocumentStaticField::REQUIRED # @return [Boolean] attr_accessor :required - # The name of the group this field is in. If this field is not a group, this defaults to `null`. + # _t__TemplateResponseDocumentStaticField::GROUP # @return [String, nil] attr_accessor :group diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb index e27917fb4..cc1e519cf 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentStaticFieldBase` + # _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS class TemplateResponseDocumentStaticFieldCheckbox < TemplateResponseDocumentStaticFieldBase - # The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + # _t__TemplateResponseDocumentStaticField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb index 574e05234..f17c2865c 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentStaticFieldBase` + # _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS class TemplateResponseDocumentStaticFieldDateSigned < TemplateResponseDocumentStaticFieldBase - # The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + # _t__TemplateResponseDocumentStaticField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb index 7c14f58b5..d9aa055d7 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentStaticFieldBase` + # _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS class TemplateResponseDocumentStaticFieldDropdown < TemplateResponseDocumentStaticFieldBase - # The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + # _t__TemplateResponseDocumentStaticField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb index ccb172773..f3abd234e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentStaticFieldBase` + # _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS class TemplateResponseDocumentStaticFieldHyperlink < TemplateResponseDocumentStaticFieldBase - # The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + # _t__TemplateResponseDocumentStaticField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_initials.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_initials.rb index 47d8b723e..8b8f2bac5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_initials.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentStaticFieldBase` + # _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS class TemplateResponseDocumentStaticFieldInitials < TemplateResponseDocumentStaticFieldBase - # The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + # _t__TemplateResponseDocumentStaticField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_radio.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_radio.rb index b8299053e..a7efd0ff0 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_radio.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentStaticFieldBase` + # _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS class TemplateResponseDocumentStaticFieldRadio < TemplateResponseDocumentStaticFieldBase - # The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + # _t__TemplateResponseDocumentStaticField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_signature.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_signature.rb index 91c019255..3b5801071 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_signature.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentStaticFieldBase` + # _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS class TemplateResponseDocumentStaticFieldSignature < TemplateResponseDocumentStaticFieldBase - # The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + # _t__TemplateResponseDocumentStaticField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_text.rb index 37612d617..51ad4bf09 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_text.rb @@ -17,9 +17,9 @@ module Dropbox end module Dropbox::Sign - # This class extends `TemplateResponseDocumentStaticFieldBase` + # _t__TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS class TemplateResponseDocumentStaticFieldText < TemplateResponseDocumentStaticFieldBase - # The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` + # _t__TemplateResponseDocumentStaticField::TYPE # @return [String] attr_accessor :type diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb index aceaff422..68e481071 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # Average text length in this field. + # _t__TemplateResponseFieldAvgTextLength::DESCRIPTION class TemplateResponseFieldAvgTextLength - # Number of lines. + # _t__TemplateResponseFieldAvgTextLength::NUM_LINES # @return [Integer] attr_accessor :num_lines - # Number of characters per line. + # _t__TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE # @return [Integer] attr_accessor :num_chars_per_line diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb index a2263db31..5d7be1619 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb @@ -18,11 +18,11 @@ module Dropbox module Dropbox::Sign class TemplateResponseSignerRole - # The name of the Role. + # _t__TemplateResponseSignerRole::NAME # @return [String] attr_accessor :name - # If signer order is assigned this is the 0-based index for this role. + # _t__TemplateResponseSignerRole::ORDER # @return [Integer] attr_accessor :order diff --git a/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb index 5d3ab09e2..a566e4558 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # Contains template id + # _t__TemplateUpdateFilesResponseTemplate::DESCRIPTION class TemplateUpdateFilesResponseTemplate - # The id of the Template. + # _t__TemplateResponse::TEMPLATE_ID # @return [String] attr_accessor :template_id - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb index 210aae825..0a902d5d6 100644 --- a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb @@ -43,11 +43,15 @@ class UnclaimedDraftCreateEmbeddedRequest # @return [Boolean] attr_accessor :allow_decline + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. # @return [Boolean] attr_accessor :allow_reassign - # A list describing the attachments + # _t__SubAttachment::LIST_DESCRIPTION # @return [Array] attr_accessor :attachments @@ -101,7 +105,7 @@ class UnclaimedDraftCreateEmbeddedRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata @@ -117,7 +121,7 @@ class UnclaimedDraftCreateEmbeddedRequest # @return [Boolean] attr_accessor :show_progress_stepper - # Add Signers to your Unclaimed Draft Signature Request. + # _t__Sub::UnclaimedDraftSigner::DESCRIPTION # @return [Array] attr_accessor :signers @@ -191,6 +195,7 @@ def self.attribute_map :'file_urls' => :'file_urls', :'allow_ccs' => :'allow_ccs', :'allow_decline' => :'allow_decline', + :'allow_form_view' => :'allow_form_view', :'allow_reassign' => :'allow_reassign', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', @@ -243,6 +248,7 @@ def self.openapi_types :'file_urls' => :'Array', :'allow_ccs' => :'Boolean', :'allow_decline' => :'Boolean', + :'allow_form_view' => :'Boolean', :'allow_reassign' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', @@ -356,6 +362,12 @@ def initialize(attributes = {}) self.allow_decline = false end + if attributes.key?(:'allow_form_view') + self.allow_form_view = attributes[:'allow_form_view'] + else + self.allow_form_view = false + end + if attributes.key?(:'allow_reassign') self.allow_reassign = attributes[:'allow_reassign'] else @@ -621,6 +633,7 @@ def ==(o) file_urls == o.file_urls && allow_ccs == o.allow_ccs && allow_decline == o.allow_decline && + allow_form_view == o.allow_form_view && allow_reassign == o.allow_reassign && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && @@ -662,7 +675,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, requester_email_address, files, file_urls, allow_ccs, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, editor_options, field_options, force_signer_page, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, hold_request, is_for_embedded_signing, message, metadata, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, type, use_preexisting_fields, use_text_tags, populate_auto_fill_fields, expires_at].hash + [client_id, requester_email_address, files, file_urls, allow_ccs, allow_decline, allow_form_view, allow_reassign, attachments, cc_email_addresses, custom_fields, editor_options, field_options, force_signer_page, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, hold_request, is_for_embedded_signing, message, metadata, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, type, use_preexisting_fields, use_text_tags, populate_auto_fill_fields, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb index 339107b89..7c16a32bb 100644 --- a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb @@ -80,7 +80,7 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata @@ -100,7 +100,7 @@ class UnclaimedDraftCreateEmbeddedWithTemplateRequest # @return [Boolean] attr_accessor :show_progress_stepper - # Add Signers to your Templated-based Signature Request. + # _t__Sub::UnclaimedDraftTemplateSigner::DESCRIPTION # @return [Array] attr_accessor :signers diff --git a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb index 3aa84129f..136c24ba3 100644 --- a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb @@ -35,7 +35,11 @@ class UnclaimedDraftCreateRequest # @return [Boolean] attr_accessor :allow_decline - # A list describing the attachments + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + + # _t__SubAttachment::LIST_DESCRIPTION # @return [Array] attr_accessor :attachments @@ -74,7 +78,7 @@ class UnclaimedDraftCreateRequest # @return [String] attr_accessor :message - # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + # _t__Sub::Metadata::DESCRIPTION # @return [Hash] attr_accessor :metadata @@ -82,7 +86,7 @@ class UnclaimedDraftCreateRequest # @return [Boolean] attr_accessor :show_progress_stepper - # Add Signers to your Unclaimed Draft Signature Request. + # _t__Sub::UnclaimedDraftSigner::DESCRIPTION # @return [Array] attr_accessor :signers @@ -142,6 +146,7 @@ def self.attribute_map :'files' => :'files', :'file_urls' => :'file_urls', :'allow_decline' => :'allow_decline', + :'allow_form_view' => :'allow_form_view', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', :'client_id' => :'client_id', @@ -182,6 +187,7 @@ def self.openapi_types :'files' => :'Array', :'file_urls' => :'Array', :'allow_decline' => :'Boolean', + :'allow_form_view' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', :'client_id' => :'String', @@ -275,6 +281,12 @@ def initialize(attributes = {}) self.allow_decline = false end + if attributes.key?(:'allow_form_view') + self.allow_form_view = attributes[:'allow_form_view'] + else + self.allow_form_view = false + end + if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value @@ -457,6 +469,7 @@ def ==(o) files == o.files && file_urls == o.file_urls && allow_decline == o.allow_decline && + allow_form_view == o.allow_form_view && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && client_id == o.client_id && @@ -488,7 +501,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, files, file_urls, allow_decline, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, show_progress_stepper, signers, signing_options, signing_redirect_url, subject, test_mode, use_preexisting_fields, use_text_tags, expires_at].hash + [type, files, file_urls, allow_decline, allow_form_view, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, show_progress_stepper, signers, signing_options, signing_redirect_url, subject, test_mode, use_preexisting_fields, use_text_tags, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_response.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_response.rb index d72c78fd5..91c4a3b8f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_response.rb @@ -21,7 +21,7 @@ class UnclaimedDraftCreateResponse # @return [UnclaimedDraftResponse] attr_accessor :unclaimed_draft - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION # @return [Array] attr_accessor :warnings diff --git a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_response.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_response.rb index f393e20a6..a790da181 100644 --- a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_response.rb @@ -17,29 +17,29 @@ module Dropbox end module Dropbox::Sign - # A group of documents that a user can take ownership of via the claim URL. + # _t__UnclaimedDraftResponse::DESCRIPTION class UnclaimedDraftResponse - # The ID of the signature request that is represented by this UnclaimedDraft. + # _t__UnclaimedDraft::SIGNATURE_REQUEST_ID # @return [String, nil] attr_accessor :signature_request_id - # The URL to be used to claim this UnclaimedDraft. + # _t__UnclaimedDraft::CLAIM_URL # @return [String] attr_accessor :claim_url - # The URL you want signers redirected to after they successfully sign. + # _t__UnclaimedDraft::SIGNING_REDIRECT_URL # @return [String, nil] attr_accessor :signing_redirect_url - # The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). + # _t__UnclaimedDraft::REQUESTING_REDIRECT_URL # @return [String, nil] attr_accessor :requesting_redirect_url - # When the link expires. + # _t__UnclaimedDraft::EXPIRES_AT # @return [Integer, nil] attr_accessor :expires_at - # Whether this is a test draft. Signature requests made from test drafts have no legal value. + # _t__UnclaimedDraft::TEST_MODE # @return [Boolean] attr_accessor :test_mode diff --git a/sdks/ruby/lib/dropbox-sign/models/warning_response.rb b/sdks/ruby/lib/dropbox-sign/models/warning_response.rb index 32042a9c9..cc9387119 100644 --- a/sdks/ruby/lib/dropbox-sign/models/warning_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/warning_response.rb @@ -17,13 +17,13 @@ module Dropbox end module Dropbox::Sign - # A list of warnings. + # _t__WarningResponse::LIST_DESCRIPTION class WarningResponse - # Warning message + # _t__WarningResponse::WARNING_MSG # @return [String] attr_accessor :warning_msg - # Warning name + # _t__WarningResponse::WARNING_NAME # @return [String] attr_accessor :warning_name diff --git a/test_fixtures/EmbeddedEditUrlRequest.json b/test_fixtures/EmbeddedEditUrlRequest.json index 9d3d76647..ca8ea9084 100644 --- a/test_fixtures/EmbeddedEditUrlRequest.json +++ b/test_fixtures/EmbeddedEditUrlRequest.json @@ -1,6 +1,7 @@ { "default": { "allow_edit_ccs": true, + "allow_form_view": true, "cc_roles": [ "" ], diff --git a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json index 16e803706..3e71f14af 100644 --- a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json @@ -2,6 +2,7 @@ "default": { "allow_decline": true, "allow_reassign": true, + "allow_form_view": true, "attachments": [ { "name": "Attachment1", @@ -126,6 +127,7 @@ "with_grouped_signers": { "allow_decline": true, "allow_reassign": true, + "allow_form_view": true, "attachments": [ { "name": "Attachment1", diff --git a/test_fixtures/SignatureRequestSendRequest.json b/test_fixtures/SignatureRequestSendRequest.json index 98d12db3b..c7e871d45 100644 --- a/test_fixtures/SignatureRequestSendRequest.json +++ b/test_fixtures/SignatureRequestSendRequest.json @@ -2,6 +2,7 @@ "default": { "allow_decline": true, "allow_reassign": true, + "allow_form_view": true, "attachments": [ { "name": "Attachment1", @@ -240,6 +241,7 @@ "with_grouped_signers": { "allow_decline": true, "allow_reassign": true, + "allow_form_view": true, "attachments": [ { "name": "Attachment1", diff --git a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json index b293945e7..484f27422 100644 --- a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +++ b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json @@ -2,6 +2,7 @@ "default": { "allow_ccs": true, "allow_reassign": true, + "allow_form_view": true, "attachments": [ { "name": "Attachment1", diff --git a/test_fixtures/TemplateCreateRequest.json b/test_fixtures/TemplateCreateRequest.json index b293945e7..484f27422 100644 --- a/test_fixtures/TemplateCreateRequest.json +++ b/test_fixtures/TemplateCreateRequest.json @@ -2,6 +2,7 @@ "default": { "allow_ccs": true, "allow_reassign": true, + "allow_form_view": true, "attachments": [ { "name": "Attachment1", diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json index e18890b74..19d16453d 100644 --- a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +++ b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json @@ -3,6 +3,7 @@ "allow_ccs": true, "allow_decline": true, "allow_reassign": true, + "allow_form_view": true, "attachments": [ { "name": "Attachment1", diff --git a/test_fixtures/UnclaimedDraftCreateRequest.json b/test_fixtures/UnclaimedDraftCreateRequest.json index b74d37713..f70ce0064 100644 --- a/test_fixtures/UnclaimedDraftCreateRequest.json +++ b/test_fixtures/UnclaimedDraftCreateRequest.json @@ -1,6 +1,7 @@ { "default": { "allow_decline": true, + "allow_form_view": true, "attachments": [ { "name": "Attachment1", diff --git a/translations/en.yaml b/translations/en.yaml index 3dcaf3ea3..1d070f993 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -125,6 +125,7 @@ "EmbeddedEditUrl::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. "EmbeddedEditUrl::TEMPLATE_ID": The id of the template to edit. "EmbeddedEditUrl::TEST_MODE": Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. +"EmbeddedEditUrl::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "EmbeddedSignUrl::SUMMARY": Get Embedded Sign URL "EmbeddedSignUrl::DESCRIPTION": Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. @@ -360,6 +361,7 @@ "SignatureRequestCreateEmbedded::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. "SignatureRequestCreateEmbedded::TITLE": The title you want to assign to the SignatureRequest. "SignatureRequestCreateEmbedded::USE_TEXT_TAGS": Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. +"SignatureRequestCreateEmbedded::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "SignatureRequestEditEmbedded::SUMMARY": Edit Embedded Signature Request "SignatureRequestEditEmbedded::DESCRIPTION": |- @@ -367,6 +369,7 @@ **NOTE:** Edit and resend *will* deduct your signature request quota. "SignatureRequestEditEmbedded::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to edit. +"SignatureRequestEditEmbedded::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "SignatureRequestCreateEmbeddedWithTemplate::SUMMARY": Create Embedded Signature Request with Template "SignatureRequestCreateEmbeddedWithTemplate::DESCRIPTION": Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. @@ -495,6 +498,7 @@ "SignatureRequestSend::TITLE": The title you want to assign to the SignatureRequest. "SignatureRequestSend::EXPIRES_AT": When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. "SignatureRequestSend::USE_PREEXISTING_FIELDS": Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. +"SignatureRequestSend::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "SignatureRequestEdit::SUMMARY": Edit Signature Request "SignatureRequestEdit::DESCRIPTION": |- @@ -502,6 +506,7 @@ **NOTE:** Edit and resend *will* deduct your signature request quota. "SignatureRequestEdit::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to edit. +"SignatureRequestEdit::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "SignatureRequestSendWithTemplate::SUMMARY": Send with Template "SignatureRequestSendWithTemplate::DESCRIPTION": Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. @@ -695,7 +700,7 @@ "TemplateCreateEmbeddedDraft::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. "TemplateCreateEmbeddedDraft::TITLE": The title you want to assign to the SignatureRequest. "TemplateCreateEmbeddedDraft::USE_PREEXISTING_FIELDS": Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). - +"TemplateCreateEmbeddedDraft::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "TemplateCreate::SUMMARY": Create Template "TemplateCreate::DESCRIPTION": Creates a template that can then be used. @@ -724,6 +729,7 @@ "TemplateCreate::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. "TemplateCreate::TITLE": The title you want to assign to the SignatureRequest. "TemplateCreate::USE_PREEXISTING_FIELDS": Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). +"TemplateCreate::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "TemplateDelete::SUMMARY": Delete Template "TemplateDelete::DESCRIPTION": Completely deletes the template specified from the account. @@ -825,6 +831,8 @@ When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. +"UnclaimedDraftCreate::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + "UnclaimedDraftCreateEmbedded::SUMMARY": Create Embedded Unclaimed Draft "UnclaimedDraftCreateEmbedded::DESCRIPTION": |- Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. @@ -875,6 +883,8 @@ When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. +"UnclaimedDraftCreateEmbedded::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + "UnclaimedDraftCreateEmbeddedWithTemplate::SUMMARY": Create Embedded Unclaimed Draft with Template "UnclaimedDraftCreateEmbeddedWithTemplate::DESCRIPTION": |- Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. @@ -1118,717 +1128,3 @@ "Sub::FormFieldsPerDocument::TYPE_RADIO": An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. "Sub::FormFieldsPerDocument::TYPE_SIGNATURE": A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. "Sub::FormFieldsPerDocument::TYPE_TEXT": A text input field. Use the `SubFormFieldsPerDocumentText` class. -"Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE": A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. -"Sub::FormFieldsPerDocument::CONTENT_SIGNATURE": The signature GUID value, used to provide an existing signature to a `me_now` signature field -"Sub::FormFieldsPerDocument::CONTENT_INITIALS": The initials GUID value, used to provide existing initials to a `me_now` initials field -"Sub::FormFieldsPerDocument::VALIDATION_TYPE": |- - Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. - - **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. -"Sub::FormFieldsPerDocument::WIDTH": Size of the field in pixels. -"Sub::FormFieldsPerDocument::X": Location coordinates of the field in pixels. -"Sub::FormFieldsPerDocument::Y": Location coordinates of the field in pixels. - -"Sub::SignatureRequestGroupedSigners::DESCRIPTION": |- - Add Grouped Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. -"Sub::SignatureRequestGroupedSigners::GROUP_NAME": The name of the group. -"Sub::SignatureRequestGroupedSigners::ORDER": The order the group is required to sign in. Use this instead of Signer-level `order`. -"Sub::SignatureRequestGroupedSigners::SIGNERS": |- - 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. - -"Sub::MergeField::NAME": The name of the merge field. Must be unique. -"Sub::MergeField::TYPE": The type of merge field. -"Sub::MergeField::EnumDescriptions::TEXT": Sets merge [field type](/api/reference/constants/#field-types) to `text`. -"Sub::MergeField::EnumDescriptions::CHECKBOX": Sets merge [field type](/api/reference/constants/#field-types) to `checkbox`. - -"Sub::Metadata::DESCRIPTION": |- - Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. - - Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. - -"Sub::OAuth::CALLBACK_URL": The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) -"Sub::OAuth::DESCRIPTION": OAuth related parameters. -"Sub::OAuth::SCOPES": A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). - -"Sub::Options::CAN_INSERT_EVERYWHERE": Determines if signers can use "Insert Everywhere" when signing a document. -"Sub::Options::DESCRIPTION": Additional options supported by API App. - -"Sub::SignatureRequestSigner::DESCRIPTION": |- - Add Signers to your Signature Request. - - This endpoint requires either **signers** or **grouped_signers**, but not both. -"Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS": The email address of the signer. -"Sub::SignatureRequestSigner::SIGNER_NAME": The name of the signer. -"Sub::SignatureRequestSigner::SIGNER_ORDER": The order the signer is required to sign in. -"Sub::SignatureRequestSigner::SIGNER_PIN": The 4- to 12-character access code that will secure this signer's signature page. -"Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER": |- - An E.164 formatted phone number. - - By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - - **NOTE:** Not available in test mode and requires a Standard plan or higher. - -"Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE": |- - Specifies the feature used with the `sms_phone_number`. Default `authentication`. - - If `authentication`, signer is sent a verification code via SMS that is required to access the document. - - If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). - -"Sub::SignatureRequestTemplateSigner::DESCRIPTION": Add Signers to your Templated-based Signature Request. -"Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS": The email address of the signer. -"Sub::SignatureRequestTemplateSigner::NAME": The name of the signer. -"Sub::SignatureRequestTemplateSigner::PIN": The 4- to 12-character access code that will secure this signer's signature page. -"Sub::SignatureRequestTemplateSigner::ROLE": Must match an existing role in chosen Template(s). It's case-sensitive. -"Sub::SignatureRequestTemplateSigner::SMS_PHONE_NUMBER": |- - An E.164 formatted phone number. - - By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on). - - **NOTE:** Not available in test mode and requires a Standard plan or higher. - -"Sub::SignatureRequestTemplateSigner::SIGNER_SMS_PHONE_NUMBER_TYPE": |- - Specifies the feature used with the `sms_phone_number`. Default `authentication`. - - If `authentication`, signer is sent a verification code via SMS that is required to access the document. - - If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). - -"Sub::SignerRole::NAME": The role name of the signer that will be displayed when the template is used to create a signature request. -"Sub::SignerRole::ORDER": The order in which this signer role is required to sign. - -"Sub::SigningOptions::DESCRIPTION": |- - This allows the requester to specify the types allowed for creating a signature. - - **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. -"Sub::SigningOptions::DEFAULT": The default type shown (limited to the listed types) -"Sub::SigningOptions::DRAW": Allows drawing the signature -"Sub::SigningOptions::PHONE": Allows using a smartphone to email the signature -"Sub::SigningOptions::TYPE": Allows typing the signature -"Sub::SigningOptions::UPLOAD": Allows uploading the signature - -"Sub::UnclaimedDraftSigner::DESCRIPTION": Add Signers to your Unclaimed Draft Signature Request. -"Sub::UnclaimedDraftSigner::EMAIL_ADDRESS": The email address of the signer. -"Sub::UnclaimedDraftSigner::NAME": The name of the signer. -"Sub::UnclaimedDraftSigner::ORDER": The order the signer is required to sign in. - -"Sub::UnclaimedDraftTemplateSigner::DESCRIPTION": Add Signers to your Templated-based Signature Request. -"Sub::UnclaimedDraftTemplateSigner::ROLE": Must match an existing role in chosen Template(s). -"Sub::UnclaimedDraftTemplateSigner::NAME": The name of the signer filling the role of `role`. -"Sub::UnclaimedDraftTemplateSigner::EMAIL_ADDRESS": The email address of the signer filling the role of `role`. - -"Sub::WhiteLabelingOptions::DESCRIPTION": |- - An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) - - Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. -"Sub::WhiteLabelingOptions::RESET_TO_DEFAULT": Resets white labeling options to defaults. Only useful when updating an API App. - -################### -# Response Models # -################### - -"AccountCreateResponseExample::SUMMARY": Account Create -"AccountGetResponseExample::SUMMARY": Account Get -"AccountCreateOAuthResponseExample::SUMMARY": Account Create with OAuth Authorization -"AccountUpdateResponseExample::SUMMARY": Account Update -"AccountVerifyFoundResponseExample::SUMMARY": Account Found -"AccountVerifyNotFoundResponseExample::SUMMARY": Account Not Found -"AccountResponse::DESCRIPTION": Contains the Account information -"AccountVerifyResponse::DESCRIPTION": Contains the verified Account's information. -"Account::ACCOUNT_ID": The ID of the Account -"Account::EMAIL_ADDRESS": The email address associated with the Account. -"Account::CALLBACK_URL": The URL that Dropbox Sign events will `POST` to. -"Account::IS_LOCKED": Returns `true` if the user has been locked out of their account by a team admin. -"Account::IS_PAID_HS": Returns `true` if the user has a paid Dropbox Sign account. -"Account::IS_PAID_HF": Returns `true` if the user has a paid HelloFax account. -"Account::ROLE_CODE": The membership role for the team. -"Account::TEAM_ID": The id of the team account belongs to. -"Account::LOCALE": 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. -"Account::QUOTA": Details concerning remaining monthly quotas. -"Account::USAGE": Details concerning monthly usage -"AccountQuota::TEMPLATES_LEFT": API templates remaining. -"AccountQuota::TEMPLATES_TOTAL": Total API templates allowed. -"AccountQuota::API_SIGNATURE_REQUESTS_LEFT": API signature requests remaining. -"AccountQuota::DOCUMENTS_LEFT": Signature requests remaining. -"AccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining. -"AccountQuota::NUM_FAX_PAGES_LEFT": Number of fax pages left -"AccountUsage::FAX_PAGES_SENT": Number of fax pages sent - -"ApiAppCreateResponseExample::SUMMARY": API App -"ApiAppGetResponseExample::SUMMARY": API App -"ApiAppListResponseExample::SUMMARY": API App List -"ApiAppUpdateResponseExample::SUMMARY": API App Update -"ApiAppResponse::CALLBACK_URL": The app's callback URL (for events) -"ApiAppResponse::CLIENT_ID": The app's client id -"ApiAppResponse::DESCRIPTION": Contains information about an API App. -"ApiAppResponse::CREATED_AT": The time that the app was created -"ApiAppResponse::DOMAINS": The domain name(s) associated with the app -"ApiAppResponse::NAME": The name of the app -"ApiAppResponse::IS_APPROVED": Boolean to indicate if the app has been approved - -"ApiAppListResponse::DESCRIPTION": Contains information about API Apps. - -"ApiAppResponseOAuth::DESCRIPTION": An object describing the app's OAuth properties, or null if OAuth is not configured for the app. -"ApiAppResponseOAuth::CALLBACK_URL": The app's OAuth callback URL. -"ApiAppResponseOAuth::CHARGES_USERS": Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests. -"ApiAppResponseOAuth::SECRET": The app's OAuth secret, or null if the app does not belong to user. -"ApiAppResponseOAuth::SCOPES": Array of OAuth scopes used by the app. - -"ApiAppResponseOptions::DESCRIPTION": An object with options that override account settings. -"ApiAppResponseOptions::CAN_INSERT_EVERYWHERE": Boolean denoting if signers can "Insert Everywhere" in one click while signing a document - -"ApiAppResponseOwnerAccount::DESCRIPTION": An object describing the app's owner -"ApiAppResponseOwnerAccount::ACCOUNT_ID": The owner account's ID -"ApiAppResponseOwnerAccount::EMAIL_ADDRESS": The owner account's email address - -"ApiAppResponseWhiteLabelingOptions::DESCRIPTION": An object with options to customize the app's signer page - -"BulkSendJobGetResponseExample::SUMMARY": Bulk Send Job -"BulkSendJobListResponseExample::SUMMARY": Bulk Send Job List -"BulkSendJobListResponse::BULK_SEND_JOBS": Contains a list of BulkSendJobs that the API caller has access to. -"BulkSendJobResponse::BULK_SEND_JOB_ID": The id of the BulkSendJob. -"BulkSendJobResponse::DESCRIPTION": Contains information about the BulkSendJob such as when it was created and how many signature requests are queued. -"BulkSendJobResponse::TOTAL": The total amount of Signature Requests queued for sending. -"BulkSendJobResponse::IS_CREATOR": True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. -"BulkSendJobResponse::CREATED_AT": Time that the BulkSendJob was created. -"BulkSendJobGetResponse::SIGNATURE_REQUESTS": Contains information about the Signature Requests sent in bulk. -"BulkSendJobGetResponseSignatureRequests::BULK_SEND_JOB_ID": The id of the BulkSendJob. - -"Common::RateLimiting::LIMIT": The maximum number of requests per hour that you can make. -"Common::RateLimiting::REMAINING": The number of requests remaining in the current rate limit window. -"Common::RateLimiting::RESET": The Unix time at which the rate limit will reset to its maximum. - -"EmbeddedEditUrlResponseExample::SUMMARY": Embedded Edit URL -"EmbeddedSignUrlResponseExample::SUMMARY": Embedded Sign URL - -"EmbeddedSignUrlResponseEmbedded::DESCRIPTION": An object that contains necessary information to set up embedded signing. -"EmbeddedSignUrlResponseEmbedded::SIGN_URL": A signature url that can be opened in an iFrame. -"EmbeddedSignUrlResponseEmbedded::EXPIRES_AT": The specific time that the the `sign_url` link expires, in epoch. - -"EmbeddedEditUrlResponseEmbedded::DESCRIPTION": An embedded template object. -"EmbeddedEditUrlResponseEmbedded::EDIT_URL": A template url that can be opened in an iFrame. -"EmbeddedEditUrlResponseEmbedded::EXPIRES_AT": The specific time that the the `edit_url` link expires, in epoch. - -"EventCallbackAccountRequest::DESCRIPTION": |- - **Account Callback Payloads --** - Events that are reported at the Account level through the the *Account callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api). The *Account callback URL* can also be updated by calling [Update Account](/api/reference/operation/accountUpdate) and passing a `callback_url`. -"EventCallbackAccountSignatureRequestSentExample::SUMMARY": |- - Example: signature_request_sent -"EventCallbackAccountTemplateCreatedExample::SUMMARY": |- - Example: template_created -"EventCallbackAppAccountConfirmedExample::SUMMARY": |- - Example: account_confirmed -"EventCallbackAppSignatureRequestSentExample::SUMMARY": |- - Example: signature_request_sent -"EventCallbackAppTemplateCreatedExample::SUMMARY": |- - Example: template_created -"EventCallbackAppRequest::DESCRIPTION": |- - **API App Callback Payloads --** - Events that are reported at the API App level through the *Event callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api) for a specific app. The *Event callback URL* can also be updated by calling [Update API App](/api/reference/operation/apiAppUpdate) and passing a `callback_url`. -"EventCallbackRequestEvent::DESCRIPTION": Basic information about the event that occurred. -"EventCallbackRequestEvent::EVENT_TIME": Time the event was created (using Unix time). -"EventCallbackRequestEvent::EVENT_TYPE": Type of callback event that was triggered. -"EventCallbackRequestEvent::EVENT_HASH": Generated hash used to verify source of event data. -"EventCallbackRequestEventMetadata::DESCRIPTION": Specific metadata about the event. -"EventCallbackRequestEventMetadata::RELATED_SIGNATURE_ID": Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. -"EventCallbackRequestEventMetadata::REPORTED_FOR_ACCOUNT_ID": Account ID the event was reported for. -"EventCallbackRequestEventMetadata::REPORTED_FOR_APP_ID": App ID the event was reported for. -"EventCallbackRequestEventMetadata::EVENT_MESSAGE": Message about a declined or failed (due to error) signature flow. -"EventCallbackSignatureRequestExample::SUMMARY": Event Callback Signature Request Example -"EventCallbackTemplateRequestExample::SUMMARY": Event Callback Template Example - -"ListInfoResponse::DESCRIPTION": Contains pagination information about the data returned. -"ListInfoResponse::NUM_PAGES": Total number of pages available. -"ListInfoResponse::NUM_RESULTS": Total number of objects available. -"ListInfoResponse::PAGE": Number of the page being returned. -"ListInfoResponse::PAGE_SIZE": Objects returned per page. - -"WarningResponse::LIST_DESCRIPTION": A list of warnings. -"WarningResponse::WARNING_MSG": Warning message -"WarningResponse::WARNING_NAME": Warning name - -"SubAttachment::LIST_DESCRIPTION": A list describing the attachments - -"OAuthTokenGenerateResponseExample::SUMMARY": Retrieving the OAuth token -"OAuthTokenRefreshResponseExample::SUMMARY": Refresh an existing OAuth token -"OAuthTokenResponse::ACCESS_TOKEN": The access token used for sending API calls on behalf of the user that authorized the API App. -"OAuthTokenResponse::TOKEN_TYPE": The authorization method used with the token. Passed in the `Authorization` header of the HTTP request as `Bearer `. -"OAuthTokenResponse::REFRESH_TOKEN": The long-lived refresh token used to refresh an expired `access_token` without forcing the user through another OAuth approval flow (unless the apps `access_scope` has changed or the user revoked their authorization). -"OAuthTokenResponse::EXPIRES_IN": Number of seconds until the `access_token` expires. Uses epoch time. -"OAuthTokenResponse::STATE": The string that was passed back with `state` during the initial authorization step. - -"ReportCreateResponseExample::SUMMARY": Report -"ReportResponse::DESCRIPTION": Contains information about the report request. -"ReportResponse::END_DATE": The (inclusive) end date for the report data in MM/DD/YYYY format. -"ReportResponse::REPORT_TYPE": 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). -"ReportResponse::START_DATE": The (inclusive) start date for the report data in MM/DD/YYYY format. -"ReportResponse::SUCCESS": A message indicating the requested operation's success - -"SignatureRequestCreateEmbeddedResponseExample::SUMMARY": Create Embedded Signature Request -"SignatureRequestEditEmbeddedResponseExample::SUMMARY": Edit Embedded Signature Request -"SignatureRequestCreateEmbeddedWithTemplateResponseExample::SUMMARY": Create Embedded Signature Request With Template -"SignatureRequestEditEmbeddedWithTemplateResponseExample::SUMMARY": Edit Embedded Signature Request With Template -"SignatureRequestGetResponseExample::SUMMARY": Get Signature Request -"SignatureRequestFilesResponseExample::SUMMARY": Signature Requests Files -"SignatureRequestListResponseExample::SUMMARY": List Signature Requests -"SignatureRequestReleaseHoldResponseExample::SUMMARY": Send Signature Release Hold -"SignatureRequestRemindResponseExample::SUMMARY": Send Signature Request Reminder -"SignatureRequestSendResponseExample::SUMMARY": Send Signature Request -"SignatureRequestEditResponseExample::SUMMARY": Edit Signature Request -"SignatureRequestSendWithTemplateResponseExample::SUMMARY": Send Signature Request With Template -"SignatureRequestEditWithTemplateResponseExample::SUMMARY": Edit Signature Request With Template -"SignatureRequestBulkSendWithTemplateResponseExample::SUMMARY": Send Signature Request With Template -"SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample::SUMMARY": Bulk Send Create Embedded Signature Request With Template -"SignatureRequestUpdateResponseExample::SUMMARY": Signature Request Update - -"SignatureRequestResponse::CC_EMAIL_ADDRESSES": A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. -"SignatureRequestResponse::CREATED_AT": Time the signature request was created. -"SignatureRequestResponse::DESCRIPTION": Contains information about a signature request. -"SignatureRequestResponse::DETAILS_URL": The URL where the requester and the signers can view the current status of the SignatureRequest. -"SignatureRequestResponse::FILES_URL": The URL where a copy of the request's documents can be downloaded. -"SignatureRequestResponse::HAS_ERROR": Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). -"SignatureRequestResponse::IS_COMPLETE": Whether or not the SignatureRequest has been fully executed by all signers. -"SignatureRequestResponse::IS_DECLINED": Whether or not the SignatureRequest has been declined by a signer. -"SignatureRequestResponse::MESSAGE": The custom message in the email that was initially sent to the signers. -"SignatureRequestResponse::METADATA": The metadata attached to the signature request. -"SignatureRequestResponse::ORIGINAL_TITLE": Default Label for account. -"SignatureRequestResponse::REQUESTER_EMAIL_ADDRESS": The email address of the initiator of the SignatureRequest. -"SignatureRequestResponse::SIGNATURE_REQUEST_ID": The id of the SignatureRequest. -"SignatureRequestResponse::SIGNING_REDIRECT_URL": The URL you want the signer redirected to after they successfully sign. -"SignatureRequestResponse::FINAL_COPY_URI": The path where the completed document can be downloaded -"SignatureRequestResponse::SIGNING_URL": The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. -"SignatureRequestResponse::SUBJECT": The subject in the email that was initially sent to the signers. -"SignatureRequestResponse::TEMPLATE_IDS": Templates IDs used in this SignatureRequest (if any). -"SignatureRequestResponse::TEST_MODE": Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. -"SignatureRequestResponse::TITLE": The title the specified Account uses for the SignatureRequest. -"SignatureRequestResponse::EXPIRES_AT": The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. -"SignatureRequestResponse::BULK_SEND_JOB_ID": The ID of the Bulk Send job which sent the signature request, if applicable. - -"SignatureRequestListResponse::DESCRIPTION": Contains information about signature requests. - -"SignatureRequestResponseCustomField::DESCRIPTION": |- - An array of Custom Field objects containing the name and type of each custom field. - - * Text Field uses `SignatureRequestResponseCustomFieldText` - * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` -"SignatureRequestResponseCustomField::DESCRIPTION_EXTENDS": This class extends `SignatureRequestResponseCustomFieldBase`. -"SignatureRequestResponseCustomField::API_ID": The unique ID for this field. -"SignatureRequestResponseCustomField::EDITOR": The name of the Role that is able to edit this field. -"SignatureRequestResponseCustomField::NAME": The name of the Custom Field. -"SignatureRequestResponseCustomField::REQUIRED": A boolean value denoting if this field is required. -"SignatureRequestResponseCustomField::TYPE": The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. -"SignatureRequestResponseCustomField::VALUE_TEXT": A text string for text fields -"SignatureRequestResponseCustomField::VALUE_CHECKBOX": A true/false for checkbox fields - -"SignatureRequestResponseAttachment::DESCRIPTION": Signer attachments. -"SignatureRequestResponseAttachment::ID": The unique ID for this attachment. -"SignatureRequestResponseAttachment::SIGNER": The Signer this attachment is assigned to. -"SignatureRequestResponseAttachment::NAME": The name of this attachment. -"SignatureRequestResponseAttachment::INSTRUCTIONS": Instructions for Signer. -"SignatureRequestResponseAttachment::REQUIRED": A boolean value denoting if this attachment is required. -"SignatureRequestResponseAttachment::UPLOADED_AT": Timestamp when attachment was uploaded by Signer. - -"SignatureRequestResponseData::DESCRIPTION": An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. -"SignatureRequestResponseData::API_ID": The unique ID for this field. -"SignatureRequestResponseData::NAME": The name of the form field. -"SignatureRequestResponseData::REQUIRED": A boolean value denoting if this field is required. -"SignatureRequestResponseData::SIGNATURE_ID": The ID of the signature to which this response is linked. -"SignatureRequestResponseDataValue::TEXT_TYPE": A text input field -"SignatureRequestResponseDataValue::CHECKBOX_TYPE": A yes/no checkbox -"SignatureRequestResponseDataValue::DATESIGNED_TYPE": A date -"SignatureRequestResponseDataValue::DROPDOWN_TYPE": An input field for dropdowns -"SignatureRequestResponseDataValue::INITIAL_TYPE": An input field for initials -"SignatureRequestResponseDataValue::RADIO_TYPE": An input field for radios -"SignatureRequestResponseDataValue::SIGNATURE_TYPE": A signature input field -"SignatureRequestResponseDataValue::TEXTMERGE_TYPE": A text field that has default text set by the api -"SignatureRequestResponseDataValue::CHECKBOXMERGE_TYPE": A checkbox field that has default value set by the api -"SignatureRequestResponseDataValue::VALUE": The value of the form field. -"SignatureRequestResponseDataValue::IS_SIGNED": This field contains the boolean true if the field is signed. - -"SignatureRequestResponseSignatures::DESCRIPTION": An array of signature objects, 1 for each signer. -"SignatureRequestResponseSignatures::DECLINE_REASON": The reason provided by the signer for declining the request. -"SignatureRequestResponseSignatures::ERROR": Error message pertaining to this signer, or null. -"SignatureRequestResponseSignatures::HAS_PIN": Boolean to indicate whether this signature requires a PIN to access. -"SignatureRequestResponseSignatures::HAS_SMS_AUTH": Boolean to indicate whether this signature has SMS authentication enabled. -"SignatureRequestResponseSignatures::HAS_SMS_DELIVERY": Boolean to indicate whether this signature has SMS delivery enabled. -"SignatureRequestResponseSignatures::SMS_PHONE_NUMBER": The SMS phone number used for authentication or signature request delivery. -"SignatureRequestResponseSignatures::LAST_VIEWED_AT": The time that the document was last viewed by this signer or null. -"SignatureRequestResponseSignatures::LAST_REMINDED_AT": The time the last reminder email was sent to the signer or null. -"SignatureRequestResponseSignatures::NUM_PAGES": Total number of pages available -"SignatureRequestResponseSignatures::ORDER": If signer order is assigned this is the 0-based index for this signer. -"SignatureRequestResponseSignatures::REASSIGNED_BY": Email address of original signer who reassigned to this signer. -"SignatureRequestResponseSignatures::REASSIGNMENT_REASON": Reason provided by original signer who reassigned to this signer. -"SignatureRequestResponseSignatures::REASSIGNED_FROM": Previous signature identifier. -"SignatureRequestResponseSignatures::SIGNATURE_ID": Signature identifier. -"SignatureRequestResponseSignatures::SIGNED_AT": Time that the document was signed or null. -"SignatureRequestResponseSignatures::SIGNER_EMAIL_ADDRESS": The email address of the signer. -"SignatureRequestResponseSignatures::SIGNER_GROUP_GUID": Signer Group GUID -"SignatureRequestResponseSignatures::SIGNER_NAME": The name of the signer. -"SignatureRequestResponseSignatures::SIGNER_ROLE": The role of the signer. -"SignatureRequestResponseSignatures::STATUS_CODE": "The current status of the signature. eg: awaiting_signature, signed, declined." - -"TeamAddMemberResponseExample::SUMMARY": Team Add Member -"TeamCreateResponseExample::SUMMARY": Team Create -"TeamGetResponseExample::SUMMARY": Team Get -"TeamInfoResponseExample::SUMMARY": Team Get Info -"TeamMembersResponseExample::SUMMARY": Team Members List -"TeamInvitesResponseExample::SUMMARY": Team Invites -"TeamSubTeamsResponseExample::SUMMARY": Team Sub Teams List -"TeamRemoveMemberResponseExample::SUMMARY": Team Remove Member -"TeamUpdateResponseExample::SUMMARY": Team Update -"TeamDoesNotExistResponseExample::SUMMARY": Team Does Not Exist -"Team::NAME": The name of your Team -"Team::INVITED_ACCOUNTS": 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`. -"Team::INVITED_EMAILS": A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. -"TeamGeneral::TEAM_ID": The id of a team -"TeamGeneral::NAME": The name of a team -"TeamGeneral::NUM_MEMBERS": Number of members within a team -"TeamGeneral::NUM_SUB_TEAMS": Number of sub teams within a team -"TeamResponse::DESCRIPTION": Contains information about your team and its members - -"TemplateAddUserResponseExample::SUMMARY": Add User to Template -"TemplateCreateEmbeddedDraftResponseExample::SUMMARY": Create Embedded Draft Template -"TemplateCreateResponseExample::SUMMARY": Create Template -"TemplateFilesResponseExample::SUMMARY": Template Files -"TemplateGetResponseExample::SUMMARY": Get Template -"TemplateListResponseExample::SUMMARY": List Templates -"TemplateRemoveUserResponseExample::SUMMARY": Remove User from Template -"TemplateUpdateFilesResponseExample::SUMMARY": Update Template Files - -"TemplateResponse::DESCRIPTION": Contains information about the templates you and your team have created. -"TemplateResponse::TEMPLATE_ID": The id of the Template. -"TemplateResponse::CAN_EDIT": Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). -"TemplateResponse::IS_CREATOR": "`true` if you are the owner of this template, `false` if it's been shared with you by a team member." -"TemplateResponse::IS_EMBEDDED": "`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template." -"TemplateResponse::IS_LOCKED": |- - Indicates whether the template is locked. - If `true`, then the template was created outside your quota and can only be used in `test_mode`. - If `false`, then the template is within your quota and can be used to create signature requests. -"TemplateResponse::MESSAGE": The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. -"TemplateResponse::METADATA": The metadata attached to the template. -"TemplateResponse::SIGNER_ROLES": An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. -"TemplateResponse::CC_ROLES": An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. -"TemplateResponse::DOCUMENTS": An array describing each document associated with this Template. Includes form field data for each document. -"TemplateResponse::ACCOUNTS": An array of the Accounts that can use this Template. -"TemplateResponse::TITLE": The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. -"TemplateResponse::UPDATED_AT": Time the template was last updated. - -"TemplateListResponse::DESCRIPTION": List of templates that the API caller has access to. - -"TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION": "Template object with parameters: `template_id`, `edit_url`, `expires_at`." -"TemplateCreateEmbeddedDraftResponseTemplate::EDIT_URL": Link to edit the template. -"TemplateCreateEmbeddedDraftResponseTemplate::EXPIRES_AT": When the link expires. - -"TemplateCreateEmbeddedResponseTemplate::DESCRIPTION": "Template object with parameters: `template_id`." - -"TemplateCreateResponseTemplate::DESCRIPTION": "Template object with parameters: `template_id`." - -"TemplateUpdateFilesResponseTemplate::DESCRIPTION": "Contains template id" - -"TemplateResponseAccount::ACCOUNT_ID": The id of the Account. -"TemplateResponseAccount::EMAIL_ADDRESS": The email address associated with the Account. -"TemplateResponseAccount::IS_LOCKED": Returns `true` if the user has been locked out of their account by a team admin. -"TemplateResponseAccount::IS_PAID_HS": Returns `true` if the user has a paid Dropbox Sign account. -"TemplateResponseAccount::IS_PAID_HF": Returns `true` if the user has a paid HelloFax account. -"TemplateResponseAccount::QUOTAS": An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - -"TemplateResponseAccountQuota::DESCRIPTION": An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. -"TemplateResponseAccountQuota::API_SIGNATURE_REQUESTS_LEFT": API signature requests remaining. -"TemplateResponseAccountQuota::DOCUMENTS_LEFT": Signature requests remaining. -"TemplateResponseAccountQuota::TEMPLATES_LEFT": API templates remaining. -"TemplateResponseAccountQuota::SMS_VERIFICATIONS_LEFT": SMS verifications remaining. - -"TemplateResponseCCRole::NAME": The name of the Role. - -"TemplateResponseDocument::INDEX": Document ordering, the lowest index is displayed first and the highest last (0-based indexing). -"TemplateResponseDocument::NAME": Name of the associated file. -"TemplateResponseDocument::FIELD_GROUPS": An array of Form Field Group objects. -"TemplateResponseDocument::STATIC_FIELDS": |- - An array describing static overlay fields. - **NOTE:** only available for certain subscriptions. - -"TemplateResponseCustomField::DESCRIPTION": Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. - -"TemplateResponseDocumentCustomField::DESCRIPTION": An array of Form Field objects containing the name and type of each named field. -"TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS": This class extends `TemplateResponseDocumentCustomFieldBase` -"TemplateResponseDocumentCustomField::GROUP": The name of the group this field is in. If this field is not a group, this defaults to `null`. -"TemplateResponseDocumentCustomField::HEIGHT": The height in pixels of this form field. -"TemplateResponseDocumentCustomField::NAME": The name of the Custom Field. -"TemplateResponseDocumentCustomField::REQUIRED": Boolean showing whether or not this field is required. -"TemplateResponseDocumentCustomField::TYPE": |- - The type of this Custom Field. Only `text` and `checkbox` are currently supported. - - * Text uses `TemplateResponseDocumentCustomFieldText` - * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` -"TemplateResponseDocumentCustomField::WIDTH": The width in pixels of this form field. -"TemplateResponseDocumentCustomField::X": The horizontal offset in pixels for this form field. -"TemplateResponseDocumentCustomField::Y": The vertical offset in pixels for this form field. -"TemplateResponseDocumentCustomField::FONT_SIZE": Final font size used by this form field. -"TemplateResponseDocumentCustomField::SIGNER": The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). -"TemplateResponseDocumentCustomField::API_ID": The unique ID for this field. -# text-only / hyperlink -"TemplateResponseDocumentCustomField::ORIGINAL_FONT_SIZE": Original font size used in this form field's text. -"TemplateResponseDocumentCustomField::AVG_TEXT_LENGTH": Average text length in this field. -"TemplateResponseDocumentCustomField::IS_MULTILINE": Whether this form field is multiline text. -"TemplateResponseDocumentCustomField::FONT_FAMILY": Font family used in this form field's text. - -"TemplateResponseDocumentFieldGroupRule::GROUP_LABEL": Name of the group -"TemplateResponseDocumentFieldGroupRule::REQUIREMENT": |- - 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. - -"TemplateResponseNamedFormField::DESCRIPTION": Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. - -"TemplateResponseFieldAvgTextLength::DESCRIPTION": Average text length in this field. -"TemplateResponseFieldAvgTextLength::NUM_CHARS_PER_LINE": Number of characters per line. -"TemplateResponseFieldAvgTextLength::NUM_LINES": Number of lines. - -"TemplateResponseDocumentFieldGroup::NAME": The name of the form field group. -"TemplateResponseDocumentFieldGroup::RULE": The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). - -"TemplateResponseDocumentFormField::DESCRIPTION": An array of Form Field objects containing the name and type of each named field. -"TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS": This class extends `TemplateResponseDocumentFormFieldBase` -"TemplateResponseDocumentFormField::API_ID": A unique id for the form field. -"TemplateResponseDocumentFormField::GROUP": The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. -"TemplateResponseDocumentFormField::HEIGHT": The height in pixels of this form field. -"TemplateResponseDocumentFormField::NAME": The name of the form field. -"TemplateResponseDocumentFormField::REQUIRED": Boolean showing whether or not this field is required. -"TemplateResponseDocumentFormField::TYPE": |- - The type of this form field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentFormFieldText` - * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentFormFieldRadio` - * Signature Field uses `TemplateResponseDocumentFormFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentFormFieldInitials` -"TemplateResponseDocumentFormField::SIGNER": The signer of the Form Field. -"TemplateResponseDocumentFormField::WIDTH": The width in pixels of this form field. -"TemplateResponseDocumentFormField::X": The horizontal offset in pixels for this form field. -"TemplateResponseDocumentFormField::Y": The vertical offset in pixels for this form field. -"TemplateResponseDocumentFormField::FONT_SIZE": Final font size used by this form field. -# text-only / hyperlink -"TemplateResponseDocumentFormField::ORIGINAL_FONT_SIZE": Original font size used in this form field's text. -"TemplateResponseDocumentFormField::AVG_TEXT_LENGTH": Average text length in this field. -"TemplateResponseDocumentFormField::IS_MULTILINE": Whether this form field is multiline text. -"TemplateResponseDocumentFormField::FONT_FAMILY": Font family used in this form field's text. -# text-only -"TemplateResponseDocumentFormField::VALIDATION_TYPE": Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. -"TemplateResponseDocumentFormField::CUSTOM_REGEX": When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field. -"TemplateResponseDocumentFormField::CUSTOM_REGEX_LABEL": When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern. -"TemplateResponseDocumentStaticField::DESCRIPTION": An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. -"TemplateResponseDocumentStaticField::DESCRIPTION_EXTENDS": This class extends `TemplateResponseDocumentStaticFieldBase` -"TemplateResponseDocumentStaticField::NAME": The name of the static field. -"TemplateResponseDocumentStaticField::TYPE": |- - The type of this static field. See [field types](/api/reference/constants/#field-types). - - * Text Field uses `TemplateResponseDocumentStaticFieldText` - * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` - * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` - * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` - * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` - * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` - * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` - * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` -"TemplateResponseDocumentStaticField::SIGNER": The signer of the Static Field. -"TemplateResponseDocumentStaticField::X": The horizontal offset in pixels for this static field. -"TemplateResponseDocumentStaticField::Y": The vertical offset in pixels for this static field. -"TemplateResponseDocumentStaticField::WIDTH": The width in pixels of this static field. -"TemplateResponseDocumentStaticField::HEIGHT": The height in pixels of this static field. -"TemplateResponseDocumentStaticField::REQUIRED": Boolean showing whether or not this field is required. -"TemplateResponseDocumentStaticField::API_ID": A unique id for the static field. -"TemplateResponseDocumentStaticField::GROUP": The name of the group this field is in. If this field is not a group, this defaults to `null`. -"TemplateResponseDocumentStaticField::FONT_SIZE": Final font size used by this form field. - -"TemplateResponseSignerRole::DESCRIPTION": An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. -"TemplateResponseSignerRole::NAME": The name of the Role. -"TemplateResponseSignerRole::ORDER": If signer order is assigned this is the 0-based index for this role. - -"FileResponse::FILE_URL": URL to the file. -"FileResponse::EXPIRES_AT": When the link expires. -"FileResponse::DATA_URI": File as base64 encoded string. -"FileResponse::FILE": Requested file. This field is used by SDK only. - -"UnclaimedDraftCreateResponseExample::SUMMARY": Unclaimed Draft Create -"UnclaimedDraftCreateEmbeddedResponseExample::SUMMARY": Unclaimed Draft Create Embedded -"UnclaimedDraftCreateEmbeddedWithTemplateResponseExample::SUMMARY": Unclaimed Draft Create Embedded With Template -"UnclaimedDraftEditAndResendExample::SUMMARY": Unclaimed Draft Edit and Resend -"UnclaimedDraft::CLAIM_URL": The URL to be used to claim this UnclaimedDraft. -"UnclaimedDraft::EXPIRES_AT": When the link expires. -"UnclaimedDraft::REQUESTING_REDIRECT_URL": The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.). -"UnclaimedDraft::SIGNATURE_REQUEST_ID": The ID of the signature request that is represented by this UnclaimedDraft. -"UnclaimedDraft::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign. -"UnclaimedDraft::TEST_MODE": Whether this is a test draft. Signature requests made from test drafts have no legal value. - -"UnclaimedDraftResponse::DESCRIPTION": A group of documents that a user can take ownership of via the claim URL. - -"ErrorResponseError::DESCRIPTION": Contains information about an error that occurred. -"ErrorResponseError::ERROR_MSG": Message describing an error. -"ErrorResponseError::ERROR_PATH": Path at which an error occurred. -"ErrorResponseError::ERROR_NAME": Name of the error. - -"Error::400": Error 400 bad_request -"Error::401": Error 401 unauthorized -"Error::402": Error 402 payment_required -"Error::403": Error 403 forbidden -"Error::404": Error 404 not_found -"Error::409": Error 409 conflict -"Error::410": Error 410 deleted -"Error::422": Error 422 unprocessable_entity -"Error::429": Error 429 exceeded_rate -"Error::4XX": Error 4XX failed_operation - -######################### -# SEO for API Reference # -######################### -"AccountCreate::SEO::TITLE": "Create Account | API Documentation | Dropbox Sign for Developers" -"AccountCreate::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build with a range of tools. Find out how to create a new Dropbox Sign Account using the specified `email_address` here." -"AccountGet::SEO::TITLE": "Get Account | API Documentation | Dropbox Sign for Developers" -"AccountGet::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return the properties and settings of your Account, click here." -"AccountUpdate::SEO::TITLE": "Update Account | API Documentation | Dropbox Sign for Developers" -"AccountUpdate::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build with a wide range of tools. To find out how update the properties and settings of your Account, click here." -"AccountVerify::SEO::TITLE": "Verify Account | API Documentation | Dropbox Sign for Developers" -"AccountVerify::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build with a wide range of tools. To find out how to verify whether an Account exists, click here." -"ApiAppCreate::SEO::TITLE": "Create API App | API Documentation | Dropbox Sign for Developers" -"ApiAppCreate::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to create a new API App, click here." -"ApiAppDelete::SEO::TITLE": "Delete API App | API Documentation | Dropbox Sign for Developers" -"ApiAppDelete::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to delete an API App, click here." -"ApiAppGet::SEO::TITLE": "Get API App | API Documentation | Dropbox Sign for Developers" -"ApiAppGet::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return an object with information about an API App, click here." -"ApiAppList::SEO::TITLE": "List API Apps | API Documentation | Dropbox Sign for Developers" -"ApiAppList::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return a list of API Apps that are accessible by you, click here." -"ApiAppUpdate::SEO::TITLE": "Update API App | API Documentation | Dropbox Sign for Developers" -"ApiAppUpdate::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to update an App that you own, click here." -"BulkSendJobGet::SEO::TITLE": "Get Bulk Send Job | API Documentation | Dropbox Sign for Developers" -"BulkSendJobGet::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of the BulkSendJob and SignatureRequests, click here." -"BulkSendJobList::SEO::TITLE": "List Bulk Send Jobs | Documentation | Dropbox Sign for Developers" -"BulkSendJobList::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of BulkSendJob that you can access, click here." -"EmbeddedEditUrl::SEO::TITLE": "Get Embedded Template URL | iFrame | Dropbox Sign for Developers" -"EmbeddedEditUrl::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a template url, click here." -"EmbeddedSignUrl::SEO::TITLE": "Get Embedded Sign URL | iFrame | Dropbox Sign for Developers" -"EmbeddedSignUrl::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here." -"FaxGet::SEO::TITLE": "Get Fax | API Documentation | Dropbox Fax for Developers" -"FaxGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here." -"FaxDelete::SEO::TITLE": "Delete Fax | API Documentation | Dropbox Fax for Developers" -"FaxDelete::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here." -"FaxFiles::SEO::TITLE": "Fax Files | API Documentation | Dropbox Fax for Developers" -"FaxFiles::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here." -"FaxList::SEO::TITLE": "List Faxes | API Documentation | Dropbox Fax for Developers" -"FaxList::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here." -"FaxSend::SEO::TITLE": "Send Fax | API Documentation | Dropbox Fax for Developers" -"FaxSend::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here." -"FaxLineAddUser::SEO::TITLE": "Fax Line Add User | API Documentation | Dropbox Fax for Developers" -"FaxLineAddUser::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here." -"FaxLineAreaCodeGet::SEO::TITLE": "Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers" -"FaxLineAreaCodeGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here." -"FaxLineCreate::SEO::TITLE": "Purchase Fax Line | API Documentation | Dropbox Fax for Developers" -"FaxLineCreate::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here." -"FaxLineDelete::SEO::TITLE": "Delete Fax Line | API Documentation | Dropbox Fax for Developers" -"FaxLineDelete::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here." -"FaxLineGet::SEO::TITLE": "Get Fax Line | API Documentation | Dropbox Fax for Developers" -"FaxLineGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here." -"FaxLineList::SEO::TITLE": "List Fax Lines | API Documentation | Dropbox Fax for Developers" -"FaxLineList::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here." -"FaxLineRemoveUser::SEO::TITLE": "Fax Line Remove User | API Documentation | Dropbox Fax for Developers" -"FaxLineRemoveUser::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here." -"OAuthTokenGenerate::SEO::TITLE": "Generate OAuth Token | Documentation | Dropbox Sign for Developers" -"OAuthTokenGenerate::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to generate a new OAuth token with the API, click here." -"OAuthTokenRefresh::SEO::TITLE": "OAuth Token Refresh | Documentation | Dropbox Sign for Developers" -"OAuthTokenRefresh::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to refresh your OAuth token with the API, click here." -"ReportCreate::SEO::TITLE": "Create Report | API Documentation | Dropbox Sign for Developers" -"ReportCreate::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to request the creation of one or more reports, click here." -"SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::TITLE": "Embedded Bulk Send with Template | Dropbox Sign for Developers" -"SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::DESCRIPTION": "The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create embedded BulkSendJob signature requests, click here." -"SignatureRequestBulkSendWithTemplate::SEO::TITLE": "Bulk Send with Template | REST API | Dropbox Sign for Developers" -"SignatureRequestBulkSendWithTemplate::SEO::DESCRIPTION": "The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create BulkSendJob for up to 250 signature requests, click here." -"SignatureRequestCancel::SEO::TITLE": "Cancel Incomplete Signature Request | Dropbox Sign for Developers" -"SignatureRequestCancel::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to cancel an incomplete signature request, click here." -"SignatureRequestCreateEmbedded::SEO::TITLE": "Create Embedded Signature Request | Dropbox Sign for Developers" -"SignatureRequestCreateEmbedded::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new SignatureRequest in an iFrame, click here." -"SignatureRequestEditEmbedded::SEO::TITLE": "Edit Embedded Signature Request | Dropbox Sign for Developers" -"SignatureRequestEditEmbedded::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here." -"SignatureRequestCreateEmbeddedWithTemplate::SEO::TITLE": "Signature Request with Template | Dropbox Sign for Developers" -"SignatureRequestCreateEmbeddedWithTemplate::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here." -"SignatureRequestEditEmbeddedWithTemplate::SEO::TITLE": "Signature Request with Template | Dropbox Sign for Developers" -"SignatureRequestEditEmbeddedWithTemplate::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here." -"SignatureRequestFiles::SEO::TITLE": "Download Files | API Documentation | Dropbox Sign for Developers" -"SignatureRequestFiles::SEO::DESCRIPTION": "The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here" -"SignatureRequestGet::SEO::TITLE": "Get Signature Request | Documentation | Dropbox Sign for Developers" -"SignatureRequestGet::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here." -"SignatureRequestList::SEO::TITLE": "List Signature Requests | REST API | Dropbox Sign for Developers" -"SignatureRequestList::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here." -"SignatureRequestReleaseHold::SEO::TITLE": "Release On-Hold Signature Request | Dropbox Sign for Developers" -"SignatureRequestReleaseHold::SEO::DESCRIPTION": "The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here." -"SignatureRequestRemind::SEO::TITLE": "Send Request Reminder | REST API | Dropbox Sign for Developers" -"SignatureRequestRemind::SEO::DESCRIPTION": "The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here." -"SignatureRequestRemove::SEO::TITLE": "Remove Signature Request Access | Dropbox Sign for Developers" -"SignatureRequestRemove::SEO::DESCRIPTION": "The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here." -"SignatureRequestSend::SEO::TITLE": "Send Signature Request | REST API | Dropbox Sign for Developers" -"SignatureRequestSend::SEO::DESCRIPTION": "Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here." -"SignatureRequestEdit::SEO::TITLE": "Edit Signature Request | REST API | Dropbox Sign for Developers" -"SignatureRequestEdit::SEO::DESCRIPTION": "Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here." -"SignatureRequestSendWithTemplate::SEO::TITLE": "Send with Template | API Documentation | Dropbox Sign for Developers" -"SignatureRequestSendWithTemplate::SEO::DESCRIPTION": "Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here." -"SignatureRequestEditWithTemplate::SEO::TITLE": "Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers" -"SignatureRequestEditWithTemplate::SEO::DESCRIPTION": "Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here." -"SignatureRequestUpdate::SEO::TITLE": "Update Signature Request | REST API | Dropbox Sign for Developers" -"SignatureRequestUpdate::SEO::DESCRIPTION": "Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here." -"TeamAddMember::SEO::TITLE": "Add User to Team | API Documentation | Dropbox Sign for Developers" -"TeamAddMember::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here." -"TeamCreate::SEO::TITLE": "Create Team | REST API Documentation | Dropbox Sign for Developers" -"TeamCreate::SEO::DESCRIPTION": "The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here." -"TeamDelete::SEO::TITLE": "Delete Team | REST API Documentation | Dropbox Sign for Developers" -"TeamDelete::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here." -"TeamGet::SEO::TITLE": "Get Team | REST API Documentation | Dropbox Sign for Developers" -"TeamGet::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here." -"TeamInfo::SEO::TITLE": "Get Team Info | Dropbox Sign for Developers" -"TeamInfo::SEO::DESCRIPTION": "The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here." -"TeamInvites::SEO::TITLE": "List Team Invites | Dropbox Sign for Developers" -"TeamInvites::SEO::DESCRIPTION": "The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here." -"TeamMembers::SEO::TITLE": "List Team Members | Dropbox Sign for Developers" -"TeamMembers::SEO::DESCRIPTION": "The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here." -"TeamRemoveMember::SEO::TITLE": "Remove User from Team | REST API | Dropbox Sign for Developers" -"TeamRemoveMember::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here." -"TeamSubTeams::SEO::TITLE": "List Sub Teams | Dropbox Sign for Developers" -"TeamSubTeams::SEO::DESCRIPTION": "The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here." -"TeamUpdate::SEO::TITLE": "Update Team | API Documentation | Dropbox Sign for Developers" -"TeamUpdate::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here." -"TemplateAddUser::SEO::TITLE": "Add User to Template | REST API | Dropbox Sign for Developers" -"TemplateAddUser::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here." -"TemplateCreateEmbeddedDraft::SEO::TITLE": "Create Embedded Template Draft | Dropbox Sign for Developers" -"TemplateCreateEmbeddedDraft::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here." -"TemplateCreate::SEO::TITLE": "Create Template | Dropbox Sign for Developers" -"TemplateCreate::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here." -"TemplateDelete::SEO::TITLE": "Delete Template | API Documentation | Dropbox Sign for Developers" -"TemplateDelete::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here." -"TemplateFiles::SEO::TITLE": "Get Template Files | API Documentation | Dropbox Sign for Developers" -"TemplateFiles::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here." -"TemplateGet::SEO::TITLE": "Get Template | API Documentation | Dropbox Sign for Developers" -"TemplateGet::SEO::DESCRIPTION": "The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here." -"TemplateList::SEO::TITLE": "List Templates | API Documentation | Dropbox Sign for Developers" -"TemplateList::SEO::DESCRIPTION": "The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here." -"TemplateRemoveUser::SEO::TITLE": "Remove User from Template | REST API | Dropbox Sign for Developers" -"TemplateRemoveUser::SEO::DESCRIPTION": "The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account's access to a Template, click here." -"TemplateUpdateFiles::SEO::TITLE": "Update Template Files | REST API | Dropbox Sign for Developers" -"TemplateUpdateFiles::SEO::DESCRIPTION": "Overlays a new file with the overlay of an existing template" -"UnclaimedDraftCreate::SEO::TITLE": "Create Unclaimed Draft | REST API | Dropbox Sign for Developers" -"UnclaimedDraftCreate::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here." -"UnclaimedDraftCreateEmbedded::SEO::TITLE": "Create Embedded Unclaimed Draft | Dropbox Sign for Developers" -"UnclaimedDraftCreateEmbedded::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here." -"UnclaimedDraftCreateEmbeddedWithTemplate::SEO::TITLE": "Embed Unclaimed Draft with Template | Dropbox Sign for Developers" -"UnclaimedDraftCreateEmbeddedWithTemplate::SEO::DESCRIPTION": "The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here." -"UnclaimedDraftEditAndResend::SEO::TITLE": "Edit and Resend Unclaimed Draft | Dropbox Sign for Developers" -"UnclaimedDraftEditAndResend::SEO::DESCRIPTION": "The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here." -"accountUpdateEventCallback::SEO::TITLE": "Account Callbacks | API Documentation | Dropbox Sign for Developers" -"accountUpdateEventCallback::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the account level, click here." -"appCreateEventCallback::SEO::TITLE": "App Callbacks | API Documentation | Dropbox Sign for Developers" -"appCreateEventCallback::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the App level, click here."