Skip to content
Merged
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
4 changes: 2 additions & 2 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.11.0
python3 -m pip install dropbox-sign==1.12.0
```

Alternatively:
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.11.0
- Package version: 1.12.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.11.0
1.12.0
12 changes: 8 additions & 4 deletions docs/SignatureRequestApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -676,12 +676,14 @@ 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 @@ -1705,12 +1707,14 @@ 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
1 change: 1 addition & 0 deletions docs/SignatureRequestCreateEmbeddedRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ 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` | ```str``` | 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] |
| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `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. | |

Expand Down
1 change: 1 addition & 0 deletions docs/SignatureRequestEditEmbeddedRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ 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` | ```str``` | 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] |
| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `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. | |

Expand Down
1 change: 1 addition & 0 deletions docs/SignatureRequestEditRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ 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` | ```str``` | 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] |
| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `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. | |

[[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
1 change: 1 addition & 0 deletions docs/SignatureRequestSendRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ 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` | ```str``` | 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] |
| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `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. | |

[[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
1 change: 1 addition & 0 deletions docs/TemplateCreateEmbeddedDraftRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ 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` | ```str``` | 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] |
| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [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
1 change: 1 addition & 0 deletions docs/TemplateCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ 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` | ```str``` | 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] |
| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [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
1 change: 1 addition & 0 deletions docs/UnclaimedDraftCreateEmbeddedRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Name | Type | Description | Notes
| `type` | ```str``` | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [default to 'request_signature'] |
| `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] |
| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `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.<br><br>**NOTE:** This does not correspond to the **expires_at** returned in the response. | |

Expand Down
1 change: 1 addition & 0 deletions docs/UnclaimedDraftCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ 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] |
| `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] |
| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `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.<br><br>**NOTE:** This does not correspond to the **expires_at** returned in the response. | |

[[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
3 changes: 2 additions & 1 deletion dropbox_sign/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
Do not edit the class manually.
""" # noqa: E501

__version__ = "1.11.0"

__version__ = "1.12.0"

# import apis into sdk package
from dropbox_sign.apis import *
Expand Down
3 changes: 2 additions & 1 deletion dropbox_sign/api_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


import datetime
from dateutil.parser import parse
from enum import Enum
Expand Down Expand Up @@ -88,7 +89,7 @@ def __init__(
self.default_headers[header_name] = header_value
self.cookie = cookie
# Set default User-Agent.
self.user_agent = "OpenAPI-Generator/1.11.0/python"
self.user_agent = "OpenAPI-Generator/1.12.0/python"
self.client_side_validation = configuration.client_side_validation

def __enter__(self):
Expand Down
4 changes: 3 additions & 1 deletion dropbox_sign/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


import copy
import http.client as httplib
import logging
Expand All @@ -23,6 +24,7 @@

import urllib3


JSON_SCHEMA_VALIDATION_KEYWORDS = {
"multipleOf",
"maximum",
Expand Down Expand Up @@ -544,7 +546,7 @@ def to_debug_report(self) -> str:
"OS: {env}\n"
"Python Version: {pyversion}\n"
"Version of the API: 3.0.0\n"
"SDK Package Version: 1.11.0".format(
"SDK Package Version: 1.12.0".format(
env=sys.platform, pyversion=sys.version
)
)
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
Do not edit the class manually.
""" # noqa: E501


# import models into model package
from dropbox_sign.models.account_create_request import AccountCreateRequest
from dropbox_sign.models.account_create_response import AccountCreateResponse
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_create_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_create_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_get_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_response_quotas.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_response_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_response_usage.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_update_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_verify_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_verify_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/account_verify_response_account.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/api_app_create_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/api_app_get_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/api_app_list_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/api_app_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/api_app_response_o_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/api_app_response_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/api_app_response_owner_account.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/api_app_update_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/bulk_send_job_get_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/bulk_send_job_list_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/bulk_send_job_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/bulk_send_job_send_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/embedded_edit_url_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/models/embedded_edit_url_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
Do not edit the class manually.
""" # noqa: E501


from __future__ import annotations
import pprint
import re # noqa: F401
Expand Down
Loading
Loading