Skip to content
Open
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Python 3.8+
Install using `pip`:

```shell
python3 -m pip install dropbox-sign==1.10.0
python3 -m pip install dropbox-sign==1.11.0
```

Alternatively:
Expand Down Expand Up @@ -185,6 +185,7 @@ Class | Method | HTTP request | Description
- [AccountGetResponse](docs/AccountGetResponse.md)
- [AccountResponse](docs/AccountResponse.md)
- [AccountResponseQuotas](docs/AccountResponseQuotas.md)
- [AccountResponseSettings](docs/AccountResponseSettings.md)
- [AccountResponseUsage](docs/AccountResponseUsage.md)
- [AccountUpdateRequest](docs/AccountUpdateRequest.md)
- [AccountVerifyRequest](docs/AccountVerifyRequest.md)
Expand Down Expand Up @@ -328,7 +329,6 @@ Class | Method | HTTP request | Description
- [TemplateCreateRequest](docs/TemplateCreateRequest.md)
- [TemplateCreateResponse](docs/TemplateCreateResponse.md)
- [TemplateCreateResponseTemplate](docs/TemplateCreateResponseTemplate.md)
- [TemplateEditResponse](docs/TemplateEditResponse.md)
- [TemplateGetResponse](docs/TemplateGetResponse.md)
- [TemplateListResponse](docs/TemplateListResponse.md)
- [TemplateRemoveUserRequest](docs/TemplateRemoveUserRequest.md)
Expand Down Expand Up @@ -400,6 +400,6 @@ apisupport@hellosign.com
This Python 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
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

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
1 change: 1 addition & 0 deletions docs/AccountResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Name | Type | Description | Notes
| `team_id` | ```str``` | The id of the team account belongs to. | |
| `locale` | ```str``` | The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values. | |
| `usage` | [```AccountResponseUsage```](AccountResponseUsage.md) | | |
| `settings` | [```AccountResponseSettings```](AccountResponseSettings.md) | | |

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

Expand Down
14 changes: 14 additions & 0 deletions docs/AccountResponseSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# 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#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


4 changes: 2 additions & 2 deletions docs/OAuthTokenRefreshRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `grant_type`<sup>*_required_</sup> | ```str``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] |
| `refresh_token`<sup>*_required_</sup> | ```str``` | The token provided when you got the expired access token. | |
| `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. | |
| `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. | |
| `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. | |
| `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. | |

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

Expand Down
16 changes: 8 additions & 8 deletions docs/SignatureRequestApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,7 @@ with ApiClient(configuration) as api_client:
phone=False,
type=True,
upload=True,
force_advanced_signature_details=False,
)

signers_1 = models.SubSignatureRequestSigner(
Expand Down Expand Up @@ -536,6 +537,7 @@ with ApiClient(configuration) as api_client:
phone=False,
type=True,
upload=True,
force_advanced_signature_details=False,
)

signers_1 = models.SubSignatureRequestTemplateSigner(
Expand Down Expand Up @@ -674,14 +676,12 @@ with ApiClient(configuration) as api_client:
files=[
open("./example_signature_request.pdf", "rb").read(),
],
metadata=json.loads(
"""
metadata=json.loads("""
{
"custom_id": 1234,
"custom_text": "NDA #9"
}
"""
),
"""),
field_options=field_options,
signing_options=signing_options,
signers=signers,
Expand Down Expand Up @@ -1673,6 +1673,7 @@ with ApiClient(configuration) as api_client:
phone=False,
type=True,
upload=True,
force_advanced_signature_details=False,
)

signers_1 = models.SubSignatureRequestSigner(
Expand Down Expand Up @@ -1704,14 +1705,12 @@ with ApiClient(configuration) as api_client:
files=[
open("./example_signature_request.pdf", "rb").read(),
],
metadata=json.loads(
"""
metadata=json.loads("""
{
"custom_id": 1234,
"custom_text": "NDA #9"
}
"""
),
"""),
field_options=field_options,
signing_options=signing_options,
signers=signers,
Expand Down Expand Up @@ -1790,6 +1789,7 @@ with ApiClient(configuration) as api_client:
phone=False,
type=True,
upload=True,
force_advanced_signature_details=False,
)

signers_1 = models.SubSignatureRequestTemplateSigner(
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestEditRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Name | Type | Description | Notes
| `form_field_rules` | [```List[SubFormFieldRule]```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
| `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` | |
| `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] |
| `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] |
| `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] |
| `message` | ```str``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#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. | |
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestEditWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Name | Type | Description | Notes
| `custom_fields` | [```List[SubCustomField]```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>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.&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] |
| `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] |
| `message` | ```str``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#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. | |
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestSendRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Name | Type | Description | Notes
| `form_fields_per_document` | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<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` | |
| `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] |
| `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] |
| `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] |
| `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] |
| `message` | ```str``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#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. | |
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
2 changes: 1 addition & 1 deletion docs/SignatureRequestSendWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name | Type | Description | Notes
| `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. | |
| `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. | |
| `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] |
| `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] |
| `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] |
| `message` | ```str``` | The custom message in the email that will be sent to the signers. | |
| `metadata` | ```Dict[str, object]``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#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. | |
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
Expand Down
5 changes: 4 additions & 1 deletion docs/SubSigningOptions.md
Original file line number Diff line number Diff line change
@@ -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
------------ | ------------- | ------------- | -------------
Expand All @@ -12,6 +14,7 @@ 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#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Loading
Loading