diff --git a/README.md b/README.md
index 94dc893..c9ba6ed 100644
--- a/README.md
+++ b/README.md
@@ -215,6 +215,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
| *TemplateApi* | [**templateGet**](docs/Api/TemplateApi.md#templateget) | **GET** /template/{template_id} | Get Template |
| *TemplateApi* | [**templateList**](docs/Api/TemplateApi.md#templatelist) | **GET** /template/list | List Templates |
| *TemplateApi* | [**templateRemoveUser**](docs/Api/TemplateApi.md#templateremoveuser) | **POST** /template/remove_user/{template_id} | Remove User from Template |
+| *TemplateApi* | [**templateUpdate**](docs/Api/TemplateApi.md#templateupdate) | **POST** /template/update/{template_id} | Update Template |
| *TemplateApi* | [**templateUpdateFiles**](docs/Api/TemplateApi.md#templateupdatefiles) | **POST** /template/update_files/{template_id} | Update Template Files |
| *UnclaimedDraftApi* | [**unclaimedDraftCreate**](docs/Api/UnclaimedDraftApi.md#unclaimeddraftcreate) | **POST** /unclaimed_draft/create | Create Unclaimed Draft |
| *UnclaimedDraftApi* | [**unclaimedDraftCreateEmbedded**](docs/Api/UnclaimedDraftApi.md#unclaimeddraftcreateembedded) | **POST** /unclaimed_draft/create_embedded | Create Embedded Unclaimed Draft |
@@ -229,6 +230,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [AccountGetResponse](docs/Model/AccountGetResponse.md)
- [AccountResponse](docs/Model/AccountResponse.md)
- [AccountResponseQuotas](docs/Model/AccountResponseQuotas.md)
+- [AccountResponseSettings](docs/Model/AccountResponseSettings.md)
- [AccountResponseUsage](docs/Model/AccountResponseUsage.md)
- [AccountUpdateRequest](docs/Model/AccountUpdateRequest.md)
- [AccountVerifyRequest](docs/Model/AccountVerifyRequest.md)
@@ -314,6 +316,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [SignatureRequestResponseSignatures](docs/Model/SignatureRequestResponseSignatures.md)
- [SignatureRequestSendRequest](docs/Model/SignatureRequestSendRequest.md)
- [SignatureRequestSendWithTemplateRequest](docs/Model/SignatureRequestSendWithTemplateRequest.md)
+- [SignatureRequestSignerExperience](docs/Model/SignatureRequestSignerExperience.md)
- [SignatureRequestUpdateRequest](docs/Model/SignatureRequestUpdateRequest.md)
- [SubAttachment](docs/Model/SubAttachment.md)
- [SubBulkSignerList](docs/Model/SubBulkSignerList.md)
@@ -345,11 +348,13 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [SubSignatureRequestGroupedSigners](docs/Model/SubSignatureRequestGroupedSigners.md)
- [SubSignatureRequestSigner](docs/Model/SubSignatureRequestSigner.md)
- [SubSignatureRequestTemplateSigner](docs/Model/SubSignatureRequestTemplateSigner.md)
+- [SubSignerExperience](docs/Model/SubSignerExperience.md)
- [SubSigningOptions](docs/Model/SubSigningOptions.md)
- [SubTeamResponse](docs/Model/SubTeamResponse.md)
- [SubTemplateRole](docs/Model/SubTemplateRole.md)
- [SubUnclaimedDraftSigner](docs/Model/SubUnclaimedDraftSigner.md)
- [SubUnclaimedDraftTemplateSigner](docs/Model/SubUnclaimedDraftTemplateSigner.md)
+- [SubUpdateFormField](docs/Model/SubUpdateFormField.md)
- [SubWhiteLabelingOptions](docs/Model/SubWhiteLabelingOptions.md)
- [TeamAddMemberRequest](docs/Model/TeamAddMemberRequest.md)
- [TeamCreateRequest](docs/Model/TeamCreateRequest.md)
@@ -372,7 +377,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [TemplateCreateRequest](docs/Model/TemplateCreateRequest.md)
- [TemplateCreateResponse](docs/Model/TemplateCreateResponse.md)
- [TemplateCreateResponseTemplate](docs/Model/TemplateCreateResponseTemplate.md)
-- [TemplateEditResponse](docs/Model/TemplateEditResponse.md)
- [TemplateGetResponse](docs/Model/TemplateGetResponse.md)
- [TemplateListResponse](docs/Model/TemplateListResponse.md)
- [TemplateRemoveUserRequest](docs/Model/TemplateRemoveUserRequest.md)
@@ -409,6 +413,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
- [TemplateUpdateFilesRequest](docs/Model/TemplateUpdateFilesRequest.md)
- [TemplateUpdateFilesResponse](docs/Model/TemplateUpdateFilesResponse.md)
- [TemplateUpdateFilesResponseTemplate](docs/Model/TemplateUpdateFilesResponseTemplate.md)
+- [TemplateUpdateRequest](docs/Model/TemplateUpdateRequest.md)
- [UnclaimedDraftCreateEmbeddedRequest](docs/Model/UnclaimedDraftCreateEmbeddedRequest.md)
- [UnclaimedDraftCreateEmbeddedWithTemplateRequest](docs/Model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md)
- [UnclaimedDraftCreateRequest](docs/Model/UnclaimedDraftCreateRequest.md)
@@ -447,6 +452,6 @@ apisupport@hellosign.com
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: `3.0.0`
- - Package version: `1.10.0`
+ - Package version: `1.11.0`
- Generator version: `7.12.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
diff --git a/VERSION b/VERSION
index 81c871d..1cac385 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-1.10.0
+1.11.0
diff --git a/composer.json b/composer.json
index 347c727..8347a02 100644
--- a/composer.json
+++ b/composer.json
@@ -31,7 +31,7 @@
},
"require-dev": {
"phpunit/phpunit": "^8.0 || ^9.0",
- "friendsofphp/php-cs-fixer": "^3.5",
+ "friendsofphp/php-cs-fixer": "v3.84.0",
"symfony/yaml": "^5.4"
},
"autoload": {
diff --git a/docs/Api/SignatureRequestApi.md b/docs/Api/SignatureRequestApi.md
index 3e2c764..a282858 100644
--- a/docs/Api/SignatureRequestApi.md
+++ b/docs/Api/SignatureRequestApi.md
@@ -368,7 +368,11 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions())
->setDraw(true)
->setPhone(false)
->setType(true)
- ->setUpload(true);
+ ->setUpload(true)
+ ->setForceAdvancedSignatureDetails(false);
+
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner())
->setName("Jack")
@@ -398,6 +402,7 @@ $signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRe
->setFiles([
])
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
@@ -465,7 +470,11 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions())
->setDraw(true)
->setPhone(false)
->setType(true)
- ->setUpload(true);
+ ->setUpload(true)
+ ->setForceAdvancedSignatureDetails(false);
+
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner())
->setRole("Client")
@@ -485,6 +494,7 @@ $signature_request_create_embedded_with_template_request = (new Dropbox\Sign\Mod
->setSubject("Purchase Order")
->setTestMode(true)
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
@@ -557,6 +567,9 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions())
->setType(true)
->setUpload(true);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner())
->setName("Jack")
->setEmailAddress("jack@example.com")
@@ -591,6 +604,7 @@ $signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRe
EOD, true))
->setFieldOptions($field_options)
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
@@ -662,6 +676,9 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions())
->setType(true)
->setUpload(true);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner())
->setName("Jack")
->setEmailAddress("jack@example.com")
@@ -690,6 +707,7 @@ $signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequ
->setFiles([
])
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
@@ -761,6 +779,9 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions())
->setType(true)
->setUpload(true);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner())
->setRole("Client")
->setName("George")
@@ -779,6 +800,7 @@ $signature_request_edit_embedded_with_template_request = (new Dropbox\Sign\Model
->setSubject("Purchase Order")
->setTestMode(true)
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
@@ -1449,7 +1471,8 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions())
->setDraw(true)
->setPhone(false)
->setType(true)
- ->setUpload(true);
+ ->setUpload(true)
+ ->setForceAdvancedSignatureDetails(false);
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner())
->setName("Jack")
@@ -1552,7 +1575,8 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions())
->setDraw(true)
->setPhone(false)
->setType(true)
- ->setUpload(true);
+ ->setUpload(true)
+ ->setForceAdvancedSignatureDetails(false);
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner())
->setRole("Client")
diff --git a/docs/Api/TemplateApi.md b/docs/Api/TemplateApi.md
index 23d1d5a..7123d41 100644
--- a/docs/Api/TemplateApi.md
+++ b/docs/Api/TemplateApi.md
@@ -14,6 +14,7 @@ All URIs are relative to https://api.hellosign.com/v3.
| [**templateGet()**](TemplateApi.md#templateGet) | **GET** /template/{template_id} | Get Template |
| [**templateList()**](TemplateApi.md#templateList) | **GET** /template/list | List Templates |
| [**templateRemoveUser()**](TemplateApi.md#templateRemoveUser) | **POST** /template/remove_user/{template_id} | Remove User from Template |
+| [**templateUpdate()**](TemplateApi.md#templateUpdate) | **POST** /template/update/{template_id} | Update Template |
| [**templateUpdateFiles()**](TemplateApi.md#templateUpdateFiles) | **POST** /template/update_files/{template_id} | Update Template Files |
@@ -110,6 +111,9 @@ $config->setUsername("YOUR_API_KEY");
$field_options = (new Dropbox\Sign\Model\SubFieldOptions())
->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole())
->setName("Client")
->setOrder(0);
@@ -181,6 +185,7 @@ $template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest())
->setFiles([
])
->setFieldOptions($field_options)
+ ->setSignerExperience($signer_experience)
->setSignerRoles($signer_roles)
->setFormFieldsPerDocument($form_fields_per_document)
->setMergeFields($merge_fields);
@@ -754,6 +759,95 @@ try {
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
+## `templateUpdate()`
+
+```php
+templateUpdate($template_id, $template_update_request): \Dropbox\Sign\Model\TemplateGetResponse
+```
+Update Template
+
+Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.
+
+### Example
+
+```php
+setUsername("YOUR_API_KEY");
+// $config->setAccessToken("YOUR_ACCESS_TOKEN");
+
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
+$form_fields_1 = (new Dropbox\Sign\Model\SubUpdateFormField())
+ ->setApiId("uniqueIdHere_1")
+ ->setName("New name 1");
+
+$form_fields_2 = (new Dropbox\Sign\Model\SubUpdateFormField())
+ ->setApiId("uniqueIdHere_2")
+ ->setName("New name 2");
+
+$form_fields = [
+ $form_fields_1,
+ $form_fields_2,
+];
+
+$template_update_request = (new Dropbox\Sign\Model\TemplateUpdateRequest())
+ ->setTitle("Test Title")
+ ->setSubject("Test Subject")
+ ->setMessage("Test Message")
+ ->setCcRoles([
+ "CC Role 1",
+ "CC Role 2",
+ ])
+ ->setSignerExperience($signer_experience)
+ ->setFormFields($form_fields);
+
+try {
+ $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateUpdate(
+ template_id: "f57db65d3f933b5316d398057a36176831451a35",
+ template_update_request: $template_update_request,
+ );
+
+ print_r($response);
+} catch (Dropbox\Sign\ApiException $e) {
+ echo "Exception when calling TemplateApi#templateUpdate: {$e->getMessage()}";
+}
+
+```
+
+### Parameters
+
+|Name | Type | Description | Notes |
+| ------------- | ------------- | ------------- | ------------- |
+| **template_id** | **string**| The ID of the template to update. | |
+| **template_update_request** | [**\Dropbox\Sign\Model\TemplateUpdateRequest**](../Model/TemplateUpdateRequest.md)| | |
+
+### Return type
+
+[**\Dropbox\Sign\Model\TemplateGetResponse**](../Model/TemplateGetResponse.md)
+
+### Authorization
+
+[api_key](../../README.md#api_key), [oauth2](../../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `multipart/form-data`
+- **Accept**: `application/json`
+
+[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
+[[Back to Model list]](../../README.md#models)
+[[Back to README]](../../README.md)
+
## `templateUpdateFiles()`
```php
diff --git a/docs/Model/AccountResponse.md b/docs/Model/AccountResponse.md
index 3121826..8cabded 100644
--- a/docs/Model/AccountResponse.md
+++ b/docs/Model/AccountResponse.md
@@ -17,5 +17,6 @@ Name | Type | Description | Notes
| `team_id` | ```string``` | The id of the team account belongs to. | |
| `locale` | ```string``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | |
| `usage` | [```\Dropbox\Sign\Model\AccountResponseUsage```](AccountResponseUsage.md) | | |
+| `settings` | [```\Dropbox\Sign\Model\AccountResponseSettings```](AccountResponseSettings.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/AccountResponseSettings.md b/docs/Model/AccountResponseSettings.md
new file mode 100644
index 0000000..913c658
--- /dev/null
+++ b/docs/Model/AccountResponseSettings.md
@@ -0,0 +1,13 @@
+# # AccountResponseSettings
+
+Subset of configured settings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `signer_access_codes` | ```bool``` | Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
+| `sms_delivery` | ```bool``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
+| `sms_authentication` | ```bool``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/BulkSendJobGetResponseSignatureRequests.md b/docs/Model/BulkSendJobGetResponseSignatureRequests.md
index 247951d..9ae85f6 100644
--- a/docs/Model/BulkSendJobGetResponseSignatureRequests.md
+++ b/docs/Model/BulkSendJobGetResponseSignatureRequests.md
@@ -31,5 +31,6 @@ Name | Type | Description | Notes
| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | |
| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | |
| `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/EmbeddedEditUrlRequest.md b/docs/Model/EmbeddedEditUrlRequest.md
index ad008f6..e6a1e94 100644
--- a/docs/Model/EmbeddedEditUrlRequest.md
+++ b/docs/Model/EmbeddedEditUrlRequest.md
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
| `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience. | [default to false] |
| `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] |
| `test_mode` | ```bool``` | 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] |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestCreateEmbeddedRequest.md b/docs/Model/SignatureRequestCreateEmbeddedRequest.md
index a953bcb..7ef50fa 100644
--- a/docs/Model/SignatureRequestCreateEmbeddedRequest.md
+++ b/docs/Model/SignatureRequestCreateEmbeddedRequest.md
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
| `use_text_tags` | ```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`. | [default to false] |
| `populate_auto_fill_fields` | ```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. | [default to false] |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
| `expires_at` | ```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. | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md
index b41a8e3..d8f0e6b 100644
--- a/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md
+++ b/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md
@@ -21,5 +21,6 @@ Name | Type | Description | Notes
| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
| `populate_auto_fill_fields` | ```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. | [default to false] |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestEditEmbeddedRequest.md b/docs/Model/SignatureRequestEditEmbeddedRequest.md
index b2567ac..65af8ee 100644
--- a/docs/Model/SignatureRequestEditEmbeddedRequest.md
+++ b/docs/Model/SignatureRequestEditEmbeddedRequest.md
@@ -30,5 +30,6 @@ Name | Type | Description | Notes
| `use_text_tags` | ```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`. | [default to false] |
| `populate_auto_fill_fields` | ```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. | [default to false] |
| `expires_at` | ```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. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md b/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md
index 3b9df4c..e1141d9 100644
--- a/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md
+++ b/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md
@@ -21,5 +21,6 @@ Name | Type | Description | Notes
| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
| `populate_auto_fill_fields` | ```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. | [default to false] |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestEditRequest.md b/docs/Model/SignatureRequestEditRequest.md
index 0d3ca23..9e22ec8 100644
--- a/docs/Model/SignatureRequestEditRequest.md
+++ b/docs/Model/SignatureRequestEditRequest.md
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
| `form_field_rules` | [```\Dropbox\Sign\Model\SubFormFieldRule[]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.
**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] |
-| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
+| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
| `message` | ```string``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | |
@@ -31,5 +31,6 @@ Name | Type | Description | Notes
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
| `use_text_tags` | ```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`. | [default to false] |
| `expires_at` | ```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. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestEditWithTemplateRequest.md b/docs/Model/SignatureRequestEditWithTemplateRequest.md
index 072fdc0..2cc40c3 100644
--- a/docs/Model/SignatureRequestEditWithTemplateRequest.md
+++ b/docs/Model/SignatureRequestEditWithTemplateRequest.md
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
| `custom_fields` | [```\Dropbox\Sign\Model\SubCustomField[]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | |
| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | |
-| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
+| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
| `message` | ```string``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | |
@@ -22,5 +22,6 @@ Name | Type | Description | Notes
| `subject` | ```string``` | The subject in the email that will be sent to the signers. | |
| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestResponse.md b/docs/Model/SignatureRequestResponse.md
index bb04b5d..0b97015 100644
--- a/docs/Model/SignatureRequestResponse.md
+++ b/docs/Model/SignatureRequestResponse.md
@@ -31,5 +31,6 @@ Name | Type | Description | Notes
| `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | |
| `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | |
| `bulk_send_job_id` | ```string``` | The ID of the Bulk Send job which sent the signature request, if applicable. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestSendRequest.md b/docs/Model/SignatureRequestSendRequest.md
index 65d3a7d..7882988 100644
--- a/docs/Model/SignatureRequestSendRequest.md
+++ b/docs/Model/SignatureRequestSendRequest.md
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
| `form_fields_per_document` | [```\Dropbox\Sign\Model\SubFormFieldsPerDocumentBase[]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.
**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] |
| `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
-| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
+| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
| `message` | ```string``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | |
@@ -32,5 +32,6 @@ Name | Type | Description | Notes
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
| `use_text_tags` | ```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`. | [default to false] |
| `expires_at` | ```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. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestSendWithTemplateRequest.md b/docs/Model/SignatureRequestSendWithTemplateRequest.md
index cbfaeb3..7dec655 100644
--- a/docs/Model/SignatureRequestSendWithTemplateRequest.md
+++ b/docs/Model/SignatureRequestSendWithTemplateRequest.md
@@ -15,7 +15,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. | |
| `is_qualified_signature` | ```bool``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
-| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
+| `is_eid` | ```bool``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
| `message` | ```string``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```array``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
| `signing_options` | [```\Dropbox\Sign\Model\SubSigningOptions```](SubSigningOptions.md) | | |
@@ -23,5 +23,6 @@ Name | Type | Description | Notes
| `subject` | ```string``` | The subject in the email that will be sent to the signers. | |
| `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SignatureRequestSignerExperience.md b/docs/Model/SignatureRequestSignerExperience.md
new file mode 100644
index 0000000..7ac28f1
--- /dev/null
+++ b/docs/Model/SignatureRequestSignerExperience.md
@@ -0,0 +1,11 @@
+# # SignatureRequestSignerExperience
+
+Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `form_view`*_required_ | ```string``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | |
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SubSignerExperience.md b/docs/Model/SubSignerExperience.md
new file mode 100644
index 0000000..7baee01
--- /dev/null
+++ b/docs/Model/SubSignerExperience.md
@@ -0,0 +1,11 @@
+# # SubSignerExperience
+
+Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `form_view` | ```string``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | |
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SubSigningOptions.md b/docs/Model/SubSigningOptions.md
index e2a1b16..0a3d3a4 100644
--- a/docs/Model/SubSigningOptions.md
+++ b/docs/Model/SubSigningOptions.md
@@ -1,9 +1,11 @@
# # SubSigningOptions
-This allows the requester to specify the types allowed for creating a signature.
+This allows the requester to specify the types allowed for creating a signature and specify another signing options.
**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
+**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.
+
## Properties
Name | Type | Description | Notes
@@ -13,5 +15,6 @@ Name | Type | Description | Notes
| `phone` | ```bool``` | Allows using a smartphone to email the signature | [default to false] |
| `type` | ```bool``` | Allows typing the signature | [default to false] |
| `upload` | ```bool``` | Allows uploading the signature | [default to false] |
+| `force_advanced_signature_details` | ```bool``` | Turning on advanced signature details for the signature request | [default to false] |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/SubUpdateFormField.md b/docs/Model/SubUpdateFormField.md
new file mode 100644
index 0000000..1398a79
--- /dev/null
+++ b/docs/Model/SubUpdateFormField.md
@@ -0,0 +1,12 @@
+# # SubUpdateFormField
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `api_id`*_required_ | ```string``` | The unique ID for this field. The endpoint will update an existing field with matching `api_id`, and warn you if no matches are found | |
+| `name` | ```string``` | The new name of the field. If not passed the name will remain unchanged. | |
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/TemplateCreateEmbeddedDraftRequest.md b/docs/Model/TemplateCreateEmbeddedDraftRequest.md
index d9ef188..160c72f 100644
--- a/docs/Model/TemplateCreateEmbeddedDraftRequest.md
+++ b/docs/Model/TemplateCreateEmbeddedDraftRequest.md
@@ -31,5 +31,6 @@ Name | Type | Description | Notes
| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
| `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/TemplateCreateRequest.md b/docs/Model/TemplateCreateRequest.md
index 1a4b677..ec8de40 100644
--- a/docs/Model/TemplateCreateRequest.md
+++ b/docs/Model/TemplateCreateRequest.md
@@ -24,5 +24,6 @@ Name | Type | Description | Notes
| `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
| `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/TemplateEditResponse.md b/docs/Model/TemplateEditResponse.md
deleted file mode 100644
index b343db5..0000000
--- a/docs/Model/TemplateEditResponse.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# # TemplateEditResponse
-
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `template_id`*_required_ | ```string``` | The id of the Template. | |
-
-[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/TemplateResponse.md b/docs/Model/TemplateResponse.md
index 3a7dc2f..1bd632c 100644
--- a/docs/Model/TemplateResponse.md
+++ b/docs/Model/TemplateResponse.md
@@ -22,5 +22,6 @@ Name | Type | Description | Notes
| `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | |
| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | |
| `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/TemplateUpdateRequest.md b/docs/Model/TemplateUpdateRequest.md
new file mode 100644
index 0000000..997716e
--- /dev/null
+++ b/docs/Model/TemplateUpdateRequest.md
@@ -0,0 +1,16 @@
+# # TemplateUpdateRequest
+
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+| `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request. | |
+| `title` | ```string``` | The title you want to assign to the SignatureRequest. | |
+| `subject` | ```string``` | The new default template email subject. | |
+| `message` | ```string``` | The new default template email message. | |
+| `form_fields` | [```\Dropbox\Sign\Model\SubUpdateFormField[]```](SubUpdateFormField.md) | A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/UnclaimedDraftCreateRequest.md b/docs/Model/UnclaimedDraftCreateRequest.md
index afcb4a7..095985e 100644
--- a/docs/Model/UnclaimedDraftCreateRequest.md
+++ b/docs/Model/UnclaimedDraftCreateRequest.md
@@ -30,5 +30,6 @@ Name | Type | Description | Notes
| `use_preexisting_fields` | ```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. | [default to false] |
| `use_text_tags` | ```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. | [default to false] |
| `expires_at` | ```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. | |
+| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | |
[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/examples/SignatureRequestCreateEmbeddedExample.php b/examples/SignatureRequestCreateEmbeddedExample.php
index 61d7404..95f7315 100644
--- a/examples/SignatureRequestCreateEmbeddedExample.php
+++ b/examples/SignatureRequestCreateEmbeddedExample.php
@@ -16,7 +16,11 @@
->setDraw(true)
->setPhone(false)
->setType(true)
- ->setUpload(true);
+ ->setUpload(true)
+ ->setForceAdvancedSignatureDetails(false);
+
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner())
->setName("Jack")
@@ -46,6 +50,7 @@
->setFiles([
])
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php
index f7ea5d3..5b8196d 100644
--- a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php
+++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php
@@ -44,6 +44,9 @@
->setType(true)
->setUpload(true);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners())
->setGroup("Group #1")
->setOrder(0)
@@ -73,6 +76,7 @@
"lawyer2@dropboxsign.com",
])
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setGroupedSigners($grouped_signers);
try {
diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php
index 3ff0454..598636c 100644
--- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php
+++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php
@@ -16,7 +16,11 @@
->setDraw(true)
->setPhone(false)
->setType(true)
- ->setUpload(true);
+ ->setUpload(true)
+ ->setForceAdvancedSignatureDetails(false);
+
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner())
->setRole("Client")
@@ -36,6 +40,7 @@
->setSubject("Purchase Order")
->setTestMode(true)
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
diff --git a/examples/SignatureRequestEditEmbeddedExample.php b/examples/SignatureRequestEditEmbeddedExample.php
index 868c625..99b5d3c 100644
--- a/examples/SignatureRequestEditEmbeddedExample.php
+++ b/examples/SignatureRequestEditEmbeddedExample.php
@@ -18,6 +18,9 @@
->setType(true)
->setUpload(true);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner())
->setName("Jack")
->setEmailAddress("jack@example.com")
@@ -46,6 +49,7 @@
->setFiles([
])
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php
index 08ebeac..f5838ae 100644
--- a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php
+++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php
@@ -44,6 +44,9 @@
->setType(true)
->setUpload(true);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners())
->setGroup("Group #1")
->setOrder(0)
@@ -73,6 +76,7 @@
"lawyer2@dropboxsign.com",
])
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setGroupedSigners($grouped_signers);
try {
diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.php b/examples/SignatureRequestEditEmbeddedWithTemplateExample.php
index 640f35d..e124eea 100644
--- a/examples/SignatureRequestEditEmbeddedWithTemplateExample.php
+++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.php
@@ -18,6 +18,9 @@
->setType(true)
->setUpload(true);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner())
->setRole("Client")
->setName("George")
@@ -36,6 +39,7 @@
->setSubject("Purchase Order")
->setTestMode(true)
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
diff --git a/examples/SignatureRequestEditExample.php b/examples/SignatureRequestEditExample.php
index 92d3747..e289953 100644
--- a/examples/SignatureRequestEditExample.php
+++ b/examples/SignatureRequestEditExample.php
@@ -21,6 +21,9 @@
->setType(true)
->setUpload(true);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner())
->setName("Jack")
->setEmailAddress("jack@example.com")
@@ -55,6 +58,7 @@
EOD, true))
->setFieldOptions($field_options)
->setSigningOptions($signing_options)
+ ->setSignerExperience($signer_experience)
->setSigners($signers);
try {
diff --git a/examples/SignatureRequestSendExample.php b/examples/SignatureRequestSendExample.php
index f922a57..f8ab05e 100644
--- a/examples/SignatureRequestSendExample.php
+++ b/examples/SignatureRequestSendExample.php
@@ -19,7 +19,8 @@
->setDraw(true)
->setPhone(false)
->setType(true)
- ->setUpload(true);
+ ->setUpload(true)
+ ->setForceAdvancedSignatureDetails(false);
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner())
->setName("Jack")
diff --git a/examples/SignatureRequestSendWithTemplateExample.php b/examples/SignatureRequestSendWithTemplateExample.php
index d682053..747882e 100644
--- a/examples/SignatureRequestSendWithTemplateExample.php
+++ b/examples/SignatureRequestSendWithTemplateExample.php
@@ -16,7 +16,8 @@
->setDraw(true)
->setPhone(false)
->setType(true)
- ->setUpload(true);
+ ->setUpload(true)
+ ->setForceAdvancedSignatureDetails(false);
$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner())
->setRole("Client")
diff --git a/examples/TemplateCreateExample.php b/examples/TemplateCreateExample.php
index 93b6ded..1723f03 100644
--- a/examples/TemplateCreateExample.php
+++ b/examples/TemplateCreateExample.php
@@ -14,6 +14,9 @@
$field_options = (new Dropbox\Sign\Model\SubFieldOptions())
->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY);
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole())
->setName("Client")
->setOrder(0);
@@ -85,6 +88,7 @@
->setFiles([
])
->setFieldOptions($field_options)
+ ->setSignerExperience($signer_experience)
->setSignerRoles($signer_roles)
->setFormFieldsPerDocument($form_fields_per_document)
->setMergeFields($merge_fields);
diff --git a/examples/TemplateUpdateExample.php b/examples/TemplateUpdateExample.php
new file mode 100644
index 0000000..88aa67c
--- /dev/null
+++ b/examples/TemplateUpdateExample.php
@@ -0,0 +1,50 @@
+setUsername("YOUR_API_KEY");
+// $config->setAccessToken("YOUR_ACCESS_TOKEN");
+
+$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience())
+ ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED);
+
+$form_fields_1 = (new Dropbox\Sign\Model\SubUpdateFormField())
+ ->setApiId("uniqueIdHere_1")
+ ->setName("New name 1");
+
+$form_fields_2 = (new Dropbox\Sign\Model\SubUpdateFormField())
+ ->setApiId("uniqueIdHere_2")
+ ->setName("New name 2");
+
+$form_fields = [
+ $form_fields_1,
+ $form_fields_2,
+];
+
+$template_update_request = (new Dropbox\Sign\Model\TemplateUpdateRequest())
+ ->setTitle("Test Title")
+ ->setSubject("Test Subject")
+ ->setMessage("Test Message")
+ ->setCcRoles([
+ "CC Role 1",
+ "CC Role 2",
+ ])
+ ->setSignerExperience($signer_experience)
+ ->setFormFields($form_fields);
+
+try {
+ $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateUpdate(
+ template_id: "f57db65d3f933b5316d398057a36176831451a35",
+ template_update_request: $template_update_request,
+ );
+
+ print_r($response);
+} catch (Dropbox\Sign\ApiException $e) {
+ echo "Exception when calling TemplateApi#templateUpdate: {$e->getMessage()}";
+}
diff --git a/openapi-config.yaml b/openapi-config.yaml
index 8db1fea..317b37b 100644
--- a/openapi-config.yaml
+++ b/openapi-config.yaml
@@ -2,7 +2,7 @@ generatorName: php
additionalProperties:
packageName: dropbox/sign
packageVersion: "^1.10.0"
- artifactVersion: 1.10.0
+ artifactVersion: 1.11.0
invokerPackage: "Dropbox\\Sign"
sortModelPropertiesByRequiredFlag: true
srcBasePath: src
diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml
index c123c2e..33f3cde 100644
--- a/openapi-sdk.yaml
+++ b/openapi-sdk.yaml
@@ -65,6 +65,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -173,6 +175,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -269,6 +273,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
409_example:
$ref: '#/components/examples/Error409Response'
4XX_example:
@@ -369,6 +375,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -468,6 +476,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -566,10 +576,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 404_example:
- $ref: '#/components/examples/Error404Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 404_example:
+ $ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -677,10 +687,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 409_example:
- $ref: '#/components/examples/Error409Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -769,6 +779,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -873,6 +885,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -983,6 +997,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -1086,6 +1102,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -1192,6 +1210,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -1290,12 +1310,12 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -1392,10 +1412,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 404_example:
- $ref: '#/components/examples/Error404Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 404_example:
+ $ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -1481,10 +1501,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 404_example:
- $ref: '#/components/examples/Error404Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 404_example:
+ $ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -1576,12 +1596,12 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
410_example:
$ref: '#/components/examples/Error410Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -1675,6 +1695,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -1858,6 +1880,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -1951,6 +1975,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -2046,6 +2072,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -2135,6 +2163,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -2251,6 +2281,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -2344,6 +2376,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -2450,6 +2484,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -2546,10 +2582,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 404_example:
- $ref: '#/components/examples/Error404Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 404_example:
+ $ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -2643,6 +2679,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security: []
@@ -2738,6 +2776,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security: []
@@ -2836,6 +2876,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -2935,12 +2977,12 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -3040,6 +3082,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -3143,6 +3187,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
@@ -3251,10 +3297,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 409_example:
- $ref: '#/components/examples/Error409Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -3354,10 +3400,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 409_example:
- $ref: '#/components/examples/Error409Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -3471,12 +3517,12 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -3591,12 +3637,12 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -3708,12 +3754,12 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -3825,12 +3871,12 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -3943,14 +3989,14 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
410_example:
$ref: '#/components/examples/Error410Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -4051,14 +4097,14 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
410_example:
$ref: '#/components/examples/Error410Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -4166,14 +4212,14 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
410_example:
$ref: '#/components/examples/Error410Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -4271,6 +4317,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
410_example:
@@ -4394,6 +4442,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
409_example:
$ref: '#/components/examples/Error409Response'
4XX_example:
@@ -4493,6 +4543,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -4603,14 +4655,14 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
410_example:
$ref: '#/components/examples/Error410Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -4708,6 +4760,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
@@ -4812,10 +4866,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 409_example:
- $ref: '#/components/examples/Error409Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -5029,6 +5083,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -5138,6 +5194,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -5236,6 +5294,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -5316,6 +5376,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -5403,6 +5465,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -5500,6 +5564,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -5596,10 +5662,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 409_example:
- $ref: '#/components/examples/Error409Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -5695,6 +5761,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -5808,10 +5876,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 409_example:
- $ref: '#/components/examples/Error409Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -5910,6 +5978,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -6024,10 +6094,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 409_example:
- $ref: '#/components/examples/Error409Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -6133,6 +6203,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -6240,6 +6312,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
@@ -6349,6 +6423,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
@@ -6444,6 +6520,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
@@ -6558,14 +6636,14 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
422_example:
$ref: '#/components/examples/Error422Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -6665,14 +6743,14 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
422_example:
$ref: '#/components/examples/Error422Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -6779,14 +6857,14 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
422_example:
$ref: '#/components/examples/Error422Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -6883,10 +6961,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 404_example:
- $ref: '#/components/examples/Error404Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 404_example:
+ $ref: '#/components/examples/Error404Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -7006,10 +7084,10 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
- 409_example:
- $ref: '#/components/examples/Error409Response'
429_example:
$ref: '#/components/examples/Error429Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -7115,6 +7193,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
4XX_example:
@@ -7165,6 +7245,121 @@ paths:
seo:
title: 'Remove User from Template | REST API | Dropbox Sign for Developers'
description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.'
+ '/template/update/{template_id}':
+ post:
+ tags:
+ - Template
+ summary: 'Update Template'
+ description: 'Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.'
+ operationId: templateUpdate
+ parameters:
+ -
+ name: template_id
+ in: path
+ description: 'The ID of the template to update.'
+ required: true
+ schema:
+ type: string
+ example: f57db65d3f933b5316d398057a36176831451a35
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplateUpdateRequest'
+ examples:
+ example:
+ $ref: '#/components/examples/TemplateUpdateRequest'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/TemplateUpdateRequest'
+ responses:
+ '200':
+ description: 'successful operation'
+ headers:
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-Ratelimit-Reset:
+ $ref: '#/components/headers/X-Ratelimit-Reset'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplateGetResponse'
+ examples:
+ example:
+ $ref: '#/components/examples/TemplateGetResponse'
+ '4XX':
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400Response'
+ 401_example:
+ $ref: '#/components/examples/Error401Response'
+ 402_example:
+ $ref: '#/components/examples/Error402Response'
+ 403_example:
+ $ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
+ 404_example:
+ $ref: '#/components/examples/Error404Response'
+ 409_example:
+ $ref: '#/components/examples/Error409Response'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponse'
+ security:
+ -
+ api_key: []
+ -
+ oauth2:
+ - template_access
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/TemplateUpdateExample.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/TemplateUpdateExample.cs
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/TemplateUpdateExample.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/TemplateUpdateExample.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/TemplateUpdateExample.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/TemplateUpdateExample.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/TemplateUpdateExample.sh
+ x-meta:
+ seo:
+ title: 'Update Template | REST API | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to update properties of an existing template, click here.'
+ x-hideOn: doc
'/template/update_files/{template_id}':
post:
tags:
@@ -7237,12 +7432,12 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -7348,6 +7543,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -7456,6 +7653,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
@@ -7563,12 +7762,12 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
- 429_example:
- $ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
@@ -7677,6 +7876,8 @@ paths:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
+ 429_example:
+ $ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
@@ -7882,6 +8083,8 @@ components:
description: 'Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.'
type: boolean
default: false
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
FaxLineAddUserRequest:
required:
@@ -8468,6 +8671,8 @@ components:
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
type: boolean
default: false
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
expires_at:
description: '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.'
type: integer
@@ -8556,6 +8761,8 @@ components:
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
type: boolean
default: false
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
SignatureRequestEditRequest:
properties:
@@ -8670,7 +8877,7 @@ components:
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.
- **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
type: boolean
default: false
message:
@@ -8710,6 +8917,8 @@ components:
description: '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.'
type: integer
nullable: true
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
SignatureRequestEditEmbeddedRequest:
required:
@@ -8862,6 +9071,8 @@ components:
description: '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.'
type: integer
nullable: true
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
SignatureRequestEditEmbeddedWithTemplateRequest:
required:
@@ -8946,6 +9157,8 @@ components:
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
type: boolean
default: false
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
SignatureRequestEditWithTemplateRequest:
description: ''
@@ -8997,7 +9210,7 @@ components:
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.
- **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
type: boolean
default: false
message:
@@ -9034,6 +9247,8 @@ components:
description: 'The title you want to assign to the SignatureRequest.'
type: string
maxLength: 255
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
SignatureRequestRemindRequest:
required:
@@ -9171,7 +9386,7 @@ components:
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.
- **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
type: boolean
default: false
message:
@@ -9211,6 +9426,8 @@ components:
description: '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.'
type: integer
nullable: true
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
SignatureRequestSendWithTemplateRequest:
description: ''
@@ -9273,7 +9490,7 @@ components:
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.
- **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ **NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
type: boolean
default: false
message:
@@ -9310,6 +9527,8 @@ components:
description: 'The title you want to assign to the SignatureRequest.'
type: string
maxLength: 255
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
SignatureRequestUpdateRequest:
required:
@@ -9734,6 +9953,17 @@ components:
type: integer
default: 12
type: object
+ SubUpdateFormField:
+ required:
+ - api_id
+ properties:
+ api_id:
+ description: 'The unique ID for this field. The endpoint will update an existing field with matching `api_id`, and warn you if no matches are found'
+ type: string
+ name:
+ description: 'The new name of the field. If not passed the name will remain unchanged.'
+ type: string
+ type: object
SubFormFieldsPerDocumentHyperlink:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -10254,6 +10484,23 @@ components:
type: string
format: email
type: object
+ SubSignerExperience:
+ description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
+ properties:
+ form_view:
+ description: |-
+ Changes the form view setting experienced by the signer. Supported versions are:
+ - `disabled` - Form view is disabled, and the signer cannot change it
+ - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle
+ - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle
+ - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden.
+ type: string
+ enum:
+ - disabled
+ - enabled
+ - enabled_by_default
+ - forced
+ type: object
SubTemplateRole:
properties:
name:
@@ -10266,9 +10513,11 @@ components:
type: object
SubSigningOptions:
description: |-
- This allows the requester to specify the types allowed for creating a signature.
+ This allows the requester to specify the types allowed for creating a signature and specify another signing options.
**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
+
+ **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.
required:
- default_type
properties:
@@ -10296,6 +10545,10 @@ components:
description: 'Allows uploading the signature'
type: boolean
default: false
+ force_advanced_signature_details:
+ description: 'Turning on advanced signature details for the signature request'
+ type: boolean
+ default: false
type: object
SubWhiteLabelingOptions:
description: |-
@@ -10559,6 +10812,8 @@ components:
description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).'
type: boolean
default: false
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
TemplateCreateEmbeddedDraftRequest:
required:
@@ -10701,6 +10956,8 @@ components:
description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).'
type: boolean
default: false
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
TemplateRemoveUserRequest:
properties:
@@ -10712,6 +10969,32 @@ components:
type: string
format: email
type: object
+ TemplateUpdateRequest:
+ properties:
+ cc_roles:
+ description: 'The CC roles that must be assigned when using the template to send a signature request.'
+ type: array
+ items:
+ type: string
+ title:
+ description: 'The title you want to assign to the SignatureRequest.'
+ type: string
+ subject:
+ description: 'The new default template email subject.'
+ type: string
+ maxLength: 200
+ message:
+ description: 'The new default template email message.'
+ type: string
+ maxLength: 5000
+ form_fields:
+ description: 'A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.'
+ type: array
+ items:
+ $ref: '#/components/schemas/SubUpdateFormField'
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
+ type: object
TemplateUpdateFilesRequest:
properties:
client_id:
@@ -10887,6 +11170,8 @@ components:
**NOTE:** This does not correspond to the **expires_at** returned in the response.
type: integer
nullable: true
+ signer_experience:
+ $ref: '#/components/schemas/SubSignerExperience'
type: object
UnclaimedDraftCreateEmbeddedRequest:
description: ''
@@ -11590,6 +11875,8 @@ components:
nullable: true
usage:
$ref: '#/components/schemas/AccountResponseUsage'
+ settings:
+ $ref: '#/components/schemas/AccountResponseSettings'
type: object
x-internal-class: true
OAuthTokenResponse:
@@ -11637,6 +11924,20 @@ components:
nullable: true
type: object
x-internal-class: true
+ AccountResponseSettings:
+ description: 'Subset of configured settings'
+ properties:
+ signer_access_codes:
+ description: 'Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).'
+ type: boolean
+ sms_delivery:
+ description: 'Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).'
+ type: boolean
+ sms_authentication:
+ description: 'Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).'
+ type: boolean
+ type: object
+ x-internal-class: true
AccountResponseUsage:
description: 'Details concerning monthly usage'
properties:
@@ -12076,6 +12377,8 @@ components:
description: 'The ID of the Bulk Send job which sent the signature request, if applicable.'
type: string
nullable: true
+ signer_experience:
+ $ref: '#/components/schemas/SignatureRequestSignerExperience'
type: object
x-internal-class: true
SignatureRequestResponseAttachment:
@@ -12437,6 +12740,26 @@ components:
nullable: true
type: object
x-internal-class: true
+ SignatureRequestSignerExperience:
+ description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.'
+ required:
+ - form_view
+ properties:
+ form_view:
+ description: |-
+ Changes the form view setting experienced by the signer. Supported versions are:
+ - `disabled` - Form view is disabled, and the signer cannot change it
+ - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle
+ - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle
+ - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden.
+ type: string
+ enum:
+ - disabled
+ - enabled
+ - enabled_by_default
+ - forced
+ type: object
+ x-internal-class: true
TeamResponse:
description: 'Contains information about your team and its members'
properties:
@@ -12608,6 +12931,8 @@ components:
type: array
items:
$ref: '#/components/schemas/SignatureRequestResponseAttachment'
+ signer_experience:
+ $ref: '#/components/schemas/SignatureRequestSignerExperience'
type: object
x-internal-class: true
TemplateResponseAccount:
@@ -13565,14 +13890,6 @@ components:
$ref: '#/components/schemas/WarningResponse'
type: object
x-internal-class: true
- TemplateEditResponse:
- required:
- - template_id
- properties:
- template_id:
- description: 'The id of the Template.'
- type: string
- type: object
TemplateGetResponse:
required:
- template
@@ -13900,6 +14217,10 @@ components:
summary: 'Default Example'
value:
$ref: examples/json/TemplateRemoveUserRequest.json
+ TemplateUpdateRequest:
+ summary: 'Default Example'
+ value:
+ $ref: examples/json/TemplateUpdateRequest.json
TemplateUpdateFilesRequest:
summary: 'Default Example'
value:
diff --git a/src/Api/TemplateApi.php b/src/Api/TemplateApi.php
index 2d39bc8..69a6937 100644
--- a/src/Api/TemplateApi.php
+++ b/src/Api/TemplateApi.php
@@ -100,6 +100,10 @@ class TemplateApi
'templateRemoveUser' => [
'application/json',
],
+ 'templateUpdate' => [
+ 'application/json',
+ 'multipart/form-data',
+ ],
'templateUpdateFiles' => [
'application/json',
'multipart/form-data',
@@ -3524,6 +3528,366 @@ public function templateRemoveUserRequest(string $template_id, Model\TemplateRem
);
}
+ /**
+ * Operation templateUpdate
+ *
+ * Update Template
+ *
+ * @param string $template_id The ID of the template to update. (required)
+ * @param Model\TemplateUpdateRequest $template_update_request template_update_request (required)
+ *
+ * @return Model\TemplateGetResponse
+ * @throws ApiException on non-2xx response or if the response body is not in the expected format
+ * @throws InvalidArgumentException
+ */
+ public function templateUpdate(string $template_id, Model\TemplateUpdateRequest $template_update_request)
+ {
+ list($response) = $this->templateUpdateWithHttpInfo($template_id, $template_update_request);
+ return $response;
+ }
+
+ /**
+ * Operation templateUpdateWithHttpInfo
+ *
+ * Update Template
+ *
+ * @param string $template_id The ID of the template to update. (required)
+ * @param Model\TemplateUpdateRequest $template_update_request (required)
+ * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdate'] to see the possible values for this operation
+ *
+ * @return array of Model\TemplateGetResponse, HTTP status code, HTTP response headers (array of strings)
+ * @throws ApiException on non-2xx response or if the response body is not in the expected format
+ * @throws InvalidArgumentException
+ * @deprecated Prefer to use ::templateUpdate. This method will eventually become unavailable
+ */
+ public function templateUpdateWithHttpInfo(string $template_id, Model\TemplateUpdateRequest $template_update_request, string $contentType = self::contentTypes['templateUpdate'][0])
+ {
+ $request = $this->templateUpdateRequest($template_id, $template_update_request, $contentType);
+
+ try {
+ $options = $this->createHttpClientOption();
+ try {
+ $response = $this->client->send($request, $options);
+ $this->response = $response;
+ } catch (RequestException $e) {
+ throw new ApiException(
+ "[{$e->getCode()}] {$e->getMessage()}",
+ (int)$e->getCode(),
+ $e->getResponse() ? $e->getResponse()->getHeaders() : null,
+ $e->getResponse() ? (string)$e->getResponse()->getBody() : null
+ );
+ } catch (ConnectException $e) {
+ throw new ApiException(
+ "[{$e->getCode()}] {$e->getMessage()}",
+ (int)$e->getCode(),
+ null,
+ null
+ );
+ }
+
+ $statusCode = $response->getStatusCode();
+
+ $result = $this->handleRangeCodeResponse(
+ $response,
+ '4XX',
+ '\Dropbox\Sign\Model\ErrorResponse'
+ );
+ if ($result) {
+ return $result;
+ }
+
+ switch ($statusCode) {
+ case 200:
+ if ('\Dropbox\Sign\Model\TemplateGetResponse' === '\SplFileObject') {
+ $content = $response->getBody(); // stream goes to serializer
+ } else {
+ $content = (string)$response->getBody();
+ if ('\Dropbox\Sign\Model\TemplateGetResponse' !== 'string') {
+ try {
+ $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR);
+ } catch (JsonException $exception) {
+ throw new ApiException(
+ sprintf(
+ 'Error JSON decoding server response (%s)',
+ $request->getUri()
+ ),
+ $statusCode,
+ $response->getHeaders(),
+ $content
+ );
+ }
+ }
+ }
+
+ return [
+ ObjectSerializer::deserialize($content, '\Dropbox\Sign\Model\TemplateGetResponse', []),
+ $response->getStatusCode(),
+ $response->getHeaders(),
+ ];
+ }
+
+ if ($statusCode < 200 || $statusCode > 299) {
+ throw new ApiException(
+ sprintf(
+ '[%d] Error connecting to the API (%s)',
+ $statusCode,
+ (string)$request->getUri()
+ ),
+ $statusCode,
+ $response->getHeaders(),
+ (string)$response->getBody()
+ );
+ }
+
+ $returnType = '\Dropbox\Sign\Model\TemplateGetResponse';
+ if ($returnType === '\SplFileObject') {
+ $content = $response->getBody(); // stream goes to serializer
+ } else {
+ $content = (string)$response->getBody();
+ if ($returnType !== 'string') {
+ try {
+ $content = json_decode($content, false, 512, JSON_THROW_ON_ERROR);
+ } catch (JsonException $exception) {
+ throw new ApiException(
+ sprintf(
+ 'Error JSON decoding server response (%s)',
+ $request->getUri()
+ ),
+ $statusCode,
+ $response->getHeaders(),
+ $content
+ );
+ }
+ }
+ }
+
+ return [
+ ObjectSerializer::deserialize($content, $returnType, []),
+ $response->getStatusCode(),
+ $response->getHeaders(),
+ ];
+ } catch (ApiException $e) {
+ if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) {
+ throw $e;
+ }
+ switch ($e->getCode()) {
+ case 200:
+ $data = ObjectSerializer::deserialize(
+ $e->getResponseBody(),
+ '\Dropbox\Sign\Model\TemplateGetResponse',
+ $e->getResponseHeaders()
+ );
+ $e->setResponseObject($data);
+ break;
+ }
+ throw $e;
+ }
+ }
+
+ /**
+ * Operation templateUpdateAsync
+ *
+ * Update Template
+ *
+ * @param string $template_id The ID of the template to update. (required)
+ * @param Model\TemplateUpdateRequest $template_update_request (required)
+ * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdate'] to see the possible values for this operation
+ *
+ * @return \GuzzleHttp\Promise\PromiseInterface
+ * @throws InvalidArgumentException
+ * @deprecated Prefer to use ::templateUpdate. This method will eventually become unavailable
+ */
+ public function templateUpdateAsync(string $template_id, Model\TemplateUpdateRequest $template_update_request, string $contentType = self::contentTypes['templateUpdate'][0])
+ {
+ return $this->templateUpdateAsyncWithHttpInfo($template_id, $template_update_request, $contentType)
+ ->then(
+ function ($response) {
+ return $response[0];
+ }
+ );
+ }
+
+ /**
+ * Operation templateUpdateAsyncWithHttpInfo
+ *
+ * Update Template
+ *
+ * @param string $template_id The ID of the template to update. (required)
+ * @param Model\TemplateUpdateRequest $template_update_request (required)
+ * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdate'] to see the possible values for this operation
+ *
+ * @return \GuzzleHttp\Promise\PromiseInterface
+ * @throws InvalidArgumentException
+ * @deprecated Prefer to use ::templateUpdate. This method will eventually become unavailable
+ */
+ public function templateUpdateAsyncWithHttpInfo(string $template_id, Model\TemplateUpdateRequest $template_update_request, string $contentType = self::contentTypes['templateUpdate'][0])
+ {
+ $returnType = '\Dropbox\Sign\Model\TemplateGetResponse';
+ $request = $this->templateUpdateRequest($template_id, $template_update_request, $contentType);
+
+ return $this->client
+ ->sendAsync($request, $this->createHttpClientOption())
+ ->then(
+ function ($response) use ($returnType) {
+ if ($returnType === '\SplFileObject') {
+ $content = $response->getBody(); // stream goes to serializer
+ } else {
+ $content = (string)$response->getBody();
+ if ($returnType !== 'string') {
+ $content = json_decode($content);
+ }
+ }
+
+ return [
+ ObjectSerializer::deserialize($content, $returnType, []),
+ $response->getStatusCode(),
+ $response->getHeaders(),
+ ];
+ },
+ function ($exception) {
+ $response = $exception->getResponse();
+ $statusCode = $response->getStatusCode();
+ throw new ApiException(
+ sprintf(
+ '[%d] Error connecting to the API (%s)',
+ $statusCode,
+ $exception->getRequest()->getUri()
+ ),
+ $statusCode,
+ $response->getHeaders(),
+ (string)$response->getBody()
+ );
+ }
+ );
+ }
+
+ /**
+ * Create request for operation 'templateUpdate'
+ *
+ * @param string $template_id The ID of the template to update. (required)
+ * @param Model\TemplateUpdateRequest $template_update_request (required)
+ * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateUpdate'] to see the possible values for this operation
+ *
+ * @return Request
+ * @throws InvalidArgumentException
+ * @deprecated Prefer to use ::templateUpdate. This method will eventually become unavailable
+ */
+ public function templateUpdateRequest(string $template_id, Model\TemplateUpdateRequest $template_update_request, string $contentType = self::contentTypes['templateUpdate'][0])
+ {
+ // verify the required parameter 'template_id' is set
+ if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) {
+ throw new InvalidArgumentException(
+ 'Missing the required parameter $template_id when calling templateUpdate'
+ );
+ }
+
+ // verify the required parameter 'template_update_request' is set
+ if ($template_update_request === null || (is_array($template_update_request) && count($template_update_request) === 0)) {
+ throw new InvalidArgumentException(
+ 'Missing the required parameter $template_update_request when calling templateUpdate'
+ );
+ }
+
+ $resourcePath = '/template/update/{template_id}';
+ $formParams = [];
+ $queryParams = [];
+ $headerParams = [];
+ $httpBody = '';
+ $multipart = false;
+
+ $formParams = ObjectSerializer::getFormParams(
+ $template_update_request
+ );
+
+ $multipart = !empty($formParams);
+
+ // path params
+ if ($template_id !== null) {
+ $resourcePath = str_replace(
+ '{template_id}',
+ ObjectSerializer::toPathValue($template_id),
+ $resourcePath
+ );
+ }
+
+ $headers = $this->headerSelector->selectHeaders(
+ $multipart ? ['multipart/form-data'] : ['application/json'],
+ $contentType,
+ $multipart
+ );
+
+ // for model (json/xml)
+ if (count($formParams) === 0) {
+ if (stripos($headers['Content-Type'], 'application/json') !== false) {
+ // if Content-Type contains "application/json", json_encode the body
+ $httpBody = \GuzzleHttp\Utils::jsonEncode(ObjectSerializer::sanitizeForSerialization($template_update_request));
+ } else {
+ $httpBody = $template_update_request;
+ }
+ } elseif (count($formParams) > 0) {
+ if ($multipart) {
+ $multipartContents = [];
+ foreach ($formParams as $formParamName => $formParamValue) {
+ $formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue];
+ foreach ($formParamValueItems as $formParamValueItem) {
+ $multipartContents[] = [
+ 'name' => $formParamName,
+ 'contents' => $formParamValueItem,
+ ];
+ }
+ }
+ // for HTTP post (form)
+ if (!empty($body)) {
+ $multipartContents[] = [
+ 'name' => 'body',
+ 'contents' => $body,
+ 'headers' => ['Content-Type' => 'application/json'],
+ ];
+ }
+
+ if ($payloadHook = $this->config->getPayloadHook()) {
+ $payloadHook('multipart', $multipartContents, $template_update_request);
+ }
+ $httpBody = new MultipartStream($multipartContents);
+ } elseif (stripos($headers['Content-Type'], 'application/json') !== false) {
+ // if Content-Type contains "application/json", json_encode the form parameters
+ $httpBody = \GuzzleHttp\Utils::jsonEncode($formParams);
+ } else {
+ // for HTTP post (form)
+ $httpBody = ObjectSerializer::buildQuery($formParams);
+ }
+ }
+
+ // this endpoint requires HTTP basic authentication
+ if (!empty($this->config->getUsername())) {
+ $headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ':');
+ }
+ // this endpoint requires Bearer (JWT) authentication (access token)
+ if (!empty($this->config->getAccessToken())) {
+ $headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken();
+ }
+
+ $defaultHeaders = [];
+ if ($this->config->getUserAgent()) {
+ $defaultHeaders['User-Agent'] = $this->config->getUserAgent();
+ }
+
+ $headers = array_merge(
+ $defaultHeaders,
+ $headerParams,
+ $headers
+ );
+
+ $operationHost = $this->config->getHost();
+ $query = ObjectSerializer::buildQuery($queryParams);
+ return new Request(
+ 'POST',
+ $operationHost . $resourcePath . ($query ? "?{$query}" : ''),
+ $headers,
+ $httpBody
+ );
+ }
+
/**
* Operation templateUpdateFiles
*
diff --git a/src/Configuration.php b/src/Configuration.php
index 684acca..ccaf202 100644
--- a/src/Configuration.php
+++ b/src/Configuration.php
@@ -97,7 +97,7 @@ class Configuration
*
* @var string
*/
- protected $userAgent = 'OpenAPI-Generator/1.10.0/PHP';
+ protected $userAgent = 'OpenAPI-Generator/1.11.0/PHP';
/**
* Debug switch (default set to false)
@@ -438,7 +438,7 @@ public static function toDebugReport()
$report .= ' OS: ' . php_uname() . PHP_EOL;
$report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL;
$report .= ' The version of the OpenAPI document: 3.0.0' . PHP_EOL;
- $report .= ' SDK Package Version: 1.10.0' . PHP_EOL;
+ $report .= ' SDK Package Version: 1.11.0' . PHP_EOL;
$report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
return $report;
diff --git a/src/Model/AccountResponse.php b/src/Model/AccountResponse.php
index 251546b..25a88c2 100644
--- a/src/Model/AccountResponse.php
+++ b/src/Model/AccountResponse.php
@@ -68,6 +68,7 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable
'team_id' => 'string',
'locale' => 'string',
'usage' => '\Dropbox\Sign\Model\AccountResponseUsage',
+ 'settings' => '\Dropbox\Sign\Model\AccountResponseSettings',
];
/**
@@ -89,6 +90,7 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable
'team_id' => null,
'locale' => null,
'usage' => null,
+ 'settings' => null,
];
/**
@@ -108,6 +110,7 @@ class AccountResponse implements ModelInterface, ArrayAccess, JsonSerializable
'team_id' => true,
'locale' => true,
'usage' => false,
+ 'settings' => false,
];
/**
@@ -199,6 +202,7 @@ public function isNullableSetToNull(string $property): bool
'team_id' => 'team_id',
'locale' => 'locale',
'usage' => 'usage',
+ 'settings' => 'settings',
];
/**
@@ -218,6 +222,7 @@ public function isNullableSetToNull(string $property): bool
'team_id' => 'setTeamId',
'locale' => 'setLocale',
'usage' => 'setUsage',
+ 'settings' => 'setSettings',
];
/**
@@ -237,6 +242,7 @@ public function isNullableSetToNull(string $property): bool
'team_id' => 'getTeamId',
'locale' => 'getLocale',
'usage' => 'getUsage',
+ 'settings' => 'getSettings',
];
/**
@@ -306,6 +312,7 @@ public function __construct(?array $data = null)
$this->setIfExists('team_id', $data ?? [], null);
$this->setIfExists('locale', $data ?? [], null);
$this->setIfExists('usage', $data ?? [], null);
+ $this->setIfExists('settings', $data ?? [], null);
}
/**
@@ -690,6 +697,33 @@ public function setUsage(?AccountResponseUsage $usage)
return $this;
}
+ /**
+ * Gets settings
+ *
+ * @return AccountResponseSettings|null
+ */
+ public function getSettings()
+ {
+ return $this->container['settings'];
+ }
+
+ /**
+ * Sets settings
+ *
+ * @param AccountResponseSettings|null $settings settings
+ *
+ * @return self
+ */
+ public function setSettings(?AccountResponseSettings $settings)
+ {
+ if (is_null($settings)) {
+ throw new InvalidArgumentException('non-nullable settings cannot be null');
+ }
+ $this->container['settings'] = $settings;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/AccountResponseSettings.php b/src/Model/AccountResponseSettings.php
new file mode 100644
index 0000000..b150e80
--- /dev/null
+++ b/src/Model/AccountResponseSettings.php
@@ -0,0 +1,480 @@
+
+ */
+class AccountResponseSettings implements ModelInterface, ArrayAccess, JsonSerializable
+{
+ public const DISCRIMINATOR = null;
+
+ /**
+ * The original name of the model.
+ *
+ * @var string
+ */
+ protected static $openAPIModelName = 'AccountResponseSettings';
+
+ /**
+ * Array of property to type mappings. Used for (de)serialization
+ *
+ * @var string[]
+ */
+ protected static $openAPITypes = [
+ 'signer_access_codes' => 'bool',
+ 'sms_delivery' => 'bool',
+ 'sms_authentication' => 'bool',
+ ];
+
+ /**
+ * Array of property to format mappings. Used for (de)serialization
+ *
+ * @var string[]
+ * @phpstan-var array
+ * @psalm-var array
+ */
+ protected static $openAPIFormats = [
+ 'signer_access_codes' => null,
+ 'sms_delivery' => null,
+ 'sms_authentication' => null,
+ ];
+
+ /**
+ * Array of nullable properties. Used for (de)serialization
+ *
+ * @var bool[]
+ */
+ protected static array $openAPINullables = [
+ 'signer_access_codes' => false,
+ 'sms_delivery' => false,
+ 'sms_authentication' => false,
+ ];
+
+ /**
+ * If a nullable field gets set to null, insert it here
+ *
+ * @var bool[]
+ */
+ protected array $openAPINullablesSetToNull = [];
+
+ /**
+ * Array of property to type mappings. Used for (de)serialization
+ *
+ * @return array
+ */
+ public static function openAPITypes()
+ {
+ return self::$openAPITypes;
+ }
+
+ /**
+ * Array of property to format mappings. Used for (de)serialization
+ *
+ * @return array
+ */
+ public static function openAPIFormats()
+ {
+ return self::$openAPIFormats;
+ }
+
+ /**
+ * Array of nullable properties
+ */
+ protected static function openAPINullables(): array
+ {
+ return self::$openAPINullables;
+ }
+
+ /**
+ * Array of nullable field names deliberately set to null
+ *
+ * @return bool[]
+ */
+ private function getOpenAPINullablesSetToNull(): array
+ {
+ return $this->openAPINullablesSetToNull;
+ }
+
+ /**
+ * Setter - Array of nullable field names deliberately set to null
+ *
+ * @param bool[] $openAPINullablesSetToNull
+ */
+ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
+ {
+ $this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
+ }
+
+ /**
+ * Checks if a property is nullable
+ */
+ public static function isNullable(string $property): bool
+ {
+ return self::openAPINullables()[$property] ?? false;
+ }
+
+ /**
+ * Checks if a nullable property is set to null.
+ */
+ public function isNullableSetToNull(string $property): bool
+ {
+ return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
+ }
+
+ /**
+ * Array of attributes where the key is the local name,
+ * and the value is the original name
+ *
+ * @var string[]
+ */
+ protected static $attributeMap = [
+ 'signer_access_codes' => 'signer_access_codes',
+ 'sms_delivery' => 'sms_delivery',
+ 'sms_authentication' => 'sms_authentication',
+ ];
+
+ /**
+ * Array of attributes to setter functions (for deserialization of responses)
+ *
+ * @var string[]
+ */
+ protected static $setters = [
+ 'signer_access_codes' => 'setSignerAccessCodes',
+ 'sms_delivery' => 'setSmsDelivery',
+ 'sms_authentication' => 'setSmsAuthentication',
+ ];
+
+ /**
+ * Array of attributes to getter functions (for serialization of requests)
+ *
+ * @var string[]
+ */
+ protected static $getters = [
+ 'signer_access_codes' => 'getSignerAccessCodes',
+ 'sms_delivery' => 'getSmsDelivery',
+ 'sms_authentication' => 'getSmsAuthentication',
+ ];
+
+ /**
+ * Array of attributes where the key is the local name,
+ * and the value is the original name
+ *
+ * @return array
+ */
+ public static function attributeMap()
+ {
+ return self::$attributeMap;
+ }
+
+ /**
+ * Array of attributes to setter functions (for deserialization of responses)
+ *
+ * @return array
+ */
+ public static function setters()
+ {
+ return self::$setters;
+ }
+
+ /**
+ * Array of attributes to getter functions (for serialization of requests)
+ *
+ * @return array
+ */
+ public static function getters()
+ {
+ return self::$getters;
+ }
+
+ /**
+ * The original name of the model.
+ *
+ * @return string
+ */
+ public function getModelName()
+ {
+ return self::$openAPIModelName;
+ }
+
+ /**
+ * Associative array for storing property values
+ *
+ * @var mixed[]
+ */
+ protected $container = [];
+
+ /**
+ * Constructor
+ *
+ * @param mixed[]|null $data Associated array of property values
+ * initializing the model
+ */
+ public function __construct(?array $data = null)
+ {
+ $this->setIfExists('signer_access_codes', $data ?? [], null);
+ $this->setIfExists('sms_delivery', $data ?? [], null);
+ $this->setIfExists('sms_authentication', $data ?? [], null);
+ }
+
+ /**
+ * @deprecated use ::init()
+ */
+ public static function fromArray(array $data): AccountResponseSettings
+ {
+ return self::init($data);
+ }
+
+ /**
+ * Attempt to instantiate and hydrate a new instance of this class
+ */
+ public static function init(array $data): AccountResponseSettings
+ {
+ /** @var AccountResponseSettings */
+ return ObjectSerializer::deserialize(
+ $data,
+ AccountResponseSettings::class,
+ );
+ }
+
+ /**
+ * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
+ * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
+ * $this->openAPINullablesSetToNull array
+ *
+ * @param string|int|object|array|mixed $defaultValue
+ */
+ private function setIfExists(string $variableName, array $fields, $defaultValue): void
+ {
+ if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
+ $this->openAPINullablesSetToNull[] = $variableName;
+ }
+
+ $this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
+ }
+
+ /**
+ * Show all the invalid properties with reasons.
+ *
+ * @return array invalid properties with reasons
+ */
+ public function listInvalidProperties()
+ {
+ return [];
+ }
+
+ /**
+ * Validate all the properties in the model
+ * return true if all passed
+ *
+ * @return bool True if all properties are valid
+ */
+ public function valid()
+ {
+ return count($this->listInvalidProperties()) === 0;
+ }
+
+ /**
+ * Gets signer_access_codes
+ *
+ * @return bool|null
+ */
+ public function getSignerAccessCodes()
+ {
+ return $this->container['signer_access_codes'];
+ }
+
+ /**
+ * Sets signer_access_codes
+ *
+ * @param bool|null $signer_access_codes Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
+ *
+ * @return self
+ */
+ public function setSignerAccessCodes(?bool $signer_access_codes)
+ {
+ if (is_null($signer_access_codes)) {
+ throw new InvalidArgumentException('non-nullable signer_access_codes cannot be null');
+ }
+ $this->container['signer_access_codes'] = $signer_access_codes;
+
+ return $this;
+ }
+
+ /**
+ * Gets sms_delivery
+ *
+ * @return bool|null
+ */
+ public function getSmsDelivery()
+ {
+ return $this->container['sms_delivery'];
+ }
+
+ /**
+ * Sets sms_delivery
+ *
+ * @param bool|null $sms_delivery Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
+ *
+ * @return self
+ */
+ public function setSmsDelivery(?bool $sms_delivery)
+ {
+ if (is_null($sms_delivery)) {
+ throw new InvalidArgumentException('non-nullable sms_delivery cannot be null');
+ }
+ $this->container['sms_delivery'] = $sms_delivery;
+
+ return $this;
+ }
+
+ /**
+ * Gets sms_authentication
+ *
+ * @return bool|null
+ */
+ public function getSmsAuthentication()
+ {
+ return $this->container['sms_authentication'];
+ }
+
+ /**
+ * Sets sms_authentication
+ *
+ * @param bool|null $sms_authentication Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough).
+ *
+ * @return self
+ */
+ public function setSmsAuthentication(?bool $sms_authentication)
+ {
+ if (is_null($sms_authentication)) {
+ throw new InvalidArgumentException('non-nullable sms_authentication cannot be null');
+ }
+ $this->container['sms_authentication'] = $sms_authentication;
+
+ return $this;
+ }
+
+ /**
+ * Returns true if offset exists. False otherwise.
+ *
+ * @param int $offset Offset
+ */
+ #[ReturnTypeWillChange]
+ public function offsetExists($offset): bool
+ {
+ return isset($this->container[$offset]);
+ }
+
+ /**
+ * Gets offset.
+ *
+ * @param int $offset Offset
+ *
+ * @return mixed|null
+ */
+ #[ReturnTypeWillChange]
+ public function offsetGet($offset)
+ {
+ return $this->container[$offset] ?? null;
+ }
+
+ /**
+ * Sets value based on offset.
+ *
+ * @param int|null $offset Offset
+ * @param mixed $value Value to be set
+ */
+ #[ReturnTypeWillChange]
+ public function offsetSet($offset, $value): void
+ {
+ if (is_null($offset)) {
+ $this->container[] = $value;
+ } else {
+ $this->container[$offset] = $value;
+ }
+ }
+
+ /**
+ * Unsets offset.
+ *
+ * @param int $offset Offset
+ */
+ #[ReturnTypeWillChange]
+ public function offsetUnset($offset): void
+ {
+ unset($this->container[$offset]);
+ }
+
+ /**
+ * Serializes the object to a value that can be serialized natively by json_encode().
+ * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php
+ *
+ * @return mixed returns data which can be serialized by json_encode(), which is a value
+ * of any type other than a resource
+ */
+ #[ReturnTypeWillChange]
+ public function jsonSerialize()
+ {
+ return ObjectSerializer::sanitizeForSerialization($this);
+ }
+
+ /**
+ * Gets the string presentation of the object
+ *
+ * @return string
+ */
+ public function __toString()
+ {
+ return json_encode(
+ ObjectSerializer::sanitizeForSerialization($this),
+ JSON_UNESCAPED_SLASHES
+ );
+ }
+
+ /**
+ * Gets a header-safe presentation of the object
+ *
+ * @return string
+ */
+ public function toHeaderValue()
+ {
+ return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+ }
+}
diff --git a/src/Model/BulkSendJobGetResponseSignatureRequests.php b/src/Model/BulkSendJobGetResponseSignatureRequests.php
index f40d42b..886511a 100644
--- a/src/Model/BulkSendJobGetResponseSignatureRequests.php
+++ b/src/Model/BulkSendJobGetResponseSignatureRequests.php
@@ -82,6 +82,7 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc
'response_data' => '\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]',
'signatures' => '\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]',
'bulk_send_job_id' => 'string',
+ 'signer_experience' => '\Dropbox\Sign\Model\SignatureRequestSignerExperience',
];
/**
@@ -117,6 +118,7 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc
'response_data' => null,
'signatures' => null,
'bulk_send_job_id' => null,
+ 'signer_experience' => null,
];
/**
@@ -150,6 +152,7 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc
'response_data' => true,
'signatures' => false,
'bulk_send_job_id' => false,
+ 'signer_experience' => false,
];
/**
@@ -255,6 +258,7 @@ public function isNullableSetToNull(string $property): bool
'response_data' => 'response_data',
'signatures' => 'signatures',
'bulk_send_job_id' => 'bulk_send_job_id',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -288,6 +292,7 @@ public function isNullableSetToNull(string $property): bool
'response_data' => 'setResponseData',
'signatures' => 'setSignatures',
'bulk_send_job_id' => 'setBulkSendJobId',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -321,6 +326,7 @@ public function isNullableSetToNull(string $property): bool
'response_data' => 'getResponseData',
'signatures' => 'getSignatures',
'bulk_send_job_id' => 'getBulkSendJobId',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -404,6 +410,7 @@ public function __construct(?array $data = null)
$this->setIfExists('response_data', $data ?? [], null);
$this->setIfExists('signatures', $data ?? [], null);
$this->setIfExists('bulk_send_job_id', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -1215,6 +1222,33 @@ public function setBulkSendJobId(?string $bulk_send_job_id)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SignatureRequestSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SignatureRequestSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SignatureRequestSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/EmbeddedEditUrlRequest.php b/src/Model/EmbeddedEditUrlRequest.php
index 4a76a2c..a6859d8 100644
--- a/src/Model/EmbeddedEditUrlRequest.php
+++ b/src/Model/EmbeddedEditUrlRequest.php
@@ -67,6 +67,7 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali
'show_preview' => 'bool',
'show_progress_stepper' => 'bool',
'test_mode' => 'bool',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -87,6 +88,7 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali
'show_preview' => null,
'show_progress_stepper' => null,
'test_mode' => null,
+ 'signer_experience' => null,
];
/**
@@ -105,6 +107,7 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali
'show_preview' => false,
'show_progress_stepper' => false,
'test_mode' => false,
+ 'signer_experience' => false,
];
/**
@@ -195,6 +198,7 @@ public function isNullableSetToNull(string $property): bool
'show_preview' => 'show_preview',
'show_progress_stepper' => 'show_progress_stepper',
'test_mode' => 'test_mode',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -213,6 +217,7 @@ public function isNullableSetToNull(string $property): bool
'show_preview' => 'setShowPreview',
'show_progress_stepper' => 'setShowProgressStepper',
'test_mode' => 'setTestMode',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -231,6 +236,7 @@ public function isNullableSetToNull(string $property): bool
'show_preview' => 'getShowPreview',
'show_progress_stepper' => 'getShowProgressStepper',
'test_mode' => 'getTestMode',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -299,6 +305,7 @@ public function __construct(?array $data = null)
$this->setIfExists('show_preview', $data ?? [], false);
$this->setIfExists('show_progress_stepper', $data ?? [], true);
$this->setIfExists('test_mode', $data ?? [], false);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -628,6 +635,33 @@ public function setTestMode(?bool $test_mode)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/SignatureRequestCreateEmbeddedRequest.php b/src/Model/SignatureRequestCreateEmbeddedRequest.php
index 1a7cda1..0b859ca 100644
--- a/src/Model/SignatureRequestCreateEmbeddedRequest.php
+++ b/src/Model/SignatureRequestCreateEmbeddedRequest.php
@@ -81,6 +81,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce
'title' => 'string',
'use_text_tags' => 'bool',
'populate_auto_fill_fields' => 'bool',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
'expires_at' => 'int',
];
@@ -115,6 +116,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce
'title' => null,
'use_text_tags' => null,
'populate_auto_fill_fields' => null,
+ 'signer_experience' => null,
'expires_at' => null,
];
@@ -147,6 +149,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce
'title' => false,
'use_text_tags' => false,
'populate_auto_fill_fields' => false,
+ 'signer_experience' => false,
'expires_at' => true,
];
@@ -251,6 +254,7 @@ public function isNullableSetToNull(string $property): bool
'title' => 'title',
'use_text_tags' => 'use_text_tags',
'populate_auto_fill_fields' => 'populate_auto_fill_fields',
+ 'signer_experience' => 'signer_experience',
'expires_at' => 'expires_at',
];
@@ -283,6 +287,7 @@ public function isNullableSetToNull(string $property): bool
'title' => 'setTitle',
'use_text_tags' => 'setUseTextTags',
'populate_auto_fill_fields' => 'setPopulateAutoFillFields',
+ 'signer_experience' => 'setSignerExperience',
'expires_at' => 'setExpiresAt',
];
@@ -315,6 +320,7 @@ public function isNullableSetToNull(string $property): bool
'title' => 'getTitle',
'use_text_tags' => 'getUseTextTags',
'populate_auto_fill_fields' => 'getPopulateAutoFillFields',
+ 'signer_experience' => 'getSignerExperience',
'expires_at' => 'getExpiresAt',
];
@@ -397,6 +403,7 @@ public function __construct(?array $data = null)
$this->setIfExists('title', $data ?? [], null);
$this->setIfExists('use_text_tags', $data ?? [], false);
$this->setIfExists('populate_auto_fill_fields', $data ?? [], false);
+ $this->setIfExists('signer_experience', $data ?? [], null);
$this->setIfExists('expires_at', $data ?? [], null);
}
@@ -1108,6 +1115,33 @@ public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Gets expires_at
*
diff --git a/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php b/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php
index b903962..85d62c8 100644
--- a/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php
+++ b/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php
@@ -73,6 +73,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac
'test_mode' => 'bool',
'title' => 'string',
'populate_auto_fill_fields' => 'bool',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -98,6 +99,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac
'test_mode' => null,
'title' => null,
'populate_auto_fill_fields' => null,
+ 'signer_experience' => null,
];
/**
@@ -121,6 +123,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac
'test_mode' => false,
'title' => false,
'populate_auto_fill_fields' => false,
+ 'signer_experience' => false,
];
/**
@@ -216,6 +219,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'test_mode',
'title' => 'title',
'populate_auto_fill_fields' => 'populate_auto_fill_fields',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -239,6 +243,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'setTestMode',
'title' => 'setTitle',
'populate_auto_fill_fields' => 'setPopulateAutoFillFields',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -262,6 +267,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'getTestMode',
'title' => 'getTitle',
'populate_auto_fill_fields' => 'getPopulateAutoFillFields',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -335,6 +341,7 @@ public function __construct(?array $data = null)
$this->setIfExists('test_mode', $data ?? [], false);
$this->setIfExists('title', $data ?? [], null);
$this->setIfExists('populate_auto_fill_fields', $data ?? [], false);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -835,6 +842,33 @@ public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/SignatureRequestEditEmbeddedRequest.php b/src/Model/SignatureRequestEditEmbeddedRequest.php
index 2795f5a..8a52e73 100644
--- a/src/Model/SignatureRequestEditEmbeddedRequest.php
+++ b/src/Model/SignatureRequestEditEmbeddedRequest.php
@@ -82,6 +82,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess
'use_text_tags' => 'bool',
'populate_auto_fill_fields' => 'bool',
'expires_at' => 'int',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -116,6 +117,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess
'use_text_tags' => null,
'populate_auto_fill_fields' => null,
'expires_at' => null,
+ 'signer_experience' => null,
];
/**
@@ -148,6 +150,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess
'use_text_tags' => false,
'populate_auto_fill_fields' => false,
'expires_at' => true,
+ 'signer_experience' => false,
];
/**
@@ -252,6 +255,7 @@ public function isNullableSetToNull(string $property): bool
'use_text_tags' => 'use_text_tags',
'populate_auto_fill_fields' => 'populate_auto_fill_fields',
'expires_at' => 'expires_at',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -284,6 +288,7 @@ public function isNullableSetToNull(string $property): bool
'use_text_tags' => 'setUseTextTags',
'populate_auto_fill_fields' => 'setPopulateAutoFillFields',
'expires_at' => 'setExpiresAt',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -316,6 +321,7 @@ public function isNullableSetToNull(string $property): bool
'use_text_tags' => 'getUseTextTags',
'populate_auto_fill_fields' => 'getPopulateAutoFillFields',
'expires_at' => 'getExpiresAt',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -398,6 +404,7 @@ public function __construct(?array $data = null)
$this->setIfExists('use_text_tags', $data ?? [], false);
$this->setIfExists('populate_auto_fill_fields', $data ?? [], false);
$this->setIfExists('expires_at', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -1142,6 +1149,33 @@ public function setExpiresAt(?int $expires_at)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php b/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php
index 05fbee5..f1d95b1 100644
--- a/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php
+++ b/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php
@@ -73,6 +73,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest implements ModelInterface,
'test_mode' => 'bool',
'title' => 'string',
'populate_auto_fill_fields' => 'bool',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -98,6 +99,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest implements ModelInterface,
'test_mode' => null,
'title' => null,
'populate_auto_fill_fields' => null,
+ 'signer_experience' => null,
];
/**
@@ -121,6 +123,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest implements ModelInterface,
'test_mode' => false,
'title' => false,
'populate_auto_fill_fields' => false,
+ 'signer_experience' => false,
];
/**
@@ -216,6 +219,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'test_mode',
'title' => 'title',
'populate_auto_fill_fields' => 'populate_auto_fill_fields',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -239,6 +243,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'setTestMode',
'title' => 'setTitle',
'populate_auto_fill_fields' => 'setPopulateAutoFillFields',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -262,6 +267,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'getTestMode',
'title' => 'getTitle',
'populate_auto_fill_fields' => 'getPopulateAutoFillFields',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -335,6 +341,7 @@ public function __construct(?array $data = null)
$this->setIfExists('test_mode', $data ?? [], false);
$this->setIfExists('title', $data ?? [], null);
$this->setIfExists('populate_auto_fill_fields', $data ?? [], false);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -835,6 +842,33 @@ public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/SignatureRequestEditRequest.php b/src/Model/SignatureRequestEditRequest.php
index 8763f7d..e256211 100644
--- a/src/Model/SignatureRequestEditRequest.php
+++ b/src/Model/SignatureRequestEditRequest.php
@@ -83,6 +83,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe
'title' => 'string',
'use_text_tags' => 'bool',
'expires_at' => 'int',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -118,6 +119,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe
'title' => null,
'use_text_tags' => null,
'expires_at' => null,
+ 'signer_experience' => null,
];
/**
@@ -151,6 +153,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe
'title' => false,
'use_text_tags' => false,
'expires_at' => true,
+ 'signer_experience' => false,
];
/**
@@ -256,6 +259,7 @@ public function isNullableSetToNull(string $property): bool
'title' => 'title',
'use_text_tags' => 'use_text_tags',
'expires_at' => 'expires_at',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -289,6 +293,7 @@ public function isNullableSetToNull(string $property): bool
'title' => 'setTitle',
'use_text_tags' => 'setUseTextTags',
'expires_at' => 'setExpiresAt',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -322,6 +327,7 @@ public function isNullableSetToNull(string $property): bool
'title' => 'getTitle',
'use_text_tags' => 'getUseTextTags',
'expires_at' => 'getExpiresAt',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -405,6 +411,7 @@ public function __construct(?array $data = null)
$this->setIfExists('title', $data ?? [], null);
$this->setIfExists('use_text_tags', $data ?? [], false);
$this->setIfExists('expires_at', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -896,7 +903,7 @@ public function getIsEid()
/**
* Sets is_eid
*
- * @param bool|null $is_eid 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.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ * @param bool|null $is_eid 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.
**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
*
* @return self
*/
@@ -1173,6 +1180,33 @@ public function setExpiresAt(?int $expires_at)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/SignatureRequestEditWithTemplateRequest.php b/src/Model/SignatureRequestEditWithTemplateRequest.php
index b27cec8..db6d326 100644
--- a/src/Model/SignatureRequestEditWithTemplateRequest.php
+++ b/src/Model/SignatureRequestEditWithTemplateRequest.php
@@ -75,6 +75,7 @@ class SignatureRequestEditWithTemplateRequest implements ModelInterface, ArrayAc
'subject' => 'string',
'test_mode' => 'bool',
'title' => 'string',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -101,6 +102,7 @@ class SignatureRequestEditWithTemplateRequest implements ModelInterface, ArrayAc
'subject' => null,
'test_mode' => null,
'title' => null,
+ 'signer_experience' => null,
];
/**
@@ -125,6 +127,7 @@ class SignatureRequestEditWithTemplateRequest implements ModelInterface, ArrayAc
'subject' => false,
'test_mode' => false,
'title' => false,
+ 'signer_experience' => false,
];
/**
@@ -221,6 +224,7 @@ public function isNullableSetToNull(string $property): bool
'subject' => 'subject',
'test_mode' => 'test_mode',
'title' => 'title',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -245,6 +249,7 @@ public function isNullableSetToNull(string $property): bool
'subject' => 'setSubject',
'test_mode' => 'setTestMode',
'title' => 'setTitle',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -269,6 +274,7 @@ public function isNullableSetToNull(string $property): bool
'subject' => 'getSubject',
'test_mode' => 'getTestMode',
'title' => 'getTitle',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -343,6 +349,7 @@ public function __construct(?array $data = null)
$this->setIfExists('subject', $data ?? [], null);
$this->setIfExists('test_mode', $data ?? [], false);
$this->setIfExists('title', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -651,7 +658,7 @@ public function getIsEid()
/**
* Sets is_eid
*
- * @param bool|null $is_eid 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.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ * @param bool|null $is_eid 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.
**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
*
* @return self
*/
@@ -867,6 +874,33 @@ public function setTitle(?string $title)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/SignatureRequestResponse.php b/src/Model/SignatureRequestResponse.php
index 6993121..4754457 100644
--- a/src/Model/SignatureRequestResponse.php
+++ b/src/Model/SignatureRequestResponse.php
@@ -83,6 +83,7 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSeria
'response_data' => '\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]',
'signatures' => '\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]',
'bulk_send_job_id' => 'string',
+ 'signer_experience' => '\Dropbox\Sign\Model\SignatureRequestSignerExperience',
];
/**
@@ -118,6 +119,7 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSeria
'response_data' => null,
'signatures' => null,
'bulk_send_job_id' => null,
+ 'signer_experience' => null,
];
/**
@@ -151,6 +153,7 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSeria
'response_data' => true,
'signatures' => false,
'bulk_send_job_id' => true,
+ 'signer_experience' => false,
];
/**
@@ -256,6 +259,7 @@ public function isNullableSetToNull(string $property): bool
'response_data' => 'response_data',
'signatures' => 'signatures',
'bulk_send_job_id' => 'bulk_send_job_id',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -289,6 +293,7 @@ public function isNullableSetToNull(string $property): bool
'response_data' => 'setResponseData',
'signatures' => 'setSignatures',
'bulk_send_job_id' => 'setBulkSendJobId',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -322,6 +327,7 @@ public function isNullableSetToNull(string $property): bool
'response_data' => 'getResponseData',
'signatures' => 'getSignatures',
'bulk_send_job_id' => 'getBulkSendJobId',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -405,6 +411,7 @@ public function __construct(?array $data = null)
$this->setIfExists('response_data', $data ?? [], null);
$this->setIfExists('signatures', $data ?? [], null);
$this->setIfExists('bulk_send_job_id', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -1223,6 +1230,33 @@ public function setBulkSendJobId(?string $bulk_send_job_id)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SignatureRequestSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SignatureRequestSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SignatureRequestSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/SignatureRequestSendRequest.php b/src/Model/SignatureRequestSendRequest.php
index 1d4379e..40c6d24 100644
--- a/src/Model/SignatureRequestSendRequest.php
+++ b/src/Model/SignatureRequestSendRequest.php
@@ -84,6 +84,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe
'title' => 'string',
'use_text_tags' => 'bool',
'expires_at' => 'int',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -120,6 +121,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe
'title' => null,
'use_text_tags' => null,
'expires_at' => null,
+ 'signer_experience' => null,
];
/**
@@ -154,6 +156,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe
'title' => false,
'use_text_tags' => false,
'expires_at' => true,
+ 'signer_experience' => false,
];
/**
@@ -260,6 +263,7 @@ public function isNullableSetToNull(string $property): bool
'title' => 'title',
'use_text_tags' => 'use_text_tags',
'expires_at' => 'expires_at',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -294,6 +298,7 @@ public function isNullableSetToNull(string $property): bool
'title' => 'setTitle',
'use_text_tags' => 'setUseTextTags',
'expires_at' => 'setExpiresAt',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -328,6 +333,7 @@ public function isNullableSetToNull(string $property): bool
'title' => 'getTitle',
'use_text_tags' => 'getUseTextTags',
'expires_at' => 'getExpiresAt',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -412,6 +418,7 @@ public function __construct(?array $data = null)
$this->setIfExists('title', $data ?? [], null);
$this->setIfExists('use_text_tags', $data ?? [], false);
$this->setIfExists('expires_at', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -932,7 +939,7 @@ public function getIsEid()
/**
* Sets is_eid
*
- * @param bool|null $is_eid 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.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ * @param bool|null $is_eid 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.
**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
*
* @return self
*/
@@ -1209,6 +1216,33 @@ public function setExpiresAt(?int $expires_at)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/SignatureRequestSendWithTemplateRequest.php b/src/Model/SignatureRequestSendWithTemplateRequest.php
index a353109..557290f 100644
--- a/src/Model/SignatureRequestSendWithTemplateRequest.php
+++ b/src/Model/SignatureRequestSendWithTemplateRequest.php
@@ -76,6 +76,7 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc
'subject' => 'string',
'test_mode' => 'bool',
'title' => 'string',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -103,6 +104,7 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc
'subject' => null,
'test_mode' => null,
'title' => null,
+ 'signer_experience' => null,
];
/**
@@ -128,6 +130,7 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc
'subject' => false,
'test_mode' => false,
'title' => false,
+ 'signer_experience' => false,
];
/**
@@ -225,6 +228,7 @@ public function isNullableSetToNull(string $property): bool
'subject' => 'subject',
'test_mode' => 'test_mode',
'title' => 'title',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -250,6 +254,7 @@ public function isNullableSetToNull(string $property): bool
'subject' => 'setSubject',
'test_mode' => 'setTestMode',
'title' => 'setTitle',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -275,6 +280,7 @@ public function isNullableSetToNull(string $property): bool
'subject' => 'getSubject',
'test_mode' => 'getTestMode',
'title' => 'getTitle',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -350,6 +356,7 @@ public function __construct(?array $data = null)
$this->setIfExists('subject', $data ?? [], null);
$this->setIfExists('test_mode', $data ?? [], false);
$this->setIfExists('title', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -687,7 +694,7 @@ public function getIsEid()
/**
* Sets is_eid
*
- * @param bool|null $is_eid 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.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ * @param bool|null $is_eid 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.
**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer.
*
* @return self
*/
@@ -903,6 +910,33 @@ public function setTitle(?string $title)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/SignatureRequestSignerExperience.php b/src/Model/SignatureRequestSignerExperience.php
new file mode 100644
index 0000000..a6d40e6
--- /dev/null
+++ b/src/Model/SignatureRequestSignerExperience.php
@@ -0,0 +1,456 @@
+
+ */
+class SignatureRequestSignerExperience implements ModelInterface, ArrayAccess, JsonSerializable
+{
+ public const DISCRIMINATOR = null;
+
+ /**
+ * The original name of the model.
+ *
+ * @var string
+ */
+ protected static $openAPIModelName = 'SignatureRequestSignerExperience';
+
+ /**
+ * Array of property to type mappings. Used for (de)serialization
+ *
+ * @var string[]
+ */
+ protected static $openAPITypes = [
+ 'form_view' => 'string',
+ ];
+
+ /**
+ * Array of property to format mappings. Used for (de)serialization
+ *
+ * @var string[]
+ * @phpstan-var array
+ * @psalm-var array
+ */
+ protected static $openAPIFormats = [
+ 'form_view' => null,
+ ];
+
+ /**
+ * Array of nullable properties. Used for (de)serialization
+ *
+ * @var bool[]
+ */
+ protected static array $openAPINullables = [
+ 'form_view' => false,
+ ];
+
+ /**
+ * If a nullable field gets set to null, insert it here
+ *
+ * @var bool[]
+ */
+ protected array $openAPINullablesSetToNull = [];
+
+ /**
+ * Array of property to type mappings. Used for (de)serialization
+ *
+ * @return array
+ */
+ public static function openAPITypes()
+ {
+ return self::$openAPITypes;
+ }
+
+ /**
+ * Array of property to format mappings. Used for (de)serialization
+ *
+ * @return array
+ */
+ public static function openAPIFormats()
+ {
+ return self::$openAPIFormats;
+ }
+
+ /**
+ * Array of nullable properties
+ */
+ protected static function openAPINullables(): array
+ {
+ return self::$openAPINullables;
+ }
+
+ /**
+ * Array of nullable field names deliberately set to null
+ *
+ * @return bool[]
+ */
+ private function getOpenAPINullablesSetToNull(): array
+ {
+ return $this->openAPINullablesSetToNull;
+ }
+
+ /**
+ * Setter - Array of nullable field names deliberately set to null
+ *
+ * @param bool[] $openAPINullablesSetToNull
+ */
+ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
+ {
+ $this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
+ }
+
+ /**
+ * Checks if a property is nullable
+ */
+ public static function isNullable(string $property): bool
+ {
+ return self::openAPINullables()[$property] ?? false;
+ }
+
+ /**
+ * Checks if a nullable property is set to null.
+ */
+ public function isNullableSetToNull(string $property): bool
+ {
+ return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
+ }
+
+ /**
+ * Array of attributes where the key is the local name,
+ * and the value is the original name
+ *
+ * @var string[]
+ */
+ protected static $attributeMap = [
+ 'form_view' => 'form_view',
+ ];
+
+ /**
+ * Array of attributes to setter functions (for deserialization of responses)
+ *
+ * @var string[]
+ */
+ protected static $setters = [
+ 'form_view' => 'setFormView',
+ ];
+
+ /**
+ * Array of attributes to getter functions (for serialization of requests)
+ *
+ * @var string[]
+ */
+ protected static $getters = [
+ 'form_view' => 'getFormView',
+ ];
+
+ /**
+ * Array of attributes where the key is the local name,
+ * and the value is the original name
+ *
+ * @return array
+ */
+ public static function attributeMap()
+ {
+ return self::$attributeMap;
+ }
+
+ /**
+ * Array of attributes to setter functions (for deserialization of responses)
+ *
+ * @return array
+ */
+ public static function setters()
+ {
+ return self::$setters;
+ }
+
+ /**
+ * Array of attributes to getter functions (for serialization of requests)
+ *
+ * @return array
+ */
+ public static function getters()
+ {
+ return self::$getters;
+ }
+
+ /**
+ * The original name of the model.
+ *
+ * @return string
+ */
+ public function getModelName()
+ {
+ return self::$openAPIModelName;
+ }
+
+ public const FORM_VIEW_DISABLED = 'disabled';
+ public const FORM_VIEW_ENABLED = 'enabled';
+ public const FORM_VIEW_ENABLED_BY_DEFAULT = 'enabled_by_default';
+ public const FORM_VIEW_FORCED = 'forced';
+
+ /**
+ * Gets allowable values of the enum
+ *
+ * @return string[]
+ */
+ public function getFormViewAllowableValues()
+ {
+ return [
+ self::FORM_VIEW_DISABLED,
+ self::FORM_VIEW_ENABLED,
+ self::FORM_VIEW_ENABLED_BY_DEFAULT,
+ self::FORM_VIEW_FORCED,
+ ];
+ }
+
+ /**
+ * Associative array for storing property values
+ *
+ * @var mixed[]
+ */
+ protected $container = [];
+
+ /**
+ * Constructor
+ *
+ * @param mixed[]|null $data Associated array of property values
+ * initializing the model
+ */
+ public function __construct(?array $data = null)
+ {
+ $this->setIfExists('form_view', $data ?? [], null);
+ }
+
+ /**
+ * @deprecated use ::init()
+ */
+ public static function fromArray(array $data): SignatureRequestSignerExperience
+ {
+ return self::init($data);
+ }
+
+ /**
+ * Attempt to instantiate and hydrate a new instance of this class
+ */
+ public static function init(array $data): SignatureRequestSignerExperience
+ {
+ /** @var SignatureRequestSignerExperience */
+ return ObjectSerializer::deserialize(
+ $data,
+ SignatureRequestSignerExperience::class,
+ );
+ }
+
+ /**
+ * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
+ * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
+ * $this->openAPINullablesSetToNull array
+ *
+ * @param string|int|object|array|mixed $defaultValue
+ */
+ private function setIfExists(string $variableName, array $fields, $defaultValue): void
+ {
+ if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
+ $this->openAPINullablesSetToNull[] = $variableName;
+ }
+
+ $this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
+ }
+
+ /**
+ * Show all the invalid properties with reasons.
+ *
+ * @return array invalid properties with reasons
+ */
+ public function listInvalidProperties()
+ {
+ $invalidProperties = [];
+
+ if ($this->container['form_view'] === null) {
+ $invalidProperties[] = "'form_view' can't be null";
+ }
+ $allowedValues = $this->getFormViewAllowableValues();
+ if (!is_null($this->container['form_view']) && !in_array($this->container['form_view'], $allowedValues, true)) {
+ $invalidProperties[] = sprintf(
+ "invalid value '%s' for 'form_view', must be one of '%s'",
+ $this->container['form_view'],
+ implode("', '", $allowedValues)
+ );
+ }
+
+ return $invalidProperties;
+ }
+
+ /**
+ * Validate all the properties in the model
+ * return true if all passed
+ *
+ * @return bool True if all properties are valid
+ */
+ public function valid()
+ {
+ return count($this->listInvalidProperties()) === 0;
+ }
+
+ /**
+ * Gets form_view
+ *
+ * @return string
+ */
+ public function getFormView()
+ {
+ return $this->container['form_view'];
+ }
+
+ /**
+ * Sets form_view
+ *
+ * @param string $form_view Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden.
+ *
+ * @return self
+ */
+ public function setFormView(string $form_view)
+ {
+ if (is_null($form_view)) {
+ throw new InvalidArgumentException('non-nullable form_view cannot be null');
+ }
+ $allowedValues = $this->getFormViewAllowableValues();
+ if (!in_array($form_view, $allowedValues, true)) {
+ throw new InvalidArgumentException(
+ sprintf(
+ "Invalid value '%s' for 'form_view', must be one of '%s'",
+ $form_view,
+ implode("', '", $allowedValues)
+ )
+ );
+ }
+ $this->container['form_view'] = $form_view;
+
+ return $this;
+ }
+
+ /**
+ * Returns true if offset exists. False otherwise.
+ *
+ * @param int $offset Offset
+ */
+ #[ReturnTypeWillChange]
+ public function offsetExists($offset): bool
+ {
+ return isset($this->container[$offset]);
+ }
+
+ /**
+ * Gets offset.
+ *
+ * @param int $offset Offset
+ *
+ * @return mixed|null
+ */
+ #[ReturnTypeWillChange]
+ public function offsetGet($offset)
+ {
+ return $this->container[$offset] ?? null;
+ }
+
+ /**
+ * Sets value based on offset.
+ *
+ * @param int|null $offset Offset
+ * @param mixed $value Value to be set
+ */
+ #[ReturnTypeWillChange]
+ public function offsetSet($offset, $value): void
+ {
+ if (is_null($offset)) {
+ $this->container[] = $value;
+ } else {
+ $this->container[$offset] = $value;
+ }
+ }
+
+ /**
+ * Unsets offset.
+ *
+ * @param int $offset Offset
+ */
+ #[ReturnTypeWillChange]
+ public function offsetUnset($offset): void
+ {
+ unset($this->container[$offset]);
+ }
+
+ /**
+ * Serializes the object to a value that can be serialized natively by json_encode().
+ * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php
+ *
+ * @return mixed returns data which can be serialized by json_encode(), which is a value
+ * of any type other than a resource
+ */
+ #[ReturnTypeWillChange]
+ public function jsonSerialize()
+ {
+ return ObjectSerializer::sanitizeForSerialization($this);
+ }
+
+ /**
+ * Gets the string presentation of the object
+ *
+ * @return string
+ */
+ public function __toString()
+ {
+ return json_encode(
+ ObjectSerializer::sanitizeForSerialization($this),
+ JSON_UNESCAPED_SLASHES
+ );
+ }
+
+ /**
+ * Gets a header-safe presentation of the object
+ *
+ * @return string
+ */
+ public function toHeaderValue()
+ {
+ return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+ }
+}
diff --git a/src/Model/SubSignerExperience.php b/src/Model/SubSignerExperience.php
new file mode 100644
index 0000000..1d2ff65
--- /dev/null
+++ b/src/Model/SubSignerExperience.php
@@ -0,0 +1,453 @@
+
+ */
+class SubSignerExperience implements ModelInterface, ArrayAccess, JsonSerializable
+{
+ public const DISCRIMINATOR = null;
+
+ /**
+ * The original name of the model.
+ *
+ * @var string
+ */
+ protected static $openAPIModelName = 'SubSignerExperience';
+
+ /**
+ * Array of property to type mappings. Used for (de)serialization
+ *
+ * @var string[]
+ */
+ protected static $openAPITypes = [
+ 'form_view' => 'string',
+ ];
+
+ /**
+ * Array of property to format mappings. Used for (de)serialization
+ *
+ * @var string[]
+ * @phpstan-var array
+ * @psalm-var array
+ */
+ protected static $openAPIFormats = [
+ 'form_view' => null,
+ ];
+
+ /**
+ * Array of nullable properties. Used for (de)serialization
+ *
+ * @var bool[]
+ */
+ protected static array $openAPINullables = [
+ 'form_view' => false,
+ ];
+
+ /**
+ * If a nullable field gets set to null, insert it here
+ *
+ * @var bool[]
+ */
+ protected array $openAPINullablesSetToNull = [];
+
+ /**
+ * Array of property to type mappings. Used for (de)serialization
+ *
+ * @return array
+ */
+ public static function openAPITypes()
+ {
+ return self::$openAPITypes;
+ }
+
+ /**
+ * Array of property to format mappings. Used for (de)serialization
+ *
+ * @return array
+ */
+ public static function openAPIFormats()
+ {
+ return self::$openAPIFormats;
+ }
+
+ /**
+ * Array of nullable properties
+ */
+ protected static function openAPINullables(): array
+ {
+ return self::$openAPINullables;
+ }
+
+ /**
+ * Array of nullable field names deliberately set to null
+ *
+ * @return bool[]
+ */
+ private function getOpenAPINullablesSetToNull(): array
+ {
+ return $this->openAPINullablesSetToNull;
+ }
+
+ /**
+ * Setter - Array of nullable field names deliberately set to null
+ *
+ * @param bool[] $openAPINullablesSetToNull
+ */
+ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
+ {
+ $this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
+ }
+
+ /**
+ * Checks if a property is nullable
+ */
+ public static function isNullable(string $property): bool
+ {
+ return self::openAPINullables()[$property] ?? false;
+ }
+
+ /**
+ * Checks if a nullable property is set to null.
+ */
+ public function isNullableSetToNull(string $property): bool
+ {
+ return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
+ }
+
+ /**
+ * Array of attributes where the key is the local name,
+ * and the value is the original name
+ *
+ * @var string[]
+ */
+ protected static $attributeMap = [
+ 'form_view' => 'form_view',
+ ];
+
+ /**
+ * Array of attributes to setter functions (for deserialization of responses)
+ *
+ * @var string[]
+ */
+ protected static $setters = [
+ 'form_view' => 'setFormView',
+ ];
+
+ /**
+ * Array of attributes to getter functions (for serialization of requests)
+ *
+ * @var string[]
+ */
+ protected static $getters = [
+ 'form_view' => 'getFormView',
+ ];
+
+ /**
+ * Array of attributes where the key is the local name,
+ * and the value is the original name
+ *
+ * @return array
+ */
+ public static function attributeMap()
+ {
+ return self::$attributeMap;
+ }
+
+ /**
+ * Array of attributes to setter functions (for deserialization of responses)
+ *
+ * @return array
+ */
+ public static function setters()
+ {
+ return self::$setters;
+ }
+
+ /**
+ * Array of attributes to getter functions (for serialization of requests)
+ *
+ * @return array
+ */
+ public static function getters()
+ {
+ return self::$getters;
+ }
+
+ /**
+ * The original name of the model.
+ *
+ * @return string
+ */
+ public function getModelName()
+ {
+ return self::$openAPIModelName;
+ }
+
+ public const FORM_VIEW_DISABLED = 'disabled';
+ public const FORM_VIEW_ENABLED = 'enabled';
+ public const FORM_VIEW_ENABLED_BY_DEFAULT = 'enabled_by_default';
+ public const FORM_VIEW_FORCED = 'forced';
+
+ /**
+ * Gets allowable values of the enum
+ *
+ * @return string[]
+ */
+ public function getFormViewAllowableValues()
+ {
+ return [
+ self::FORM_VIEW_DISABLED,
+ self::FORM_VIEW_ENABLED,
+ self::FORM_VIEW_ENABLED_BY_DEFAULT,
+ self::FORM_VIEW_FORCED,
+ ];
+ }
+
+ /**
+ * Associative array for storing property values
+ *
+ * @var mixed[]
+ */
+ protected $container = [];
+
+ /**
+ * Constructor
+ *
+ * @param mixed[]|null $data Associated array of property values
+ * initializing the model
+ */
+ public function __construct(?array $data = null)
+ {
+ $this->setIfExists('form_view', $data ?? [], null);
+ }
+
+ /**
+ * @deprecated use ::init()
+ */
+ public static function fromArray(array $data): SubSignerExperience
+ {
+ return self::init($data);
+ }
+
+ /**
+ * Attempt to instantiate and hydrate a new instance of this class
+ */
+ public static function init(array $data): SubSignerExperience
+ {
+ /** @var SubSignerExperience */
+ return ObjectSerializer::deserialize(
+ $data,
+ SubSignerExperience::class,
+ );
+ }
+
+ /**
+ * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
+ * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
+ * $this->openAPINullablesSetToNull array
+ *
+ * @param string|int|object|array|mixed $defaultValue
+ */
+ private function setIfExists(string $variableName, array $fields, $defaultValue): void
+ {
+ if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
+ $this->openAPINullablesSetToNull[] = $variableName;
+ }
+
+ $this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
+ }
+
+ /**
+ * Show all the invalid properties with reasons.
+ *
+ * @return array invalid properties with reasons
+ */
+ public function listInvalidProperties()
+ {
+ $invalidProperties = [];
+
+ $allowedValues = $this->getFormViewAllowableValues();
+ if (!is_null($this->container['form_view']) && !in_array($this->container['form_view'], $allowedValues, true)) {
+ $invalidProperties[] = sprintf(
+ "invalid value '%s' for 'form_view', must be one of '%s'",
+ $this->container['form_view'],
+ implode("', '", $allowedValues)
+ );
+ }
+
+ return $invalidProperties;
+ }
+
+ /**
+ * Validate all the properties in the model
+ * return true if all passed
+ *
+ * @return bool True if all properties are valid
+ */
+ public function valid()
+ {
+ return count($this->listInvalidProperties()) === 0;
+ }
+
+ /**
+ * Gets form_view
+ *
+ * @return string|null
+ */
+ public function getFormView()
+ {
+ return $this->container['form_view'];
+ }
+
+ /**
+ * Sets form_view
+ *
+ * @param string|null $form_view Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden.
+ *
+ * @return self
+ */
+ public function setFormView(?string $form_view)
+ {
+ if (is_null($form_view)) {
+ throw new InvalidArgumentException('non-nullable form_view cannot be null');
+ }
+ $allowedValues = $this->getFormViewAllowableValues();
+ if (!in_array($form_view, $allowedValues, true)) {
+ throw new InvalidArgumentException(
+ sprintf(
+ "Invalid value '%s' for 'form_view', must be one of '%s'",
+ $form_view,
+ implode("', '", $allowedValues)
+ )
+ );
+ }
+ $this->container['form_view'] = $form_view;
+
+ return $this;
+ }
+
+ /**
+ * Returns true if offset exists. False otherwise.
+ *
+ * @param int $offset Offset
+ */
+ #[ReturnTypeWillChange]
+ public function offsetExists($offset): bool
+ {
+ return isset($this->container[$offset]);
+ }
+
+ /**
+ * Gets offset.
+ *
+ * @param int $offset Offset
+ *
+ * @return mixed|null
+ */
+ #[ReturnTypeWillChange]
+ public function offsetGet($offset)
+ {
+ return $this->container[$offset] ?? null;
+ }
+
+ /**
+ * Sets value based on offset.
+ *
+ * @param int|null $offset Offset
+ * @param mixed $value Value to be set
+ */
+ #[ReturnTypeWillChange]
+ public function offsetSet($offset, $value): void
+ {
+ if (is_null($offset)) {
+ $this->container[] = $value;
+ } else {
+ $this->container[$offset] = $value;
+ }
+ }
+
+ /**
+ * Unsets offset.
+ *
+ * @param int $offset Offset
+ */
+ #[ReturnTypeWillChange]
+ public function offsetUnset($offset): void
+ {
+ unset($this->container[$offset]);
+ }
+
+ /**
+ * Serializes the object to a value that can be serialized natively by json_encode().
+ * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php
+ *
+ * @return mixed returns data which can be serialized by json_encode(), which is a value
+ * of any type other than a resource
+ */
+ #[ReturnTypeWillChange]
+ public function jsonSerialize()
+ {
+ return ObjectSerializer::sanitizeForSerialization($this);
+ }
+
+ /**
+ * Gets the string presentation of the object
+ *
+ * @return string
+ */
+ public function __toString()
+ {
+ return json_encode(
+ ObjectSerializer::sanitizeForSerialization($this),
+ JSON_UNESCAPED_SLASHES
+ );
+ }
+
+ /**
+ * Gets a header-safe presentation of the object
+ *
+ * @return string
+ */
+ public function toHeaderValue()
+ {
+ return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+ }
+}
diff --git a/src/Model/SubSigningOptions.php b/src/Model/SubSigningOptions.php
index 51185a7..445065b 100644
--- a/src/Model/SubSigningOptions.php
+++ b/src/Model/SubSigningOptions.php
@@ -37,7 +37,7 @@
* SubSigningOptions Class Doc Comment
*
* @category Class
- * @description This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
+ * @description This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.
* @see https://openapi-generator.tech
* @implements ArrayAccess
*/
@@ -63,6 +63,7 @@ class SubSigningOptions implements ModelInterface, ArrayAccess, JsonSerializable
'phone' => 'bool',
'type' => 'bool',
'upload' => 'bool',
+ 'force_advanced_signature_details' => 'bool',
];
/**
@@ -78,6 +79,7 @@ class SubSigningOptions implements ModelInterface, ArrayAccess, JsonSerializable
'phone' => null,
'type' => null,
'upload' => null,
+ 'force_advanced_signature_details' => null,
];
/**
@@ -91,6 +93,7 @@ class SubSigningOptions implements ModelInterface, ArrayAccess, JsonSerializable
'phone' => false,
'type' => false,
'upload' => false,
+ 'force_advanced_signature_details' => false,
];
/**
@@ -176,6 +179,7 @@ public function isNullableSetToNull(string $property): bool
'phone' => 'phone',
'type' => 'type',
'upload' => 'upload',
+ 'force_advanced_signature_details' => 'force_advanced_signature_details',
];
/**
@@ -189,6 +193,7 @@ public function isNullableSetToNull(string $property): bool
'phone' => 'setPhone',
'type' => 'setType',
'upload' => 'setUpload',
+ 'force_advanced_signature_details' => 'setForceAdvancedSignatureDetails',
];
/**
@@ -202,6 +207,7 @@ public function isNullableSetToNull(string $property): bool
'phone' => 'getPhone',
'type' => 'getType',
'upload' => 'getUpload',
+ 'force_advanced_signature_details' => 'getForceAdvancedSignatureDetails',
];
/**
@@ -285,6 +291,7 @@ public function __construct(?array $data = null)
$this->setIfExists('phone', $data ?? [], false);
$this->setIfExists('type', $data ?? [], false);
$this->setIfExists('upload', $data ?? [], false);
+ $this->setIfExists('force_advanced_signature_details', $data ?? [], false);
}
/**
@@ -503,6 +510,33 @@ public function setUpload(?bool $upload)
return $this;
}
+ /**
+ * Gets force_advanced_signature_details
+ *
+ * @return bool|null
+ */
+ public function getForceAdvancedSignatureDetails()
+ {
+ return $this->container['force_advanced_signature_details'];
+ }
+
+ /**
+ * Sets force_advanced_signature_details
+ *
+ * @param bool|null $force_advanced_signature_details Turning on advanced signature details for the signature request
+ *
+ * @return self
+ */
+ public function setForceAdvancedSignatureDetails(?bool $force_advanced_signature_details)
+ {
+ if (is_null($force_advanced_signature_details)) {
+ throw new InvalidArgumentException('non-nullable force_advanced_signature_details cannot be null');
+ }
+ $this->container['force_advanced_signature_details'] = $force_advanced_signature_details;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/TemplateEditResponse.php b/src/Model/SubUpdateFormField.php
similarity index 80%
rename from src/Model/TemplateEditResponse.php
rename to src/Model/SubUpdateFormField.php
index 6250245..9dcbeee 100644
--- a/src/Model/TemplateEditResponse.php
+++ b/src/Model/SubUpdateFormField.php
@@ -1,6 +1,6 @@
*/
-class TemplateEditResponse implements ModelInterface, ArrayAccess, JsonSerializable
+class SubUpdateFormField implements ModelInterface, ArrayAccess, JsonSerializable
{
public const DISCRIMINATOR = null;
@@ -49,7 +49,7 @@ class TemplateEditResponse implements ModelInterface, ArrayAccess, JsonSerializa
*
* @var string
*/
- protected static $openAPIModelName = 'TemplateEditResponse';
+ protected static $openAPIModelName = 'SubUpdateFormField';
/**
* Array of property to type mappings. Used for (de)serialization
@@ -57,7 +57,8 @@ class TemplateEditResponse implements ModelInterface, ArrayAccess, JsonSerializa
* @var string[]
*/
protected static $openAPITypes = [
- 'template_id' => 'string',
+ 'api_id' => 'string',
+ 'name' => 'string',
];
/**
@@ -68,7 +69,8 @@ class TemplateEditResponse implements ModelInterface, ArrayAccess, JsonSerializa
* @psalm-var array
*/
protected static $openAPIFormats = [
- 'template_id' => null,
+ 'api_id' => null,
+ 'name' => null,
];
/**
@@ -77,7 +79,8 @@ class TemplateEditResponse implements ModelInterface, ArrayAccess, JsonSerializa
* @var bool[]
*/
protected static array $openAPINullables = [
- 'template_id' => false,
+ 'api_id' => false,
+ 'name' => false,
];
/**
@@ -158,7 +161,8 @@ public function isNullableSetToNull(string $property): bool
* @var string[]
*/
protected static $attributeMap = [
- 'template_id' => 'template_id',
+ 'api_id' => 'api_id',
+ 'name' => 'name',
];
/**
@@ -167,7 +171,8 @@ public function isNullableSetToNull(string $property): bool
* @var string[]
*/
protected static $setters = [
- 'template_id' => 'setTemplateId',
+ 'api_id' => 'setApiId',
+ 'name' => 'setName',
];
/**
@@ -176,7 +181,8 @@ public function isNullableSetToNull(string $property): bool
* @var string[]
*/
protected static $getters = [
- 'template_id' => 'getTemplateId',
+ 'api_id' => 'getApiId',
+ 'name' => 'getName',
];
/**
@@ -235,13 +241,14 @@ public function getModelName()
*/
public function __construct(?array $data = null)
{
- $this->setIfExists('template_id', $data ?? [], null);
+ $this->setIfExists('api_id', $data ?? [], null);
+ $this->setIfExists('name', $data ?? [], null);
}
/**
* @deprecated use ::init()
*/
- public static function fromArray(array $data): TemplateEditResponse
+ public static function fromArray(array $data): SubUpdateFormField
{
return self::init($data);
}
@@ -249,12 +256,12 @@ public static function fromArray(array $data): TemplateEditResponse
/**
* Attempt to instantiate and hydrate a new instance of this class
*/
- public static function init(array $data): TemplateEditResponse
+ public static function init(array $data): SubUpdateFormField
{
- /** @var TemplateEditResponse */
+ /** @var SubUpdateFormField */
return ObjectSerializer::deserialize(
$data,
- TemplateEditResponse::class,
+ SubUpdateFormField::class,
);
}
@@ -283,8 +290,8 @@ public function listInvalidProperties()
{
$invalidProperties = [];
- if ($this->container['template_id'] === null) {
- $invalidProperties[] = "'template_id' can't be null";
+ if ($this->container['api_id'] === null) {
+ $invalidProperties[] = "'api_id' can't be null";
}
return $invalidProperties;
}
@@ -301,28 +308,55 @@ public function valid()
}
/**
- * Gets template_id
+ * Gets api_id
*
* @return string
*/
- public function getTemplateId()
+ public function getApiId()
{
- return $this->container['template_id'];
+ return $this->container['api_id'];
}
/**
- * Sets template_id
+ * Sets api_id
*
- * @param string $template_id the id of the Template
+ * @param string $api_id The unique ID for this field. The endpoint will update an existing field with matching `api_id`, and warn you if no matches are found
*
* @return self
*/
- public function setTemplateId(string $template_id)
+ public function setApiId(string $api_id)
{
- if (is_null($template_id)) {
- throw new InvalidArgumentException('non-nullable template_id cannot be null');
+ if (is_null($api_id)) {
+ throw new InvalidArgumentException('non-nullable api_id cannot be null');
}
- $this->container['template_id'] = $template_id;
+ $this->container['api_id'] = $api_id;
+
+ return $this;
+ }
+
+ /**
+ * Gets name
+ *
+ * @return string|null
+ */
+ public function getName()
+ {
+ return $this->container['name'];
+ }
+
+ /**
+ * Sets name
+ *
+ * @param string|null $name The new name of the field. If not passed the name will remain unchanged.
+ *
+ * @return self
+ */
+ public function setName(?string $name)
+ {
+ if (is_null($name)) {
+ throw new InvalidArgumentException('non-nullable name cannot be null');
+ }
+ $this->container['name'] = $name;
return $this;
}
diff --git a/src/Model/TemplateCreateEmbeddedDraftRequest.php b/src/Model/TemplateCreateEmbeddedDraftRequest.php
index 9d151a1..5f72a8a 100644
--- a/src/Model/TemplateCreateEmbeddedDraftRequest.php
+++ b/src/Model/TemplateCreateEmbeddedDraftRequest.php
@@ -83,6 +83,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess,
'test_mode' => 'bool',
'title' => 'string',
'use_preexisting_fields' => 'bool',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -118,6 +119,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess,
'test_mode' => null,
'title' => null,
'use_preexisting_fields' => null,
+ 'signer_experience' => null,
];
/**
@@ -151,6 +153,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess,
'test_mode' => false,
'title' => false,
'use_preexisting_fields' => false,
+ 'signer_experience' => false,
];
/**
@@ -256,6 +259,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'test_mode',
'title' => 'title',
'use_preexisting_fields' => 'use_preexisting_fields',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -289,6 +293,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'setTestMode',
'title' => 'setTitle',
'use_preexisting_fields' => 'setUsePreexistingFields',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -322,6 +327,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'getTestMode',
'title' => 'getTitle',
'use_preexisting_fields' => 'getUsePreexistingFields',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -405,6 +411,7 @@ public function __construct(?array $data = null)
$this->setIfExists('test_mode', $data ?? [], false);
$this->setIfExists('title', $data ?? [], null);
$this->setIfExists('use_preexisting_fields', $data ?? [], false);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -1161,6 +1168,33 @@ public function setUsePreexistingFields(?bool $use_preexisting_fields)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/TemplateCreateRequest.php b/src/Model/TemplateCreateRequest.php
index 87e69a2..7e590ec 100644
--- a/src/Model/TemplateCreateRequest.php
+++ b/src/Model/TemplateCreateRequest.php
@@ -76,6 +76,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ
'test_mode' => 'bool',
'title' => 'string',
'use_preexisting_fields' => 'bool',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -104,6 +105,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ
'test_mode' => null,
'title' => null,
'use_preexisting_fields' => null,
+ 'signer_experience' => null,
];
/**
@@ -130,6 +132,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ
'test_mode' => false,
'title' => false,
'use_preexisting_fields' => false,
+ 'signer_experience' => false,
];
/**
@@ -228,6 +231,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'test_mode',
'title' => 'title',
'use_preexisting_fields' => 'use_preexisting_fields',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -254,6 +258,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'setTestMode',
'title' => 'setTitle',
'use_preexisting_fields' => 'setUsePreexistingFields',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -280,6 +285,7 @@ public function isNullableSetToNull(string $property): bool
'test_mode' => 'getTestMode',
'title' => 'getTitle',
'use_preexisting_fields' => 'getUsePreexistingFields',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -356,6 +362,7 @@ public function __construct(?array $data = null)
$this->setIfExists('test_mode', $data ?? [], false);
$this->setIfExists('title', $data ?? [], null);
$this->setIfExists('use_preexisting_fields', $data ?? [], false);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -926,6 +933,33 @@ public function setUsePreexistingFields(?bool $use_preexisting_fields)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/TemplateResponse.php b/src/Model/TemplateResponse.php
index 3eac210..a987f66 100644
--- a/src/Model/TemplateResponse.php
+++ b/src/Model/TemplateResponse.php
@@ -74,6 +74,7 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable
'named_form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]',
'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]',
'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]',
+ 'signer_experience' => '\Dropbox\Sign\Model\SignatureRequestSignerExperience',
];
/**
@@ -100,6 +101,7 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable
'named_form_fields' => null,
'accounts' => null,
'attachments' => null,
+ 'signer_experience' => null,
];
/**
@@ -124,6 +126,7 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable
'named_form_fields' => true,
'accounts' => false,
'attachments' => false,
+ 'signer_experience' => false,
];
/**
@@ -220,6 +223,7 @@ public function isNullableSetToNull(string $property): bool
'named_form_fields' => 'named_form_fields',
'accounts' => 'accounts',
'attachments' => 'attachments',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -244,6 +248,7 @@ public function isNullableSetToNull(string $property): bool
'named_form_fields' => 'setNamedFormFields',
'accounts' => 'setAccounts',
'attachments' => 'setAttachments',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -268,6 +273,7 @@ public function isNullableSetToNull(string $property): bool
'named_form_fields' => 'getNamedFormFields',
'accounts' => 'getAccounts',
'attachments' => 'getAttachments',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -342,6 +348,7 @@ public function __construct(?array $data = null)
$this->setIfExists('named_form_fields', $data ?? [], null);
$this->setIfExists('accounts', $data ?? [], null);
$this->setIfExists('attachments', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -858,6 +865,33 @@ public function setAttachments(?array $attachments)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SignatureRequestSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SignatureRequestSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SignatureRequestSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/src/Model/TemplateUpdateRequest.php b/src/Model/TemplateUpdateRequest.php
new file mode 100644
index 0000000..d2e6eb0
--- /dev/null
+++ b/src/Model/TemplateUpdateRequest.php
@@ -0,0 +1,599 @@
+
+ */
+class TemplateUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializable
+{
+ public const DISCRIMINATOR = null;
+
+ /**
+ * The original name of the model.
+ *
+ * @var string
+ */
+ protected static $openAPIModelName = 'TemplateUpdateRequest';
+
+ /**
+ * Array of property to type mappings. Used for (de)serialization
+ *
+ * @var string[]
+ */
+ protected static $openAPITypes = [
+ 'cc_roles' => 'string[]',
+ 'title' => 'string',
+ 'subject' => 'string',
+ 'message' => 'string',
+ 'form_fields' => '\Dropbox\Sign\Model\SubUpdateFormField[]',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
+ ];
+
+ /**
+ * Array of property to format mappings. Used for (de)serialization
+ *
+ * @var string[]
+ * @phpstan-var array
+ * @psalm-var array
+ */
+ protected static $openAPIFormats = [
+ 'cc_roles' => null,
+ 'title' => null,
+ 'subject' => null,
+ 'message' => null,
+ 'form_fields' => null,
+ 'signer_experience' => null,
+ ];
+
+ /**
+ * Array of nullable properties. Used for (de)serialization
+ *
+ * @var bool[]
+ */
+ protected static array $openAPINullables = [
+ 'cc_roles' => false,
+ 'title' => false,
+ 'subject' => false,
+ 'message' => false,
+ 'form_fields' => false,
+ 'signer_experience' => false,
+ ];
+
+ /**
+ * If a nullable field gets set to null, insert it here
+ *
+ * @var bool[]
+ */
+ protected array $openAPINullablesSetToNull = [];
+
+ /**
+ * Array of property to type mappings. Used for (de)serialization
+ *
+ * @return array
+ */
+ public static function openAPITypes()
+ {
+ return self::$openAPITypes;
+ }
+
+ /**
+ * Array of property to format mappings. Used for (de)serialization
+ *
+ * @return array
+ */
+ public static function openAPIFormats()
+ {
+ return self::$openAPIFormats;
+ }
+
+ /**
+ * Array of nullable properties
+ */
+ protected static function openAPINullables(): array
+ {
+ return self::$openAPINullables;
+ }
+
+ /**
+ * Array of nullable field names deliberately set to null
+ *
+ * @return bool[]
+ */
+ private function getOpenAPINullablesSetToNull(): array
+ {
+ return $this->openAPINullablesSetToNull;
+ }
+
+ /**
+ * Setter - Array of nullable field names deliberately set to null
+ *
+ * @param bool[] $openAPINullablesSetToNull
+ */
+ private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void
+ {
+ $this->openAPINullablesSetToNull = $openAPINullablesSetToNull;
+ }
+
+ /**
+ * Checks if a property is nullable
+ */
+ public static function isNullable(string $property): bool
+ {
+ return self::openAPINullables()[$property] ?? false;
+ }
+
+ /**
+ * Checks if a nullable property is set to null.
+ */
+ public function isNullableSetToNull(string $property): bool
+ {
+ return in_array($property, $this->getOpenAPINullablesSetToNull(), true);
+ }
+
+ /**
+ * Array of attributes where the key is the local name,
+ * and the value is the original name
+ *
+ * @var string[]
+ */
+ protected static $attributeMap = [
+ 'cc_roles' => 'cc_roles',
+ 'title' => 'title',
+ 'subject' => 'subject',
+ 'message' => 'message',
+ 'form_fields' => 'form_fields',
+ 'signer_experience' => 'signer_experience',
+ ];
+
+ /**
+ * Array of attributes to setter functions (for deserialization of responses)
+ *
+ * @var string[]
+ */
+ protected static $setters = [
+ 'cc_roles' => 'setCcRoles',
+ 'title' => 'setTitle',
+ 'subject' => 'setSubject',
+ 'message' => 'setMessage',
+ 'form_fields' => 'setFormFields',
+ 'signer_experience' => 'setSignerExperience',
+ ];
+
+ /**
+ * Array of attributes to getter functions (for serialization of requests)
+ *
+ * @var string[]
+ */
+ protected static $getters = [
+ 'cc_roles' => 'getCcRoles',
+ 'title' => 'getTitle',
+ 'subject' => 'getSubject',
+ 'message' => 'getMessage',
+ 'form_fields' => 'getFormFields',
+ 'signer_experience' => 'getSignerExperience',
+ ];
+
+ /**
+ * Array of attributes where the key is the local name,
+ * and the value is the original name
+ *
+ * @return array
+ */
+ public static function attributeMap()
+ {
+ return self::$attributeMap;
+ }
+
+ /**
+ * Array of attributes to setter functions (for deserialization of responses)
+ *
+ * @return array
+ */
+ public static function setters()
+ {
+ return self::$setters;
+ }
+
+ /**
+ * Array of attributes to getter functions (for serialization of requests)
+ *
+ * @return array
+ */
+ public static function getters()
+ {
+ return self::$getters;
+ }
+
+ /**
+ * The original name of the model.
+ *
+ * @return string
+ */
+ public function getModelName()
+ {
+ return self::$openAPIModelName;
+ }
+
+ /**
+ * Associative array for storing property values
+ *
+ * @var mixed[]
+ */
+ protected $container = [];
+
+ /**
+ * Constructor
+ *
+ * @param mixed[]|null $data Associated array of property values
+ * initializing the model
+ */
+ public function __construct(?array $data = null)
+ {
+ $this->setIfExists('cc_roles', $data ?? [], null);
+ $this->setIfExists('title', $data ?? [], null);
+ $this->setIfExists('subject', $data ?? [], null);
+ $this->setIfExists('message', $data ?? [], null);
+ $this->setIfExists('form_fields', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
+ }
+
+ /**
+ * @deprecated use ::init()
+ */
+ public static function fromArray(array $data): TemplateUpdateRequest
+ {
+ return self::init($data);
+ }
+
+ /**
+ * Attempt to instantiate and hydrate a new instance of this class
+ */
+ public static function init(array $data): TemplateUpdateRequest
+ {
+ /** @var TemplateUpdateRequest */
+ return ObjectSerializer::deserialize(
+ $data,
+ TemplateUpdateRequest::class,
+ );
+ }
+
+ /**
+ * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName
+ * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the
+ * $this->openAPINullablesSetToNull array
+ *
+ * @param string|int|object|array|mixed $defaultValue
+ */
+ private function setIfExists(string $variableName, array $fields, $defaultValue): void
+ {
+ if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) {
+ $this->openAPINullablesSetToNull[] = $variableName;
+ }
+
+ $this->container[$variableName] = $fields[$variableName] ?? $defaultValue;
+ }
+
+ /**
+ * Show all the invalid properties with reasons.
+ *
+ * @return array invalid properties with reasons
+ */
+ public function listInvalidProperties()
+ {
+ $invalidProperties = [];
+
+ if (!is_null($this->container['subject']) && (mb_strlen($this->container['subject']) > 200)) {
+ $invalidProperties[] = "invalid value for 'subject', the character length must be smaller than or equal to 200.";
+ }
+
+ if (!is_null($this->container['message']) && (mb_strlen($this->container['message']) > 5000)) {
+ $invalidProperties[] = "invalid value for 'message', the character length must be smaller than or equal to 5000.";
+ }
+
+ return $invalidProperties;
+ }
+
+ /**
+ * Validate all the properties in the model
+ * return true if all passed
+ *
+ * @return bool True if all properties are valid
+ */
+ public function valid()
+ {
+ return count($this->listInvalidProperties()) === 0;
+ }
+
+ /**
+ * Gets cc_roles
+ *
+ * @return string[]|null
+ */
+ public function getCcRoles()
+ {
+ return $this->container['cc_roles'];
+ }
+
+ /**
+ * Sets cc_roles
+ *
+ * @param string[]|null $cc_roles the CC roles that must be assigned when using the template to send a signature request
+ *
+ * @return self
+ */
+ public function setCcRoles(?array $cc_roles)
+ {
+ if (is_null($cc_roles)) {
+ throw new InvalidArgumentException('non-nullable cc_roles cannot be null');
+ }
+ $this->container['cc_roles'] = $cc_roles;
+
+ return $this;
+ }
+
+ /**
+ * Gets title
+ *
+ * @return string|null
+ */
+ public function getTitle()
+ {
+ return $this->container['title'];
+ }
+
+ /**
+ * Sets title
+ *
+ * @param string|null $title the title you want to assign to the SignatureRequest
+ *
+ * @return self
+ */
+ public function setTitle(?string $title)
+ {
+ if (is_null($title)) {
+ throw new InvalidArgumentException('non-nullable title cannot be null');
+ }
+ $this->container['title'] = $title;
+
+ return $this;
+ }
+
+ /**
+ * Gets subject
+ *
+ * @return string|null
+ */
+ public function getSubject()
+ {
+ return $this->container['subject'];
+ }
+
+ /**
+ * Sets subject
+ *
+ * @param string|null $subject the new default template email subject
+ *
+ * @return self
+ */
+ public function setSubject(?string $subject)
+ {
+ if (is_null($subject)) {
+ throw new InvalidArgumentException('non-nullable subject cannot be null');
+ }
+ if (mb_strlen($subject) > 200) {
+ throw new InvalidArgumentException('invalid length for $subject when calling TemplateUpdateRequest., must be smaller than or equal to 200.');
+ }
+
+ $this->container['subject'] = $subject;
+
+ return $this;
+ }
+
+ /**
+ * Gets message
+ *
+ * @return string|null
+ */
+ public function getMessage()
+ {
+ return $this->container['message'];
+ }
+
+ /**
+ * Sets message
+ *
+ * @param string|null $message the new default template email message
+ *
+ * @return self
+ */
+ public function setMessage(?string $message)
+ {
+ if (is_null($message)) {
+ throw new InvalidArgumentException('non-nullable message cannot be null');
+ }
+ if (mb_strlen($message) > 5000) {
+ throw new InvalidArgumentException('invalid length for $message when calling TemplateUpdateRequest., must be smaller than or equal to 5000.');
+ }
+
+ $this->container['message'] = $message;
+
+ return $this;
+ }
+
+ /**
+ * Gets form_fields
+ *
+ * @return SubUpdateFormField[]|null
+ */
+ public function getFormFields()
+ {
+ return $this->container['form_fields'];
+ }
+
+ /**
+ * Sets form_fields
+ *
+ * @param SubUpdateFormField[]|null $form_fields A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.
+ *
+ * @return self
+ */
+ public function setFormFields(?array $form_fields)
+ {
+ if (is_null($form_fields)) {
+ throw new InvalidArgumentException('non-nullable form_fields cannot be null');
+ }
+ $this->container['form_fields'] = $form_fields;
+
+ return $this;
+ }
+
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
+ /**
+ * Returns true if offset exists. False otherwise.
+ *
+ * @param int $offset Offset
+ */
+ #[ReturnTypeWillChange]
+ public function offsetExists($offset): bool
+ {
+ return isset($this->container[$offset]);
+ }
+
+ /**
+ * Gets offset.
+ *
+ * @param int $offset Offset
+ *
+ * @return mixed|null
+ */
+ #[ReturnTypeWillChange]
+ public function offsetGet($offset)
+ {
+ return $this->container[$offset] ?? null;
+ }
+
+ /**
+ * Sets value based on offset.
+ *
+ * @param int|null $offset Offset
+ * @param mixed $value Value to be set
+ */
+ #[ReturnTypeWillChange]
+ public function offsetSet($offset, $value): void
+ {
+ if (is_null($offset)) {
+ $this->container[] = $value;
+ } else {
+ $this->container[$offset] = $value;
+ }
+ }
+
+ /**
+ * Unsets offset.
+ *
+ * @param int $offset Offset
+ */
+ #[ReturnTypeWillChange]
+ public function offsetUnset($offset): void
+ {
+ unset($this->container[$offset]);
+ }
+
+ /**
+ * Serializes the object to a value that can be serialized natively by json_encode().
+ * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php
+ *
+ * @return mixed returns data which can be serialized by json_encode(), which is a value
+ * of any type other than a resource
+ */
+ #[ReturnTypeWillChange]
+ public function jsonSerialize()
+ {
+ return ObjectSerializer::sanitizeForSerialization($this);
+ }
+
+ /**
+ * Gets the string presentation of the object
+ *
+ * @return string
+ */
+ public function __toString()
+ {
+ return json_encode(
+ ObjectSerializer::sanitizeForSerialization($this),
+ JSON_UNESCAPED_SLASHES
+ );
+ }
+
+ /**
+ * Gets a header-safe presentation of the object
+ *
+ * @return string
+ */
+ public function toHeaderValue()
+ {
+ return json_encode(ObjectSerializer::sanitizeForSerialization($this));
+ }
+}
diff --git a/src/Model/UnclaimedDraftCreateRequest.php b/src/Model/UnclaimedDraftCreateRequest.php
index ed00604..fc2bf59 100644
--- a/src/Model/UnclaimedDraftCreateRequest.php
+++ b/src/Model/UnclaimedDraftCreateRequest.php
@@ -83,6 +83,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe
'use_preexisting_fields' => 'bool',
'use_text_tags' => 'bool',
'expires_at' => 'int',
+ 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience',
];
/**
@@ -117,6 +118,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe
'use_preexisting_fields' => null,
'use_text_tags' => null,
'expires_at' => null,
+ 'signer_experience' => null,
];
/**
@@ -149,6 +151,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe
'use_preexisting_fields' => false,
'use_text_tags' => false,
'expires_at' => true,
+ 'signer_experience' => false,
];
/**
@@ -253,6 +256,7 @@ public function isNullableSetToNull(string $property): bool
'use_preexisting_fields' => 'use_preexisting_fields',
'use_text_tags' => 'use_text_tags',
'expires_at' => 'expires_at',
+ 'signer_experience' => 'signer_experience',
];
/**
@@ -285,6 +289,7 @@ public function isNullableSetToNull(string $property): bool
'use_preexisting_fields' => 'setUsePreexistingFields',
'use_text_tags' => 'setUseTextTags',
'expires_at' => 'setExpiresAt',
+ 'signer_experience' => 'setSignerExperience',
];
/**
@@ -317,6 +322,7 @@ public function isNullableSetToNull(string $property): bool
'use_preexisting_fields' => 'getUsePreexistingFields',
'use_text_tags' => 'getUseTextTags',
'expires_at' => 'getExpiresAt',
+ 'signer_experience' => 'getSignerExperience',
];
/**
@@ -415,6 +421,7 @@ public function __construct(?array $data = null)
$this->setIfExists('use_preexisting_fields', $data ?? [], false);
$this->setIfExists('use_text_tags', $data ?? [], false);
$this->setIfExists('expires_at', $data ?? [], null);
+ $this->setIfExists('signer_experience', $data ?? [], null);
}
/**
@@ -1170,6 +1177,33 @@ public function setExpiresAt(?int $expires_at)
return $this;
}
+ /**
+ * Gets signer_experience
+ *
+ * @return SubSignerExperience|null
+ */
+ public function getSignerExperience()
+ {
+ return $this->container['signer_experience'];
+ }
+
+ /**
+ * Sets signer_experience
+ *
+ * @param SubSignerExperience|null $signer_experience signer_experience
+ *
+ * @return self
+ */
+ public function setSignerExperience(?SubSignerExperience $signer_experience)
+ {
+ if (is_null($signer_experience)) {
+ throw new InvalidArgumentException('non-nullable signer_experience cannot be null');
+ }
+ $this->container['signer_experience'] = $signer_experience;
+
+ return $this;
+ }
+
/**
* Returns true if offset exists. False otherwise.
*
diff --git a/templates/composer.mustache b/templates/composer.mustache
index 85807e0..2efd505 100644
--- a/templates/composer.mustache
+++ b/templates/composer.mustache
@@ -52,7 +52,7 @@
"friendsofphp/php-cs-fixer": "^3.5"
{{/useCustomTemplateCode}}
{{#useCustomTemplateCode}}
- "friendsofphp/php-cs-fixer": "^3.5",
+ "friendsofphp/php-cs-fixer": "v3.84.0",
"symfony/yaml": "^5.4"
{{/useCustomTemplateCode}}
},
diff --git a/test_fixtures/EmbeddedEditUrlRequest.json b/test_fixtures/EmbeddedEditUrlRequest.json
index 9d3d766..238279f 100644
--- a/test_fixtures/EmbeddedEditUrlRequest.json
+++ b/test_fixtures/EmbeddedEditUrlRequest.json
@@ -1,6 +1,9 @@
{
"default": {
"allow_edit_ccs": true,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"cc_roles": [
""
],
diff --git a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json
index 16e8037..37bc79c 100644
--- a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json
+++ b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json
@@ -1,6 +1,9 @@
{
"default": {
"allow_decline": true,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"allow_reassign": true,
"attachments": [
{
@@ -116,7 +119,8 @@
"type": true,
"upload": true,
"phone": false,
- "default_type": "draw"
+ "default_type": "draw",
+ "force_advanced_signature_details": false
},
"subject": "The NDA we talked about",
"test_mode": true,
@@ -125,6 +129,9 @@
},
"with_grouped_signers": {
"allow_decline": true,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"allow_reassign": true,
"attachments": [
{
@@ -252,7 +259,8 @@
"type": true,
"upload": true,
"phone": false,
- "default_type": "draw"
+ "default_type": "draw",
+ "force_advanced_signature_details": false
},
"subject": "The NDA we talked about",
"test_mode": true,
diff --git a/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json
index a9597ea..f997b28 100644
--- a/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json
+++ b/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json
@@ -54,7 +54,8 @@
"type": true,
"upload": true,
"phone": false,
- "default_type": "draw"
+ "default_type": "draw",
+ "force_advanced_signature_details": false
},
"subject": "Purchase Order",
"template_ids": [
diff --git a/test_fixtures/SignatureRequestGetResponse.json b/test_fixtures/SignatureRequestGetResponse.json
index f0fda3c..8232860 100644
--- a/test_fixtures/SignatureRequestGetResponse.json
+++ b/test_fixtures/SignatureRequestGetResponse.json
@@ -150,6 +150,9 @@
"lawyer@dropboxsign.com",
"lawyer@example.com"
],
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"test_mode": false
}
}
diff --git a/test_fixtures/SignatureRequestSendRequest.json b/test_fixtures/SignatureRequestSendRequest.json
index 98d12db..f0d7b9d 100644
--- a/test_fixtures/SignatureRequestSendRequest.json
+++ b/test_fixtures/SignatureRequestSendRequest.json
@@ -1,6 +1,9 @@
{
"default": {
"allow_decline": true,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"allow_reassign": true,
"attachments": [
{
@@ -229,7 +232,8 @@
"type": true,
"upload": true,
"phone": false,
- "default_type": "draw"
+ "default_type": "draw",
+ "force_advanced_signature_details": false
},
"signing_redirect_url": "https://example.com/redirect",
"subject": "The NDA we talked about",
@@ -239,6 +243,9 @@
},
"with_grouped_signers": {
"allow_decline": true,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"allow_reassign": true,
"attachments": [
{
@@ -468,7 +475,8 @@
"type": true,
"upload": true,
"phone": false,
- "default_type": "draw"
+ "default_type": "draw",
+ "force_advanced_signature_details": false
},
"signing_redirect_url": "https://example.com/redirect",
"subject": "The NDA we talked about",
diff --git a/test_fixtures/SignatureRequestSendWithTemplateRequest.json b/test_fixtures/SignatureRequestSendWithTemplateRequest.json
index 4d1cc86..df8e207 100644
--- a/test_fixtures/SignatureRequestSendWithTemplateRequest.json
+++ b/test_fixtures/SignatureRequestSendWithTemplateRequest.json
@@ -42,7 +42,8 @@
"type": true,
"upload": true,
"phone": false,
- "default_type": "draw"
+ "default_type": "draw",
+ "force_advanced_signature_details": false
},
"signing_redirect_url": "https://example.com/redirect",
"subject": "Purchase Order",
diff --git a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json
index b293945..0dd7c63 100644
--- a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json
+++ b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json
@@ -1,6 +1,9 @@
{
"default": {
"allow_ccs": true,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"allow_reassign": true,
"attachments": [
{
diff --git a/test_fixtures/TemplateGetResponse.json b/test_fixtures/TemplateGetResponse.json
index 0961c0e..e3608ac 100644
--- a/test_fixtures/TemplateGetResponse.json
+++ b/test_fixtures/TemplateGetResponse.json
@@ -9,6 +9,9 @@
"is_creator": true,
"is_embedded": false,
"is_locked": false,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"metadata": {
"metadata_name_1": "metadata_value_1",
"metadata_name_2": {
diff --git a/test_fixtures/TemplateListResponse.json b/test_fixtures/TemplateListResponse.json
index a4a144c..6b86496 100644
--- a/test_fixtures/TemplateListResponse.json
+++ b/test_fixtures/TemplateListResponse.json
@@ -16,6 +16,9 @@
"is_creator": true,
"is_embedded": false,
"is_locked": false,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"metadata": {
"metadata_name_1": "metadata_value_1",
"metadata_name_2": {
@@ -97,6 +100,9 @@
"is_creator": true,
"is_embedded": false,
"is_locked": false,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"metadata": {},
"signer_roles": [
{
diff --git a/test_fixtures/TemplateUpdateRequest.json b/test_fixtures/TemplateUpdateRequest.json
new file mode 100644
index 0000000..5dceb47
--- /dev/null
+++ b/test_fixtures/TemplateUpdateRequest.json
@@ -0,0 +1,21 @@
+{
+ "default": {
+ "signer_experience": {
+ "form_view": "disabled"
+ },
+ "title": "Test Title",
+ "subject": "Test Subject",
+ "message": "Test Message",
+ "cc_roles": ["one", "two"],
+ "form_fields": [
+ {
+ "api_id": "uniqueIdHere_1",
+ "name": "New name 1"
+ },
+ {
+ "api_id": "uniqueIdHere_2",
+ "name": "New name 2"
+ }
+ ]
+ }
+}
\ No newline at end of file
diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json
index e18890b..addbe6a 100644
--- a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json
+++ b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json
@@ -127,7 +127,8 @@
"type": true,
"upload": true,
"phone": false,
- "default_type": "draw"
+ "default_type": "draw",
+ "force_advanced_signature_details": false
},
"signing_redirect_url": "https://example.com/redirect",
"show_progress_stepper": true,
diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json
index 7c72649..d4f26cd 100644
--- a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json
+++ b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json
@@ -58,7 +58,8 @@
"type": true,
"upload": true,
"phone": false,
- "default_type": "draw"
+ "default_type": "draw",
+ "force_advanced_signature_details": false
},
"show_progress_stepper": true,
"skip_me_now": true,
diff --git a/test_fixtures/UnclaimedDraftCreateRequest.json b/test_fixtures/UnclaimedDraftCreateRequest.json
index b74d377..cc17e68 100644
--- a/test_fixtures/UnclaimedDraftCreateRequest.json
+++ b/test_fixtures/UnclaimedDraftCreateRequest.json
@@ -1,6 +1,9 @@
{
"default": {
"allow_decline": true,
+ "signer_experience": {
+ "form_view": "disabled"
+ },
"attachments": [
{
"name": "Attachment1",
@@ -114,7 +117,8 @@
"type": true,
"upload": true,
"phone": false,
- "default_type": "draw"
+ "default_type": "draw",
+ "force_advanced_signature_details": false
},
"signing_redirect_url": "https://example.com/redirect",
"subject": "The NDA we talked about",