Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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`
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.10.0
1.11.0
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
32 changes: 28 additions & 4 deletions docs/Api/SignatureRequestApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down Expand Up @@ -398,6 +402,7 @@ $signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRe
->setFiles([
])
->setSigningOptions($signing_options)
->setSignerExperience($signer_experience)
->setSigners($signers);

try {
Expand Down Expand Up @@ -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")
Expand All @@ -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 {
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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 {
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -690,6 +707,7 @@ $signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequ
->setFiles([
])
->setSigningOptions($signing_options)
->setSignerExperience($signer_experience)
->setSigners($signers);

try {
Expand Down Expand Up @@ -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")
Expand All @@ -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 {
Expand Down Expand Up @@ -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")
Expand Down Expand Up @@ -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")
Expand Down
94 changes: 94 additions & 0 deletions docs/Api/TemplateApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |


Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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
<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->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
Expand Down
1 change: 1 addition & 0 deletions docs/Model/AccountResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
13 changes: 13 additions & 0 deletions docs/Model/AccountResponseSettings.md
Original file line number Diff line number Diff line change
@@ -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)
1 change: 1 addition & 0 deletions docs/Model/BulkSendJobGetResponseSignatureRequests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
1 change: 1 addition & 0 deletions docs/Model/EmbeddedEditUrlRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
1 change: 1 addition & 0 deletions docs/Model/SignatureRequestCreateEmbeddedRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&#39;s information during signing.<br><br>**NOTE:** Keep your signer&#39;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)
Original file line number Diff line number Diff line change
Expand Up @@ -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&#39;s information during signing.<br><br>**NOTE:** Keep your signer&#39;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)
1 change: 1 addition & 0 deletions docs/Model/SignatureRequestEditEmbeddedRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&#39;s information during signing.<br><br>**NOTE:** Keep your signer&#39;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)
Loading
Loading