diff --git a/openapi-raw.yaml b/openapi-raw.yaml index fcbb4baa2..d0d32bbee 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -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 @@ -8177,6 +8181,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 +8364,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 +8480,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 +8754,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 +9909,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 +10001,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 +10151,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 +10270,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 diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 881f4e4da..ea8e2fcb2 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -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 @@ -8361,6 +8365,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`. @@ -8595,6 +8603,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`. @@ -8751,6 +8763,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`. @@ -9092,6 +9108,10 @@ 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' type: array @@ -10475,6 +10495,10 @@ 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' type: array @@ -10591,6 +10615,10 @@ 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' type: array @@ -10772,6 +10800,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 attachments: description: 'A list describing the attachments' type: array @@ -10918,6 +10950,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`. diff --git a/openapi.yaml b/openapi.yaml index bb5851ebe..b499d7c1d 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -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 @@ -8361,6 +8365,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`. @@ -8595,6 +8603,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`. @@ -8751,6 +8763,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`. @@ -9092,6 +9108,10 @@ 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' type: array @@ -10453,6 +10473,10 @@ 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' type: array @@ -10569,6 +10593,10 @@ 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' type: array @@ -10750,6 +10778,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 attachments: description: 'A list describing the attachments' type: array @@ -10896,6 +10928,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`. 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/SignatureRequestCreateEmbeddedRequest.md b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md index babeb4eb2..72691fc6d 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) | 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]**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) | 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] [[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..d43f04d2e 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) | 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]**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) | 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] [[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..6817506b5 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) | 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]**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) | 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] [[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..cc8636f7d 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) | 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]**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) | 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] [[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..ddc4f561f 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) | 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] [[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..e1d8d3a95 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) | 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] [[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..253a166ea 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) | 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] [[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..544c77356 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) | 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] [[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/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/SignatureRequestCreateEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs index 310802209..873106832 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs @@ -46,6 +46,7 @@ protected SignatureRequestCreateEmbeddedRequest() { } /// 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.. /// 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. /// The email addresses that should be CCed.. @@ -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; @@ -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. /// @@ -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/SignatureRequestEditEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs index 68a03290b..67f19385b 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs @@ -46,6 +46,7 @@ protected SignatureRequestEditEmbeddedRequest() { } /// 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.. /// 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. /// The email addresses that should be CCed.. @@ -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; @@ -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. /// @@ -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/SignatureRequestEditRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs index f239fcf60..04e30e565 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs @@ -46,6 +46,7 @@ protected SignatureRequestEditRequest() { } /// 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.. /// 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. /// The email addresses that should be CCed.. @@ -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; @@ -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. /// @@ -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/SignatureRequestSendRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs index 51c0d97a0..73345fca1 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs @@ -47,6 +47,7 @@ protected SignatureRequestSendRequest() { } /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. /// 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). + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// A list describing the attachments. /// 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.. @@ -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; @@ -156,6 +158,13 @@ public static SignatureRequestSendRequest Init(string jsonData) [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] public bool AllowReassign { 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; } + /// /// A list describing the attachments /// @@ -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/TemplateCreateEmbeddedDraftRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs index 4220dc5df..b38a569b8 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs @@ -45,6 +45,7 @@ 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). + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// A list describing the attachments. /// 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). @@ -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; @@ -152,6 +154,13 @@ public static TemplateCreateEmbeddedDraftRequest Init(string jsonData) [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] public bool AllowReassign { 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; } + /// /// A list describing the attachments /// @@ -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/TemplateCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs index 5db1a03e2..28ec223fc 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs @@ -44,6 +44,7 @@ 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). + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// A list describing the attachments. /// 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.. @@ -59,7 +60,7 @@ protected TemplateCreateRequest() { } /// 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; @@ -143,6 +145,13 @@ public static TemplateCreateRequest Init(string jsonData) [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] public bool AllowReassign { 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; } + /// /// A list describing the attachments /// @@ -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/UnclaimedDraftCreateEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs index 00ece6767..bc8f9faef 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs @@ -72,6 +72,7 @@ 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. /// The email addresses that should be CCed.. @@ -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. /// @@ -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/UnclaimedDraftCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs index 065407e17..cbb15270e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs @@ -71,6 +71,7 @@ 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). + /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// A list describing the attachments. /// 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.. @@ -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; @@ -158,6 +160,13 @@ public static UnclaimedDraftCreateRequest 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; } + /// /// A list describing the attachments /// @@ -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/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/SignatureRequestCreateEmbeddedRequest.md b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md index 383f8a8f3..9603d8c90 100644 --- a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md @@ -14,6 +14,7 @@ | `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. | | | `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 | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md index dd8b06061..ff55ceb57 100644 --- a/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md @@ -14,6 +14,7 @@ | `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. | | | `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 | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v1/docs/SignatureRequestEditRequest.md b/sdks/java-v1/docs/SignatureRequestEditRequest.md index 7fa3aca65..fe879e3a8 100644 --- a/sdks/java-v1/docs/SignatureRequestEditRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditRequest.md @@ -13,6 +13,7 @@ | `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. | | | `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 | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v1/docs/SignatureRequestSendRequest.md b/sdks/java-v1/docs/SignatureRequestSendRequest.md index 914303935..f55d3b2f4 100644 --- a/sdks/java-v1/docs/SignatureRequestSendRequest.md +++ b/sdks/java-v1/docs/SignatureRequestSendRequest.md @@ -14,6 +14,7 @@ | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `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. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `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. | | diff --git a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md index 05f2497fc..40b9e6ca6 100644 --- a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md @@ -13,6 +13,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. | | | `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. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | diff --git a/sdks/java-v1/docs/TemplateCreateRequest.md b/sdks/java-v1/docs/TemplateCreateRequest.md index 5f99510d9..49525aa4c 100644 --- a/sdks/java-v1/docs/TemplateCreateRequest.md +++ b/sdks/java-v1/docs/TemplateCreateRequest.md @@ -13,6 +13,7 @@ | `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. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `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. | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md index aab362d77..b8d496953 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -14,6 +14,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. | | | `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 | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md b/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md index f23c6f4ba..852847b61 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md @@ -12,6 +12,7 @@ | `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`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `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. | | 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/SignatureRequestCreateEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java index 8e1987c37..584b42cb2 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; @@ -331,6 +335,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; @@ -874,6 +902,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 +948,7 @@ public int hashCode() { signers, groupedSigners, allowDecline, + allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -948,6 +979,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 +1126,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/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java index 752946426..d6a528648 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; @@ -329,6 +333,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; @@ -870,6 +898,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 +941,7 @@ public int hashCode() { signers, groupedSigners, allowDecline, + allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -941,6 +972,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 +1119,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/SignatureRequestEditRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java index 0173d32e5..9fa77a0d9 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; @@ -306,6 +310,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; @@ -882,6 +910,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 +945,7 @@ public int hashCode() { signers, groupedSigners, allowDecline, + allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -947,6 +977,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 +1106,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/SignatureRequestSendRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index 252b39102..b12da8906 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; @@ -335,6 +339,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; @@ -918,6 +946,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 +983,7 @@ public int hashCode() { groupedSigners, allowDecline, allowReassign, + allowFormView, attachments, ccEmailAddresses, clientId, @@ -986,6 +1016,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 +1167,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/TemplateCreateEmbeddedDraftRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java index 0061bf657..a57c84d16 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; @@ -867,6 +895,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 +940,7 @@ public int hashCode() { fileUrls, allowCcs, allowReassign, + allowFormView, attachments, ccRoles, editorOptions, @@ -941,6 +972,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 +1107,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/TemplateCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java index 8e3815a5b..fee8ea562 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; @@ -665,6 +692,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 +717,7 @@ public int hashCode() { files, fileUrls, allowReassign, + allowFormView, attachments, ccRoles, clientId, @@ -715,6 +744,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 +870,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/UnclaimedDraftCreateEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java index 4b758039a..d3bd9a81d 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; @@ -1245,6 +1273,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 +1342,7 @@ public int hashCode() { fileUrls, allowCcs, allowDecline, + allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -1356,6 +1387,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 +1564,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/UnclaimedDraftCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java index 0b0b6b61b..cf104bb0f 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; @@ -891,6 +919,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 +955,7 @@ public int hashCode() { files, fileUrls, allowDecline, + allowFormView, attachments, ccEmailAddresses, clientId, @@ -956,6 +986,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 +1099,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-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/SignatureRequestCreateEmbeddedRequest.md b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md index 383f8a8f3..9603d8c90 100644 --- a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md @@ -14,6 +14,7 @@ | `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. | | | `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 | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md index dd8b06061..ff55ceb57 100644 --- a/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md @@ -14,6 +14,7 @@ | `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. | | | `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 | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v2/docs/SignatureRequestEditRequest.md b/sdks/java-v2/docs/SignatureRequestEditRequest.md index 7fa3aca65..fe879e3a8 100644 --- a/sdks/java-v2/docs/SignatureRequestEditRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditRequest.md @@ -13,6 +13,7 @@ | `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. | | | `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 | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v2/docs/SignatureRequestSendRequest.md b/sdks/java-v2/docs/SignatureRequestSendRequest.md index 914303935..f55d3b2f4 100644 --- a/sdks/java-v2/docs/SignatureRequestSendRequest.md +++ b/sdks/java-v2/docs/SignatureRequestSendRequest.md @@ -14,6 +14,7 @@ | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `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. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `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. | | diff --git a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md index 05f2497fc..40b9e6ca6 100644 --- a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md @@ -13,6 +13,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. | | | `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. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | diff --git a/sdks/java-v2/docs/TemplateCreateRequest.md b/sdks/java-v2/docs/TemplateCreateRequest.md index 5f99510d9..49525aa4c 100644 --- a/sdks/java-v2/docs/TemplateCreateRequest.md +++ b/sdks/java-v2/docs/TemplateCreateRequest.md @@ -13,6 +13,7 @@ | `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. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `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. | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md index aab362d77..b8d496953 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -14,6 +14,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. | | | `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 | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md b/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md index f23c6f4ba..852847b61 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md @@ -12,6 +12,7 @@ | `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`. | | +| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `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. | | 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/SignatureRequestCreateEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java index 3002deccd..0bee462ff 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; @@ -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; @@ -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/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java index 9a40b64a2..eba905c04 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; @@ -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; @@ -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/SignatureRequestEditRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java index 719a6b457..9a48397ba 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; @@ -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; @@ -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/SignatureRequestSendRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index a76ab911f..68364f8cc 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; @@ -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; @@ -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/TemplateCreateEmbeddedDraftRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java index d7786dade..943d6c684 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; @@ -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/TemplateCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java index 2a353e0ec..eeb04d082 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; @@ -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/UnclaimedDraftCreateEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java index 0c762b684..07817eb8c 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; @@ -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/UnclaimedDraftCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java index 58a73751a..4c97368c0 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; @@ -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/node/dist/api.js b/sdks/node/dist/api.js index 943de1b8c..157a8e993 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -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", @@ -19514,6 +19523,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 +19583,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 +19809,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 +19869,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 +20095,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 +20150,11 @@ var SignatureRequestEditRequest = class _SignatureRequestEditRequest { baseName: "allow_decline", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "allowReassign", baseName: "allow_reassign", @@ -21333,6 +21369,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 +21431,11 @@ var SignatureRequestSendRequest = class _SignatureRequestSendRequest { baseName: "allow_reassign", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "attachments", baseName: "attachments", @@ -23916,6 +23961,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 +24024,11 @@ var TemplateCreateEmbeddedDraftRequest = class _TemplateCreateEmbeddedDraftReque baseName: "allow_reassign", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "attachments", baseName: "attachments", @@ -24168,6 +24222,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 +24265,11 @@ var TemplateCreateRequest = class _TemplateCreateRequest { baseName: "allow_reassign", type: "boolean" }, + { + name: "allowFormView", + baseName: "allow_form_view", + type: "boolean" + }, { name: "attachments", baseName: "attachments", @@ -25930,6 +25993,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 +26085,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 +26493,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 +26543,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/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/SignatureRequestCreateEmbeddedRequest.md b/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md index d8cbf1583..e58badd77 100644 --- a/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes | `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. | | | `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 | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md index bcc66ecf9..57cc9072c 100644 --- a/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes | `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. | | | `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 | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/node/docs/model/SignatureRequestEditRequest.md b/sdks/node/docs/model/SignatureRequestEditRequest.md index 309384652..9101bceb8 100644 --- a/sdks/node/docs/model/SignatureRequestEditRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditRequest.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes | `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. | | | `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 | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/node/docs/model/SignatureRequestSendRequest.md b/sdks/node/docs/model/SignatureRequestSendRequest.md index b35df0d86..12c5ba689 100644 --- a/sdks/node/docs/model/SignatureRequestSendRequest.md +++ b/sdks/node/docs/model/SignatureRequestSendRequest.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes | `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `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] | +| `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) | A list describing the attachments | | | `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. | | diff --git a/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md b/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md index 0a6d8c813..ac245615e 100644 --- a/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md @@ -11,6 +11,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. | | | `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] | +| `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) | A list describing the attachments | | | `ccRoles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | diff --git a/sdks/node/docs/model/TemplateCreateRequest.md b/sdks/node/docs/model/TemplateCreateRequest.md index 738ed648d..a2c29278e 100644 --- a/sdks/node/docs/model/TemplateCreateRequest.md +++ b/sdks/node/docs/model/TemplateCreateRequest.md @@ -11,6 +11,7 @@ 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] | +| `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) | A list describing the attachments | | | `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. | | diff --git a/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md index 444d8d77c..618e12691 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md @@ -12,6 +12,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. | | | `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 | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/node/docs/model/UnclaimedDraftCreateRequest.md b/sdks/node/docs/model/UnclaimedDraftCreateRequest.md index 255cbe395..c3bf22440 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateRequest.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateRequest.md @@ -10,6 +10,7 @@ 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] | +| `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) | A list describing the attachments | | | `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. | | 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/signatureRequestCreateEmbeddedRequest.ts b/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts index 774cbec6c..974ac6951 100644 --- a/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts +++ b/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts @@ -58,6 +58,10 @@ export class SignatureRequestCreateEmbeddedRequest { * 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. */ @@ -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/signatureRequestEditEmbeddedRequest.ts b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts index 78b05c0ac..268e9efbe 100644 --- a/sdks/node/model/signatureRequestEditEmbeddedRequest.ts +++ b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts @@ -58,6 +58,10 @@ export class SignatureRequestEditEmbeddedRequest { * 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. */ @@ -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/signatureRequestEditRequest.ts b/sdks/node/model/signatureRequestEditRequest.ts index 432e8fe4f..06dc4e5b9 100644 --- a/sdks/node/model/signatureRequestEditRequest.ts +++ b/sdks/node/model/signatureRequestEditRequest.ts @@ -54,6 +54,10 @@ export class SignatureRequestEditRequest { * 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. */ @@ -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/signatureRequestSendRequest.ts b/sdks/node/model/signatureRequestSendRequest.ts index 75720c17b..2bb32dd4e 100644 --- a/sdks/node/model/signatureRequestSendRequest.ts +++ b/sdks/node/model/signatureRequestSendRequest.ts @@ -58,6 +58,10 @@ export 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. */ "allowReassign"?: boolean = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; /** * A list describing the attachments */ @@ -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/templateCreateEmbeddedDraftRequest.ts b/sdks/node/model/templateCreateEmbeddedDraftRequest.ts index 657fa7c86..aebfaae1e 100644 --- a/sdks/node/model/templateCreateEmbeddedDraftRequest.ts +++ b/sdks/node/model/templateCreateEmbeddedDraftRequest.ts @@ -53,6 +53,10 @@ export class TemplateCreateEmbeddedDraftRequest { * 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; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; /** * A list describing the attachments */ @@ -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/templateCreateRequest.ts b/sdks/node/model/templateCreateRequest.ts index 66701c09e..7a334774b 100644 --- a/sdks/node/model/templateCreateRequest.ts +++ b/sdks/node/model/templateCreateRequest.ts @@ -52,6 +52,10 @@ export 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. */ "allowReassign"?: boolean = false; + /** + * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + */ + "allowFormView"?: boolean = false; /** * A list describing the attachments */ @@ -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/unclaimedDraftCreateEmbeddedRequest.ts b/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts index 950f3c5c1..8ae381e22 100644 --- a/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts +++ b/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts @@ -61,6 +61,10 @@ 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. */ @@ -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/unclaimedDraftCreateRequest.ts b/sdks/node/model/unclaimedDraftCreateRequest.ts index cac96a626..61aefcd55 100644 --- a/sdks/node/model/unclaimedDraftCreateRequest.ts +++ b/sdks/node/model/unclaimedDraftCreateRequest.ts @@ -52,6 +52,10 @@ export class UnclaimedDraftCreateRequest { * 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; /** * A list describing the attachments */ @@ -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/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/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/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/SignatureRequestCreateEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md index a953bcbc2..289707f27 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes | `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. | | | `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 | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | diff --git a/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md index b2567ac3f..09b9795f1 100644 --- a/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes | `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. | | | `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 | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | diff --git a/sdks/php/docs/Model/SignatureRequestEditRequest.md b/sdks/php/docs/Model/SignatureRequestEditRequest.md index 0d3ca23ce..c108f36ff 100644 --- a/sdks/php/docs/Model/SignatureRequestEditRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditRequest.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes | `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. | | | `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 | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | diff --git a/sdks/php/docs/Model/SignatureRequestSendRequest.md b/sdks/php/docs/Model/SignatureRequestSendRequest.md index 65d3a7d91..c117edd10 100644 --- a/sdks/php/docs/Model/SignatureRequestSendRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendRequest.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes | `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. | | | `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] | +| `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) | A list describing the attachments | | | `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. | | diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md index d9ef188de..3b59a8cd9 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md @@ -11,6 +11,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. | | | `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] | +| `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) | A list describing the attachments | | | `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) | | | diff --git a/sdks/php/docs/Model/TemplateCreateRequest.md b/sdks/php/docs/Model/TemplateCreateRequest.md index 1a4b677f1..9f0130234 100644 --- a/sdks/php/docs/Model/TemplateCreateRequest.md +++ b/sdks/php/docs/Model/TemplateCreateRequest.md @@ -11,6 +11,7 @@ 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] | +| `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) | A list describing the attachments | | | `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. | | diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md index 4d9b2c5c4..e9ae156b0 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md @@ -12,6 +12,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. | | | `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 | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md index afcb4a779..6dd305754 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md @@ -10,6 +10,7 @@ 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] | +| `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) | A list describing the attachments | | | `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. | | 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/SignatureRequestCreateEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php index badc3ea00..258d3fdaa 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); @@ -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 * diff --git a/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php index cb0190f9c..8284fcbb7 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); @@ -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 * diff --git a/sdks/php/src/Model/SignatureRequestEditRequest.php b/sdks/php/src/Model/SignatureRequestEditRequest.php index 131a3e4c4..63d91f6c7 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); @@ -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 * diff --git a/sdks/php/src/Model/SignatureRequestSendRequest.php b/sdks/php/src/Model/SignatureRequestSendRequest.php index f381a8d85..ce6a7446e 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); @@ -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 * diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php index 79ce3b26a..125f67f1b 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 * diff --git a/sdks/php/src/Model/TemplateCreateRequest.php b/sdks/php/src/Model/TemplateCreateRequest.php index ddeab0295..e13974cdf 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 * diff --git a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php index 9d42586b0..7e363a650 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 * diff --git a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php index 89b665f5c..0acf0a1a1 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 * 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/SignatureRequestCreateEmbeddedRequest.md b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md index 9f2fe0584..a49234d0f 100644 --- a/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes | `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. | | | `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 | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | diff --git a/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md index 5165d1da6..0e4918320 100644 --- a/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes | `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. | | | `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 | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | diff --git a/sdks/python/docs/SignatureRequestEditRequest.md b/sdks/python/docs/SignatureRequestEditRequest.md index b4d9783d6..df4ca3064 100644 --- a/sdks/python/docs/SignatureRequestEditRequest.md +++ b/sdks/python/docs/SignatureRequestEditRequest.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes | `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. | | | `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 | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | diff --git a/sdks/python/docs/SignatureRequestSendRequest.md b/sdks/python/docs/SignatureRequestSendRequest.md index 54e5d9d4c..ac844d8c7 100644 --- a/sdks/python/docs/SignatureRequestSendRequest.md +++ b/sdks/python/docs/SignatureRequestSendRequest.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes | `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `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] | +| `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) | A list describing the attachments | | | `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. | | diff --git a/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md index c63d97184..6726090ef 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md @@ -10,6 +10,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. | | | `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] | +| `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) | A list describing the attachments | | | `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) | | | diff --git a/sdks/python/docs/TemplateCreateRequest.md b/sdks/python/docs/TemplateCreateRequest.md index a5341c381..177b656b9 100644 --- a/sdks/python/docs/TemplateCreateRequest.md +++ b/sdks/python/docs/TemplateCreateRequest.md @@ -10,6 +10,7 @@ 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] | +| `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) | A list describing the attachments | | | `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. | | diff --git a/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md index 49704d25b..9e10bd844 100644 --- a/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -11,6 +11,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. | | | `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 | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | diff --git a/sdks/python/docs/UnclaimedDraftCreateRequest.md b/sdks/python/docs/UnclaimedDraftCreateRequest.md index 2d84e6ea7..d2893afb0 100644 --- a/sdks/python/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateRequest.md @@ -9,6 +9,7 @@ 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] | +| `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) | A list describing the attachments | | | `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. | | 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/signature_request_create_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py index 72ef4be80..d1e40719d 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 @@ -79,6 +79,10 @@ class SignatureRequestCreateEmbeddedRequest(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.", @@ -150,6 +154,7 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): "signers", "grouped_signers", "allow_decline", + "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -312,6 +317,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 +418,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_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py index 6e952ad78..68f16138a 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 @@ -79,6 +79,10 @@ class SignatureRequestEditEmbeddedRequest(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.", @@ -150,6 +154,7 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): "signers", "grouped_signers", "allow_decline", + "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -312,6 +317,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 +418,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_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_request.py index 4bd18cf01..27e8299dc 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_request.py @@ -76,6 +76,10 @@ class SignatureRequestEditRequest(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.", @@ -154,6 +158,7 @@ class SignatureRequestEditRequest(BaseModel): "signers", "grouped_signers", "allow_decline", + "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -317,6 +322,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 +420,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_send_request.py b/sdks/python/dropbox_sign/models/signature_request_send_request.py index d1f7b7280..e3cf14008 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_request.py @@ -80,6 +80,10 @@ 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" ) @@ -159,6 +163,7 @@ class SignatureRequestSendRequest(BaseModel): "grouped_signers", "allow_decline", "allow_reassign", + "allow_form_view", "attachments", "cc_email_addresses", "client_id", @@ -327,6 +332,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 +431,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/template_create_embedded_draft_request.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py index 808ba1ce8..cbf1ff24f 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,6 +64,10 @@ 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" ) @@ -141,6 +145,7 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): "file_urls", "allow_ccs", "allow_reassign", + "allow_form_view", "attachments", "cc_roles", "editor_options", @@ -285,6 +290,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 +404,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_request.py b/sdks/python/dropbox_sign/models/template_create_request.py index 532027646..349193c3e 100644 --- a/sdks/python/dropbox_sign/models/template_create_request.py +++ b/sdks/python/dropbox_sign/models/template_create_request.py @@ -62,6 +62,10 @@ 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" ) @@ -114,6 +118,7 @@ class TemplateCreateRequest(BaseModel): "files", "file_urls", "allow_reassign", + "allow_form_view", "attachments", "cc_roles", "client_id", @@ -257,6 +262,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 +334,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/unclaimed_draft_create_embedded_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py index 53527e34c..0b69ecc1a 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,6 +75,10 @@ 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.", @@ -191,6 +195,7 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): "file_urls", "allow_ccs", "allow_decline", + "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -361,6 +366,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 +522,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_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py index 49a7aeec3..9c74b2fe4 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py @@ -67,6 +67,10 @@ 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" ) @@ -144,6 +148,7 @@ class UnclaimedDraftCreateRequest(BaseModel): "files", "file_urls", "allow_decline", + "allow_form_view", "attachments", "cc_email_addresses", "client_id", @@ -294,6 +299,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 +407,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/tests/test_signature_request_api.py b/sdks/python/tests/test_signature_request_api.py index 53f7fc362..3bf40b572 100644 --- a/sdks/python/tests/test_signature_request_api.py +++ b/sdks/python/tests/test_signature_request_api.py @@ -131,9 +131,9 @@ def test_init_allows_jsony_chars_in_strings(self): fields = self.mock_pool.get_fields() - title_result = fields[9] - subject_result = fields[7] - message_result = fields[6] + title_result = fields[10] + subject_result = fields[8] + message_result = fields[7] self.assertEqual(title_result[1], title) self.assertEqual(subject_result[1], subject) 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/SignatureRequestCreateEmbeddedRequest.md b/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md index 72ba0eed1..abda999ce 100644 --- a/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md @@ -12,6 +12,7 @@ | `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. | | | `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 | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md index 383cd8e89..91bfc59db 100644 --- a/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md @@ -12,6 +12,7 @@ | `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. | | | `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 | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/ruby/docs/SignatureRequestEditRequest.md b/sdks/ruby/docs/SignatureRequestEditRequest.md index 39d575aa3..97f790ab0 100644 --- a/sdks/ruby/docs/SignatureRequestEditRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditRequest.md @@ -11,6 +11,7 @@ | `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. | | | `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 | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/ruby/docs/SignatureRequestSendRequest.md b/sdks/ruby/docs/SignatureRequestSendRequest.md index 683075e13..34d35db42 100644 --- a/sdks/ruby/docs/SignatureRequestSendRequest.md +++ b/sdks/ruby/docs/SignatureRequestSendRequest.md @@ -12,6 +12,7 @@ | `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `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] | +| `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) | A list describing the attachments | | | `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. | | diff --git a/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md index d23e4cea8..e45a426f5 100644 --- a/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md @@ -11,6 +11,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. | | | `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] | +| `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) | A list describing the attachments | | | `cc_roles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | diff --git a/sdks/ruby/docs/TemplateCreateRequest.md b/sdks/ruby/docs/TemplateCreateRequest.md index 35e9df09e..bef420aa6 100644 --- a/sdks/ruby/docs/TemplateCreateRequest.md +++ b/sdks/ruby/docs/TemplateCreateRequest.md @@ -11,6 +11,7 @@ | `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] | +| `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) | A list describing the attachments | | | `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. | | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md index 47acc3977..7cf4f9a75 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -12,6 +12,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. | | | `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 | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateRequest.md b/sdks/ruby/docs/UnclaimedDraftCreateRequest.md index 3eeacd59f..cd7ffb1ee 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateRequest.md @@ -10,6 +10,7 @@ | `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] | +| `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) | A list describing the attachments | | | `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. | | 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/signature_request_create_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb index 9ea538769..a8f371136 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 @@ -42,6 +42,10 @@ 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 @@ -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_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb index eb9ece9ee..b6f60f43e 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 @@ -42,6 +42,10 @@ 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 @@ -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_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb index 299dc7033..42f3de3fa 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 @@ -38,6 +38,10 @@ 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 @@ -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_send_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb index 1bfe729ab..13c44b53b 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 @@ -42,6 +42,10 @@ class SignatureRequestSendRequest # @return [Boolean] attr_accessor :allow_reassign + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + # A list describing the attachments # @return [Array] attr_accessor :attachments @@ -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/template_create_embedded_draft_request.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb index 4b006bdac..88110b218 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,6 +38,10 @@ class TemplateCreateEmbeddedDraftRequest # @return [Boolean] attr_accessor :allow_reassign + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + # A list describing the attachments # @return [Array] attr_accessor :attachments @@ -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_request.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb index 2376b7867..0d47159f5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb @@ -38,6 +38,10 @@ class TemplateCreateRequest # @return [Boolean] attr_accessor :allow_reassign + # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + # @return [Boolean] + attr_accessor :allow_form_view + # A list describing the attachments # @return [Array] attr_accessor :attachments @@ -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/unclaimed_draft_create_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb index 210aae825..9d0495a59 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,6 +43,10 @@ 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 @@ -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_request.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb index 3aa84129f..2d8fd3027 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,6 +35,10 @@ class UnclaimedDraftCreateRequest # @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 + # A list describing the attachments # @return [Array] attr_accessor :attachments @@ -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/test_fixtures/EmbeddedEditUrlRequest.json b/test_fixtures/EmbeddedEditUrlRequest.json index 9d3d76647..0d14a76a8 100644 --- a/test_fixtures/EmbeddedEditUrlRequest.json +++ b/test_fixtures/EmbeddedEditUrlRequest.json @@ -1,6 +1,7 @@ { "default": { "allow_edit_ccs": true, + "allow_form_view": false, "cc_roles": [ "" ], diff --git a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json index 16e803706..b0b488f04 100644 --- a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json @@ -1,6 +1,7 @@ { "default": { "allow_decline": true, + "allow_form_view": false, "allow_reassign": true, "attachments": [ { @@ -125,6 +126,7 @@ }, "with_grouped_signers": { "allow_decline": true, + "allow_form_view": false, "allow_reassign": true, "attachments": [ { diff --git a/test_fixtures/SignatureRequestSendRequest.json b/test_fixtures/SignatureRequestSendRequest.json index 98d12db3b..fc1d1f27a 100644 --- a/test_fixtures/SignatureRequestSendRequest.json +++ b/test_fixtures/SignatureRequestSendRequest.json @@ -1,6 +1,7 @@ { "default": { "allow_decline": true, + "allow_form_view": false, "allow_reassign": true, "attachments": [ { @@ -239,6 +240,7 @@ }, "with_grouped_signers": { "allow_decline": true, + "allow_form_view": false, "allow_reassign": true, "attachments": [ { diff --git a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json index b293945e7..c154ef1a1 100644 --- a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +++ b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json @@ -1,6 +1,7 @@ { "default": { "allow_ccs": true, + "allow_form_view": false, "allow_reassign": true, "attachments": [ { diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json index e18890b74..6949f32da 100644 --- a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +++ b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json @@ -1,6 +1,7 @@ { "default": { "allow_ccs": true, + "allow_form_view": false, "allow_decline": true, "allow_reassign": true, "attachments": [ diff --git a/test_fixtures/UnclaimedDraftCreateRequest.json b/test_fixtures/UnclaimedDraftCreateRequest.json index b74d37713..649c3553a 100644 --- a/test_fixtures/UnclaimedDraftCreateRequest.json +++ b/test_fixtures/UnclaimedDraftCreateRequest.json @@ -1,6 +1,7 @@ { "default": { "allow_decline": true, + "allow_form_view": false, "attachments": [ { "name": "Attachment1", diff --git a/translations/en.yaml b/translations/en.yaml index 3dcaf3ea3..1d893fa7a 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.