Skip to content

Commit cf1a02d

Browse files
authored
Merge pull request #23 from hellosign/release-1.11.0
Release 1.11.0
2 parents 7d630a9 + 002da33 commit cf1a02d

230 files changed

Lines changed: 353 additions & 363 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Python 3.8+
4949
Install using `pip`:
5050

5151
```shell
52-
python3 -m pip install dropbox-sign==1.10.0
52+
python3 -m pip install dropbox-sign==1.11.0
5353
```
5454

5555
Alternatively:
@@ -185,6 +185,7 @@ Class | Method | HTTP request | Description
185185
- [AccountGetResponse](docs/AccountGetResponse.md)
186186
- [AccountResponse](docs/AccountResponse.md)
187187
- [AccountResponseQuotas](docs/AccountResponseQuotas.md)
188+
- [AccountResponseSettings](docs/AccountResponseSettings.md)
188189
- [AccountResponseUsage](docs/AccountResponseUsage.md)
189190
- [AccountUpdateRequest](docs/AccountUpdateRequest.md)
190191
- [AccountVerifyRequest](docs/AccountVerifyRequest.md)
@@ -328,7 +329,6 @@ Class | Method | HTTP request | Description
328329
- [TemplateCreateRequest](docs/TemplateCreateRequest.md)
329330
- [TemplateCreateResponse](docs/TemplateCreateResponse.md)
330331
- [TemplateCreateResponseTemplate](docs/TemplateCreateResponseTemplate.md)
331-
- [TemplateEditResponse](docs/TemplateEditResponse.md)
332332
- [TemplateGetResponse](docs/TemplateGetResponse.md)
333333
- [TemplateListResponse](docs/TemplateListResponse.md)
334334
- [TemplateRemoveUserRequest](docs/TemplateRemoveUserRequest.md)
@@ -400,6 +400,6 @@ apisupport@hellosign.com
400400
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
401401

402402
- API version: 3.0.0
403-
- Package version: 1.10.0
403+
- Package version: 1.11.0
404404
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
405405

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.10.0
1+
1.11.0

docs/AccountResponse.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
1616
| `team_id` | ```str``` | The id of the team account belongs to. | |
1717
| `locale` | ```str``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | |
1818
| `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | |
19+
| `settings` | [```AccountResponseSettings```](AccountResponseSettings.md) | | |
1920

2021
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
2122

docs/AccountResponseSettings.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# AccountResponseSettings
2+
3+
Subset of configured settings
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
| `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). | |
9+
| `sms_delivery` | ```bool``` | Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
10+
| `sms_authentication` | ```bool``` | Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough). | |
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

docs/OAuthTokenRefreshRequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
| `grant_type`<sup>*_required_</sup> | ```str``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] |
99
| `refresh_token`<sup>*_required_</sup> | ```str``` | The token provided when you got the expired access token. | |
10-
| `client_id` | ```str``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
11-
| `client_secret` | ```str``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled. | |
10+
| `client_id` | ```str``` | The client ID for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | |
11+
| `client_secret` | ```str``` | The client secret for your API app. Required for new API apps. To enhance security, we recommend making it required for existing apps in your app settings. | |
1212

1313
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1414

docs/SignatureRequestApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,7 @@ with ApiClient(configuration) as api_client:
425425
phone=False,
426426
type=True,
427427
upload=True,
428+
force_advanced_signature_details=False,
428429
)
429430
430431
signers_1 = models.SubSignatureRequestSigner(
@@ -536,6 +537,7 @@ with ApiClient(configuration) as api_client:
536537
phone=False,
537538
type=True,
538539
upload=True,
540+
force_advanced_signature_details=False,
539541
)
540542
541543
signers_1 = models.SubSignatureRequestTemplateSigner(
@@ -674,14 +676,12 @@ with ApiClient(configuration) as api_client:
674676
files=[
675677
open("./example_signature_request.pdf", "rb").read(),
676678
],
677-
metadata=json.loads(
678-
"""
679+
metadata=json.loads("""
679680
{
680681
"custom_id": 1234,
681682
"custom_text": "NDA #9"
682683
}
683-
"""
684-
),
684+
"""),
685685
field_options=field_options,
686686
signing_options=signing_options,
687687
signers=signers,
@@ -1673,6 +1673,7 @@ with ApiClient(configuration) as api_client:
16731673
phone=False,
16741674
type=True,
16751675
upload=True,
1676+
force_advanced_signature_details=False,
16761677
)
16771678
16781679
signers_1 = models.SubSignatureRequestSigner(
@@ -1704,14 +1705,12 @@ with ApiClient(configuration) as api_client:
17041705
files=[
17051706
open("./example_signature_request.pdf", "rb").read(),
17061707
],
1707-
metadata=json.loads(
1708-
"""
1708+
metadata=json.loads("""
17091709
{
17101710
"custom_id": 1234,
17111711
"custom_text": "NDA #9"
17121712
}
1713-
"""
1714-
),
1713+
"""),
17151714
field_options=field_options,
17161715
signing_options=signing_options,
17171716
signers=signers,
@@ -1790,6 +1789,7 @@ with ApiClient(configuration) as api_client:
17901789
phone=False,
17911790
type=True,
17921791
upload=True,
1792+
force_advanced_signature_details=False,
17931793
)
17941794
17951795
signers_1 = models.SubSignatureRequestTemplateSigner(

docs/SignatureRequestEditRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
2020
| `form_field_rules` | [```List[SubFormFieldRule]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
2121
| `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**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.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
2222
| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.<br><br>**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] |
23-
| `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.&lt;br&gt;<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] |
23+
| `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.&lt;br&gt;<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] |
2424
| `message` | ```str``` | The custom message in the email that will be sent to the signers. | |
2525
| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
2626
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |

docs/SignatureRequestEditWithTemplateRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
1313
| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
1414
| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
1515
| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
16-
| `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.&lt;br&gt;<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] |
16+
| `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.&lt;br&gt;<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] |
1717
| `message` | ```str``` | The custom message in the email that will be sent to the signers. | |
1818
| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
1919
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |

docs/SignatureRequestSendRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
2121
| `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**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.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
2222
| `hide_text_tags` | ```bool``` | Enables automatic Text Tag removal when set to true.<br><br>**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] |
2323
| `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&#39;s identity.&lt;br&gt;<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] |
24-
| `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.&lt;br&gt;<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] |
24+
| `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.&lt;br&gt;<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] |
2525
| `message` | ```str``` | The custom message in the email that will be sent to the signers. | |
2626
| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
2727
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |

docs/SignatureRequestSendWithTemplateRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
1414
| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
1515
| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
1616
| `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&#39;s identity.&lt;br&gt;<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] |
17-
| `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.&lt;br&gt;<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] |
17+
| `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.&lt;br&gt;<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] |
1818
| `message` | ```str``` | The custom message in the email that will be sent to the signers. | |
1919
| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
2020
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |

0 commit comments

Comments
 (0)