diff --git a/README.md b/README.md index 29eec44..5192a1b 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Python 3.8+ Install using `pip`: ```shell -python3 -m pip install dropbox-sign==1.13.0 +python3 -m pip install dropbox-sign==1.14.0 ``` Alternatively: @@ -114,6 +114,7 @@ Class | Method | HTTP request | Description ```ApiAppApi``` | [```api_app_update```](docs/ApiAppApi.md#api_app_update) | ```PUT /api_app/{client_id}``` | Update API App| |```BulkSendJobApi``` | [```bulk_send_job_get```](docs/BulkSendJobApi.md#bulk_send_job_get) | ```GET /bulk_send_job/{bulk_send_job_id}``` | Get Bulk Send Job| ```BulkSendJobApi``` | [```bulk_send_job_list```](docs/BulkSendJobApi.md#bulk_send_job_list) | ```GET /bulk_send_job/list``` | List Bulk Send Jobs| +|```DocumentApi``` | [```document_detect_fields```](docs/DocumentApi.md#document_detect_fields) | ```POST /document/detect_fields``` | Detect Document Fields| |```EmbeddedApi``` | [```embedded_edit_url```](docs/EmbeddedApi.md#embedded_edit_url) | ```POST /embedded/edit_url/{template_id}``` | Get Embedded Template Edit URL| ```EmbeddedApi``` | [```embedded_sign_url```](docs/EmbeddedApi.md#embedded_sign_url) | ```GET /embedded/sign_url/{signature_id}``` | Get Embedded Sign URL| |```FaxApi``` | [```fax_delete```](docs/FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax| @@ -205,6 +206,9 @@ Class | Method | HTTP request | Description - [BulkSendJobListResponse](docs/BulkSendJobListResponse.md) - [BulkSendJobResponse](docs/BulkSendJobResponse.md) - [BulkSendJobSendResponse](docs/BulkSendJobSendResponse.md) + - [DocumentFieldDetectionRequest](docs/DocumentFieldDetectionRequest.md) + - [DocumentFieldDetectionResponse](docs/DocumentFieldDetectionResponse.md) + - [DocumentFieldDetectionResponseDetectionResult](docs/DocumentFieldDetectionResponseDetectionResult.md) - [EmbeddedEditUrlRequest](docs/EmbeddedEditUrlRequest.md) - [EmbeddedEditUrlResponse](docs/EmbeddedEditUrlResponse.md) - [EmbeddedEditUrlResponseEmbedded](docs/EmbeddedEditUrlResponseEmbedded.md) @@ -400,6 +404,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.13.0 +- Package version: 1.14.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen diff --git a/VERSION b/VERSION index feaae22..850e742 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.13.0 +1.14.0 diff --git a/docs/DocumentApi.md b/docs/DocumentApi.md new file mode 100644 index 0000000..c5e2321 --- /dev/null +++ b/docs/DocumentApi.md @@ -0,0 +1,79 @@ +# ```dropbox_sign.DocumentApi``` + +All URIs are relative to *https://api.hellosign.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +|[```document_detect_fields```](DocumentApi.md#document_detect_fields) | ```POST /document/detect_fields``` | Detect Document Fields| + + +# ```document_detect_fields``` +> ```DocumentFieldDetectionResponse document_detect_fields(document_field_detection_request)``` + +Detect Document Fields + +Detects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags. + +### Example + +* Basic Authentication (api_key): +* Bearer (JWT) Authentication (oauth2): + +```python +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + document_field_detection_request = models.DocumentFieldDetectionRequest( + detection_mode="annotations", + file=open("./example_document.pdf", "rb").read(), + page_range="all", + ) + + try: + response = api.DocumentApi(api_client).document_detect_fields( + document_field_detection_request=document_field_detection_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling DocumentApi#document_detect_fields: %s\n" % e) + +``` +``` + +### Parameters +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `document_field_detection_request` | [**DocumentFieldDetectionRequest**](DocumentFieldDetectionRequest.md) | | | + +### Return type + +[**DocumentFieldDetectionResponse**](DocumentFieldDetectionResponse.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 + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/DocumentFieldDetectionRequest.md b/docs/DocumentFieldDetectionRequest.md new file mode 100644 index 0000000..8476b7d --- /dev/null +++ b/docs/DocumentFieldDetectionRequest.md @@ -0,0 +1,15 @@ +# DocumentFieldDetectionRequest + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `detection_mode`*_required_ | ```str``` | The field detection method to use. Set to `annotations` to detect PDF form annotations or `text_tags` to detect Dropbox Sign text tags. | | +| `file` | ```io.IOBase``` | The PDF file to analyze.

This endpoint requires either `file` or `file_url`, but not both. | | +| `file_url` | ```str``` | The URL of the PDF file to analyze.

This endpoint requires either `file` or `file_url`, but not both. | | +| `page_range` | ```str``` | The zero-based page indexes to analyze. Accepts `all`, individual pages, inclusive ranges, or comma-separated combinations, such as `0-2,5,7-9`. Defaults to `all`. | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DocumentFieldDetectionResponse.md b/docs/DocumentFieldDetectionResponse.md new file mode 100644 index 0000000..59acfd2 --- /dev/null +++ b/docs/DocumentFieldDetectionResponse.md @@ -0,0 +1,13 @@ +# DocumentFieldDetectionResponse + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `detection_result`*_required_ | [```DocumentFieldDetectionResponseDetectionResult```](DocumentFieldDetectionResponseDetectionResult.md) | | | +| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DocumentFieldDetectionResponseDetectionResult.md b/docs/DocumentFieldDetectionResponseDetectionResult.md new file mode 100644 index 0000000..15e3aba --- /dev/null +++ b/docs/DocumentFieldDetectionResponseDetectionResult.md @@ -0,0 +1,21 @@ +# DocumentFieldDetectionResponseDetectionResult + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `document_hash`*_required_ | ```str``` | The SHA-256 hash of the analyzed document. | | +| `detection_mode`*_required_ | ```str``` | The field detection method used to analyze the document: `annotations` or `text_tags`. | | +| `page_count`*_required_ | ```int``` | The total number of pages in the document. | | +| `pages_analyzed`*_required_ | ```str``` | The zero-based page indexes analyzed, represented by the requested `page_range`, or `all` when every page was analyzed. | | +| `detected_at`*_required_ | ```int``` | The Unix timestamp when the field detection result was generated. | | +| `form_fields_per_document`*_required_ | [```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).)

**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` | | +| `form_field_groups`*_required_ | [```List[SubFormFieldGroup]```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | | +| `warnings`*_required_ | [```List[WarningResponse]```](WarningResponse.md) | Non-fatal issues encountered during field detection. | | +| `errors`*_required_ | [```List[ErrorResponseError]```](ErrorResponseError.md) | Errors encountered during field detection. Successfully detected fields may still be included in the response. | | +| `suggestions`*_required_ | ```List[str]``` | Suggestions for improving the field detection results. | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ErrorResponseError.md b/docs/ErrorResponseError.md index f6052d6..3ed2233 100644 --- a/docs/ErrorResponseError.md +++ b/docs/ErrorResponseError.md @@ -6,7 +6,7 @@ Contains information about an error that occurred. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `error_msg`*_required_ | ```str``` | Message describing an error. | | -| `error_name`*_required_ | ```str``` | Name of the error. | | +| `error_name`*_required_ | ```str``` | Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance. | | | `error_path` | ```str``` | Path at which an error occurred. | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/FaxResponse.md b/docs/FaxResponse.md index 81070c5..3f7f49b 100644 --- a/docs/FaxResponse.md +++ b/docs/FaxResponse.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes | `sender`*_required_ | ```str``` | Fax Sender Email | | | `files_url`*_required_ | ```str``` | Fax Files URL | | | `transmissions`*_required_ | [```List[FaxResponseTransmission]```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `test_mode`*_required_ | ```bool``` | Whether this is a test fax. Test faxes are not delivered to the recipient. Defaults to `false`. | [default to False] | | `subject` | ```str``` | Fax Subject | | | `message` | ```str``` | Fax Message | | | `final_copy_uri` | ```str``` | The path where the completed document can be downloaded | | diff --git a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index d09fa3c..2153020 100644 --- a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes | `subject` | ```str``` | 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` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `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) diff --git a/docs/SignatureRequestBulkSendWithTemplateRequest.md b/docs/SignatureRequestBulkSendWithTemplateRequest.md index 0780a3c..f400bd9 100644 --- a/docs/SignatureRequestBulkSendWithTemplateRequest.md +++ b/docs/SignatureRequestBulkSendWithTemplateRequest.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes | `subject` | ```str``` | 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` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `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) diff --git a/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 2617597..f9a07ce 100644 --- a/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -20,6 +20,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. | | | `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. | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SignatureRequestSendWithTemplateRequest.md b/docs/SignatureRequestSendWithTemplateRequest.md index 6cdff03..8b2637d 100644 --- a/docs/SignatureRequestSendWithTemplateRequest.md +++ b/docs/SignatureRequestSendWithTemplateRequest.md @@ -22,6 +22,7 @@ Name | Type | Description | Notes | `subject` | ```str``` | 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` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `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) diff --git a/dropbox_sign/__init__.py b/dropbox_sign/__init__.py index c689d0a..0429cc7 100644 --- a/dropbox_sign/__init__.py +++ b/dropbox_sign/__init__.py @@ -15,7 +15,7 @@ """ # noqa: E501 -__version__ = "1.13.0" +__version__ = "1.14.0" # import apis into sdk package from dropbox_sign.apis import * @@ -65,6 +65,15 @@ from dropbox_sign.models.bulk_send_job_list_response import BulkSendJobListResponse from dropbox_sign.models.bulk_send_job_response import BulkSendJobResponse from dropbox_sign.models.bulk_send_job_send_response import BulkSendJobSendResponse +from dropbox_sign.models.document_field_detection_request import ( + DocumentFieldDetectionRequest, +) +from dropbox_sign.models.document_field_detection_response import ( + DocumentFieldDetectionResponse, +) +from dropbox_sign.models.document_field_detection_response_detection_result import ( + DocumentFieldDetectionResponseDetectionResult, +) from dropbox_sign.models.embedded_edit_url_request import EmbeddedEditUrlRequest from dropbox_sign.models.embedded_edit_url_response import EmbeddedEditUrlResponse from dropbox_sign.models.embedded_edit_url_response_embedded import ( diff --git a/dropbox_sign/api/__init__.py b/dropbox_sign/api/__init__.py index f4000e5..7a9e7fa 100644 --- a/dropbox_sign/api/__init__.py +++ b/dropbox_sign/api/__init__.py @@ -4,6 +4,7 @@ from dropbox_sign.api.account_api import AccountApi from dropbox_sign.api.api_app_api import ApiAppApi from dropbox_sign.api.bulk_send_job_api import BulkSendJobApi +from dropbox_sign.api.document_api import DocumentApi from dropbox_sign.api.embedded_api import EmbeddedApi from dropbox_sign.api.fax_api import FaxApi from dropbox_sign.api.fax_line_api import FaxLineApi diff --git a/dropbox_sign/api/account_api.py b/dropbox_sign/api/account_api.py index c326dc1..887a72b 100644 --- a/dropbox_sign/api/account_api.py +++ b/dropbox_sign/api/account_api.py @@ -65,6 +65,8 @@ def account_create( Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountCreateExample.py + :param account_create_request: (required) :type account_create_request: AccountCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -101,6 +103,7 @@ def account_create( "200": "AccountCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -130,6 +133,8 @@ def account_create_with_http_info( Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountCreateExample.py + :param account_create_request: (required) :type account_create_request: AccountCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -166,6 +171,7 @@ def account_create_with_http_info( "200": "AccountCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -195,6 +201,8 @@ def account_create_without_preload_content( Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountCreateExample.py + :param account_create_request: (required) :type account_create_request: AccountCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -231,6 +239,7 @@ def account_create_without_preload_content( "200": "AccountCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -353,6 +362,8 @@ def account_get( Returns the properties and settings of your Account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountGetExample.py + :param account_id: `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. :type account_id: str :param email_address: `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. @@ -392,6 +403,7 @@ def account_get( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -432,6 +444,8 @@ def account_get_with_http_info( Returns the properties and settings of your Account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountGetExample.py + :param account_id: `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. :type account_id: str :param email_address: `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. @@ -471,6 +485,7 @@ def account_get_with_http_info( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -511,6 +526,8 @@ def account_get_without_preload_content( Returns the properties and settings of your Account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountGetExample.py + :param account_id: `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. :type account_id: str :param email_address: `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. @@ -550,6 +567,7 @@ def account_get_without_preload_content( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -636,6 +654,8 @@ def account_update( Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountUpdateExample.py + :param account_update_request: (required) :type account_update_request: AccountUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -672,6 +692,7 @@ def account_update( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -701,6 +722,8 @@ def account_update_with_http_info( Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountUpdateExample.py + :param account_update_request: (required) :type account_update_request: AccountUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -737,6 +760,7 @@ def account_update_with_http_info( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -766,6 +790,8 @@ def account_update_without_preload_content( Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountUpdateExample.py + :param account_update_request: (required) :type account_update_request: AccountUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -802,6 +828,7 @@ def account_update_without_preload_content( "200": "AccountGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -913,6 +940,8 @@ def account_verify( Verifies whether an Dropbox Sign Account exists for the given email address. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountVerifyExample.py + :param account_verify_request: (required) :type account_verify_request: AccountVerifyRequest :param _request_timeout: timeout setting for this request. If one @@ -949,6 +978,7 @@ def account_verify( "200": "AccountVerifyResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -978,6 +1008,8 @@ def account_verify_with_http_info( Verifies whether an Dropbox Sign Account exists for the given email address. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountVerifyExample.py + :param account_verify_request: (required) :type account_verify_request: AccountVerifyRequest :param _request_timeout: timeout setting for this request. If one @@ -1014,6 +1046,7 @@ def account_verify_with_http_info( "200": "AccountVerifyResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1043,6 +1076,8 @@ def account_verify_without_preload_content( Verifies whether an Dropbox Sign Account exists for the given email address. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/AccountVerifyExample.py + :param account_verify_request: (required) :type account_verify_request: AccountVerifyRequest :param _request_timeout: timeout setting for this request. If one @@ -1079,6 +1114,7 @@ def account_verify_without_preload_content( "200": "AccountVerifyResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/api_app_api.py b/dropbox_sign/api/api_app_api.py index 45ce475..b626413 100644 --- a/dropbox_sign/api/api_app_api.py +++ b/dropbox_sign/api/api_app_api.py @@ -63,6 +63,8 @@ def api_app_create( Creates a new API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppCreateExample.py + :param api_app_create_request: (required) :type api_app_create_request: ApiAppCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -99,6 +101,7 @@ def api_app_create( "201": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -128,6 +131,8 @@ def api_app_create_with_http_info( Creates a new API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppCreateExample.py + :param api_app_create_request: (required) :type api_app_create_request: ApiAppCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -164,6 +169,7 @@ def api_app_create_with_http_info( "201": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -193,6 +199,8 @@ def api_app_create_without_preload_content( Creates a new API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppCreateExample.py + :param api_app_create_request: (required) :type api_app_create_request: ApiAppCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -229,6 +237,7 @@ def api_app_create_without_preload_content( "201": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -342,6 +351,8 @@ def api_app_delete( Deletes an API App. Can only be invoked for apps you own. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppDeleteExample.py + :param client_id: The client id of the API App to delete. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -378,6 +389,7 @@ def api_app_delete( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -409,6 +421,8 @@ def api_app_delete_with_http_info( Deletes an API App. Can only be invoked for apps you own. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppDeleteExample.py + :param client_id: The client id of the API App to delete. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -445,6 +459,7 @@ def api_app_delete_with_http_info( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -476,6 +491,8 @@ def api_app_delete_without_preload_content( Deletes an API App. Can only be invoked for apps you own. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppDeleteExample.py + :param client_id: The client id of the API App to delete. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -512,6 +529,7 @@ def api_app_delete_without_preload_content( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -593,6 +611,8 @@ def api_app_get( Returns an object with information about an API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppGetExample.py + :param client_id: The client id of the API App to retrieve. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -629,6 +649,7 @@ def api_app_get( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -660,6 +681,8 @@ def api_app_get_with_http_info( Returns an object with information about an API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppGetExample.py + :param client_id: The client id of the API App to retrieve. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -696,6 +719,7 @@ def api_app_get_with_http_info( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -727,6 +751,8 @@ def api_app_get_without_preload_content( Returns an object with information about an API App. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppGetExample.py + :param client_id: The client id of the API App to retrieve. (required) :type client_id: str :param _request_timeout: timeout setting for this request. If one @@ -763,6 +789,7 @@ def api_app_get_without_preload_content( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -853,6 +880,8 @@ def api_app_list( Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppListExample.py + :param page: Which page number of the API App List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -892,6 +921,7 @@ def api_app_list( "200": "ApiAppListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -932,6 +962,8 @@ def api_app_list_with_http_info( Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppListExample.py + :param page: Which page number of the API App List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -971,6 +1003,7 @@ def api_app_list_with_http_info( "200": "ApiAppListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1011,6 +1044,8 @@ def api_app_list_without_preload_content( Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppListExample.py + :param page: Which page number of the API App List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -1050,6 +1085,7 @@ def api_app_list_without_preload_content( "200": "ApiAppListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1139,6 +1175,8 @@ def api_app_update( Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppUpdateExample.py + :param client_id: The client id of the API App to update. (required) :type client_id: str :param api_app_update_request: (required) @@ -1178,6 +1216,7 @@ def api_app_update( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1210,6 +1249,8 @@ def api_app_update_with_http_info( Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppUpdateExample.py + :param client_id: The client id of the API App to update. (required) :type client_id: str :param api_app_update_request: (required) @@ -1249,6 +1290,7 @@ def api_app_update_with_http_info( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1281,6 +1323,8 @@ def api_app_update_without_preload_content( Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ApiAppUpdateExample.py + :param client_id: The client id of the API App to update. (required) :type client_id: str :param api_app_update_request: (required) @@ -1320,6 +1364,7 @@ def api_app_update_without_preload_content( "200": "ApiAppGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/bulk_send_job_api.py b/dropbox_sign/api/bulk_send_job_api.py index eb0b4bc..12eeb2c 100644 --- a/dropbox_sign/api/bulk_send_job_api.py +++ b/dropbox_sign/api/bulk_send_job_api.py @@ -75,6 +75,8 @@ def bulk_send_job_get( Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobGetExample.py + :param bulk_send_job_id: The id of the BulkSendJob to retrieve. (required) :type bulk_send_job_id: str :param page: Which page number of the BulkSendJob list to return. Defaults to `1`. @@ -117,6 +119,7 @@ def bulk_send_job_get( "200": "BulkSendJobGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -160,6 +163,8 @@ def bulk_send_job_get_with_http_info( Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobGetExample.py + :param bulk_send_job_id: The id of the BulkSendJob to retrieve. (required) :type bulk_send_job_id: str :param page: Which page number of the BulkSendJob list to return. Defaults to `1`. @@ -202,6 +207,7 @@ def bulk_send_job_get_with_http_info( "200": "BulkSendJobGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -245,6 +251,8 @@ def bulk_send_job_get_without_preload_content( Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobGetExample.py + :param bulk_send_job_id: The id of the BulkSendJob to retrieve. (required) :type bulk_send_job_id: str :param page: Which page number of the BulkSendJob list to return. Defaults to `1`. @@ -287,6 +295,7 @@ def bulk_send_job_get_without_preload_content( "200": "BulkSendJobGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -387,6 +396,8 @@ def bulk_send_job_list( Returns a list of BulkSendJob that you can access. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobListExample.py + :param page: Which page number of the BulkSendJob List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. @@ -426,6 +437,7 @@ def bulk_send_job_list( "200": "BulkSendJobListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -466,6 +478,8 @@ def bulk_send_job_list_with_http_info( Returns a list of BulkSendJob that you can access. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobListExample.py + :param page: Which page number of the BulkSendJob List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. @@ -505,6 +519,7 @@ def bulk_send_job_list_with_http_info( "200": "BulkSendJobListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -545,6 +560,8 @@ def bulk_send_job_list_without_preload_content( Returns a list of BulkSendJob that you can access. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/BulkSendJobListExample.py + :param page: Which page number of the BulkSendJob List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. @@ -584,6 +601,7 @@ def bulk_send_job_list_without_preload_content( "200": "BulkSendJobListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/document_api.py b/dropbox_sign/api/document_api.py new file mode 100644 index 0000000..eb92dc1 --- /dev/null +++ b/dropbox_sign/api/document_api.py @@ -0,0 +1,329 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from dropbox_sign.models.document_field_detection_request import ( + DocumentFieldDetectionRequest, +) +from dropbox_sign.models.document_field_detection_response import ( + DocumentFieldDetectionResponse, +) + +from dropbox_sign.api_client import ApiClient, RequestSerialized +from dropbox_sign.api_response import ApiResponse +from dropbox_sign.rest import RESTResponseType +import io + + +class DocumentApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_call + def document_detect_fields( + self, + document_field_detection_request: DocumentFieldDetectionRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DocumentFieldDetectionResponse: + """Detect Document Fields + + Detects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags. + + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/DocumentDetectFieldsExample.py + + :param document_field_detection_request: (required) + :type document_field_detection_request: DocumentFieldDetectionRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._document_detect_fields_serialize( + document_field_detection_request=document_field_detection_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "DocumentFieldDetectionResponse", + "4XX": "ErrorResponse", + } + + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def document_detect_fields_with_http_info( + self, + document_field_detection_request: DocumentFieldDetectionRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DocumentFieldDetectionResponse]: + """Detect Document Fields + + Detects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags. + + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/DocumentDetectFieldsExample.py + + :param document_field_detection_request: (required) + :type document_field_detection_request: DocumentFieldDetectionRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._document_detect_fields_serialize( + document_field_detection_request=document_field_detection_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "DocumentFieldDetectionResponse", + "4XX": "ErrorResponse", + } + + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def document_detect_fields_without_preload_content( + self, + document_field_detection_request: DocumentFieldDetectionRequest, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)] + ], + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Detect Document Fields + + Detects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags. + + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/DocumentDetectFieldsExample.py + + :param document_field_detection_request: (required) + :type document_field_detection_request: DocumentFieldDetectionRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._document_detect_fields_serialize( + document_field_detection_request=document_field_detection_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index, + ) + + _response_types_map: Dict[str, Optional[str]] = { + "200": "DocumentFieldDetectionResponse", + "4XX": "ErrorResponse", + } + + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout + ) + return response_data.response + + def _document_detect_fields_serialize( + self, + document_field_detection_request, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[ + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]] + ] = {} + _body_params: Optional[bytes] = None + + has_files = False + body_param = document_field_detection_request + excluded_json_fields = set([]) + for param_name, param_type in body_param.openapi_types().items(): + param_value = getattr(body_param, param_name) + if param_value is None: + continue + + if "io.IOBase" in param_type: + has_files = True + _content_type = "multipart/form-data" + excluded_json_fields.add(param_name) + + if isinstance(param_value, list): + for index, item in enumerate(param_value): + _files[f"{param_name}[{index}]"] = item + else: + _files[param_name] = param_value + + if has_files is True: + _form_params = body_param.to_json_form_params(excluded_json_fields) + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if document_field_detection_request is not None and has_files is False: + _body_params = document_field_detection_request + + # set the HTTP header `Accept` + if "Accept" not in _header_params: + _header_params["Accept"] = self.api_client.select_header_accept( + ["application/json"] + ) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params["Content-Type"] = _content_type + else: + _default_content_type = self.api_client.select_header_content_type( + ["application/json", "multipart/form-data"] + ) + if _default_content_type is not None: + _header_params["Content-Type"] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ["api_key", "oauth2"] + + return self.api_client.param_serialize( + method="POST", + resource_path="/document/detect_fields", + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth, + ) diff --git a/dropbox_sign/api/embedded_api.py b/dropbox_sign/api/embedded_api.py index 450099e..1a79db1 100644 --- a/dropbox_sign/api/embedded_api.py +++ b/dropbox_sign/api/embedded_api.py @@ -64,6 +64,8 @@ def embedded_edit_url( Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedEditUrlExample.py + :param template_id: The id of the template to edit. (required) :type template_id: str :param embedded_edit_url_request: (required) @@ -103,6 +105,7 @@ def embedded_edit_url( "200": "EmbeddedEditUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -135,6 +138,8 @@ def embedded_edit_url_with_http_info( Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedEditUrlExample.py + :param template_id: The id of the template to edit. (required) :type template_id: str :param embedded_edit_url_request: (required) @@ -174,6 +179,7 @@ def embedded_edit_url_with_http_info( "200": "EmbeddedEditUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -206,6 +212,8 @@ def embedded_edit_url_without_preload_content( Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedEditUrlExample.py + :param template_id: The id of the template to edit. (required) :type template_id: str :param embedded_edit_url_request: (required) @@ -245,6 +253,7 @@ def embedded_edit_url_without_preload_content( "200": "EmbeddedEditUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -362,6 +371,8 @@ def embedded_sign_url( Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedSignUrlExample.py + :param signature_id: The id of the signature to get a signature url for. (required) :type signature_id: str :param _request_timeout: timeout setting for this request. If one @@ -398,6 +409,7 @@ def embedded_sign_url( "200": "EmbeddedSignUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -430,6 +442,8 @@ def embedded_sign_url_with_http_info( Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedSignUrlExample.py + :param signature_id: The id of the signature to get a signature url for. (required) :type signature_id: str :param _request_timeout: timeout setting for this request. If one @@ -466,6 +480,7 @@ def embedded_sign_url_with_http_info( "200": "EmbeddedSignUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -498,6 +513,8 @@ def embedded_sign_url_without_preload_content( Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/EmbeddedSignUrlExample.py + :param signature_id: The id of the signature to get a signature url for. (required) :type signature_id: str :param _request_timeout: timeout setting for this request. If one @@ -534,6 +551,7 @@ def embedded_sign_url_without_preload_content( "200": "EmbeddedSignUrlResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/fax_api.py b/dropbox_sign/api/fax_api.py index abf615a..682b26e 100644 --- a/dropbox_sign/api/fax_api.py +++ b/dropbox_sign/api/fax_api.py @@ -62,6 +62,8 @@ def fax_delete( Deletes the specified Fax from the system + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxDeleteExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -98,6 +100,7 @@ def fax_delete( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -127,6 +130,8 @@ def fax_delete_with_http_info( Deletes the specified Fax from the system + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxDeleteExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -163,6 +168,7 @@ def fax_delete_with_http_info( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -192,6 +198,8 @@ def fax_delete_without_preload_content( Deletes the specified Fax from the system + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxDeleteExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -228,6 +236,7 @@ def fax_delete_without_preload_content( "204": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -307,6 +316,8 @@ def fax_files( Downloads files associated with a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxFilesExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -343,6 +354,7 @@ def fax_files( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -372,6 +384,8 @@ def fax_files_with_http_info( Downloads files associated with a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxFilesExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -408,6 +422,7 @@ def fax_files_with_http_info( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -437,6 +452,8 @@ def fax_files_without_preload_content( Downloads files associated with a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxFilesExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -473,6 +490,7 @@ def fax_files_without_preload_content( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -552,6 +570,8 @@ def fax_get( Returns information about a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxGetExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -588,6 +608,7 @@ def fax_get( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -617,6 +638,8 @@ def fax_get_with_http_info( Returns information about a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxGetExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -653,6 +676,7 @@ def fax_get_with_http_info( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -682,6 +706,8 @@ def fax_get_without_preload_content( Returns information about a Fax + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxGetExample.py + :param fax_id: Fax ID (required) :type fax_id: str :param _request_timeout: timeout setting for this request. If one @@ -718,6 +744,7 @@ def fax_get_without_preload_content( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -808,6 +835,8 @@ def fax_list( Returns properties of multiple Faxes + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxListExample.py + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -847,6 +876,7 @@ def fax_list( "200": "FaxListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -887,6 +917,8 @@ def fax_list_with_http_info( Returns properties of multiple Faxes + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxListExample.py + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -926,6 +958,7 @@ def fax_list_with_http_info( "200": "FaxListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -966,6 +999,8 @@ def fax_list_without_preload_content( Returns properties of multiple Faxes + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxListExample.py + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. @@ -1005,6 +1040,7 @@ def fax_list_without_preload_content( "200": "FaxListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1091,6 +1127,8 @@ def fax_send( Creates and sends a new Fax with the submitted file(s) + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxSendExample.py + :param fax_send_request: (required) :type fax_send_request: FaxSendRequest :param _request_timeout: timeout setting for this request. If one @@ -1127,6 +1165,7 @@ def fax_send( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1156,6 +1195,8 @@ def fax_send_with_http_info( Creates and sends a new Fax with the submitted file(s) + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxSendExample.py + :param fax_send_request: (required) :type fax_send_request: FaxSendRequest :param _request_timeout: timeout setting for this request. If one @@ -1192,6 +1233,7 @@ def fax_send_with_http_info( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1221,6 +1263,8 @@ def fax_send_without_preload_content( Creates and sends a new Fax with the submitted file(s) + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxSendExample.py + :param fax_send_request: (required) :type fax_send_request: FaxSendRequest :param _request_timeout: timeout setting for this request. If one @@ -1257,6 +1301,7 @@ def fax_send_without_preload_content( "200": "FaxGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/fax_line_api.py b/dropbox_sign/api/fax_line_api.py index c3ceff1..f752698 100644 --- a/dropbox_sign/api/fax_line_api.py +++ b/dropbox_sign/api/fax_line_api.py @@ -68,6 +68,8 @@ def fax_line_add_user( Grants a user access to the specified Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAddUserExample.py + :param fax_line_add_user_request: (required) :type fax_line_add_user_request: FaxLineAddUserRequest :param _request_timeout: timeout setting for this request. If one @@ -104,6 +106,7 @@ def fax_line_add_user( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -133,6 +136,8 @@ def fax_line_add_user_with_http_info( Grants a user access to the specified Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAddUserExample.py + :param fax_line_add_user_request: (required) :type fax_line_add_user_request: FaxLineAddUserRequest :param _request_timeout: timeout setting for this request. If one @@ -169,6 +174,7 @@ def fax_line_add_user_with_http_info( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -198,6 +204,8 @@ def fax_line_add_user_without_preload_content( Grants a user access to the specified Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAddUserExample.py + :param fax_line_add_user_request: (required) :type fax_line_add_user_request: FaxLineAddUserRequest :param _request_timeout: timeout setting for this request. If one @@ -234,6 +242,7 @@ def fax_line_add_user_without_preload_content( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -356,6 +365,8 @@ def fax_line_area_code_get( Returns a list of available area codes for a given state/province and city + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAreaCodeGetExample.py + :param country: Filter area codes by country (required) :type country: str :param state: Filter area codes by state @@ -401,6 +412,7 @@ def fax_line_area_code_get( "200": "FaxLineAreaCodeGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -441,6 +453,8 @@ def fax_line_area_code_get_with_http_info( Returns a list of available area codes for a given state/province and city + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAreaCodeGetExample.py + :param country: Filter area codes by country (required) :type country: str :param state: Filter area codes by state @@ -486,6 +500,7 @@ def fax_line_area_code_get_with_http_info( "200": "FaxLineAreaCodeGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -526,6 +541,8 @@ def fax_line_area_code_get_without_preload_content( Returns a list of available area codes for a given state/province and city + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineAreaCodeGetExample.py + :param country: Filter area codes by country (required) :type country: str :param state: Filter area codes by state @@ -571,6 +588,7 @@ def fax_line_area_code_get_without_preload_content( "200": "FaxLineAreaCodeGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -667,6 +685,8 @@ def fax_line_create( Purchases a new Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineCreateExample.py + :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -703,6 +723,7 @@ def fax_line_create( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -732,6 +753,8 @@ def fax_line_create_with_http_info( Purchases a new Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineCreateExample.py + :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -768,6 +791,7 @@ def fax_line_create_with_http_info( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -797,6 +821,8 @@ def fax_line_create_without_preload_content( Purchases a new Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineCreateExample.py + :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -833,6 +859,7 @@ def fax_line_create_without_preload_content( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -944,6 +971,8 @@ def fax_line_delete( Deletes the specified Fax Line from the subscription. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineDeleteExample.py + :param fax_line_delete_request: (required) :type fax_line_delete_request: FaxLineDeleteRequest :param _request_timeout: timeout setting for this request. If one @@ -980,6 +1009,7 @@ def fax_line_delete( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1009,6 +1039,8 @@ def fax_line_delete_with_http_info( Deletes the specified Fax Line from the subscription. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineDeleteExample.py + :param fax_line_delete_request: (required) :type fax_line_delete_request: FaxLineDeleteRequest :param _request_timeout: timeout setting for this request. If one @@ -1045,6 +1077,7 @@ def fax_line_delete_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1074,6 +1107,8 @@ def fax_line_delete_without_preload_content( Deletes the specified Fax Line from the subscription. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineDeleteExample.py + :param fax_line_delete_request: (required) :type fax_line_delete_request: FaxLineDeleteRequest :param _request_timeout: timeout setting for this request. If one @@ -1110,6 +1145,7 @@ def fax_line_delete_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1221,6 +1257,8 @@ def fax_line_get( Returns the properties and settings of a Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineGetExample.py + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one @@ -1257,6 +1295,7 @@ def fax_line_get( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1286,6 +1325,8 @@ def fax_line_get_with_http_info( Returns the properties and settings of a Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineGetExample.py + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one @@ -1322,6 +1363,7 @@ def fax_line_get_with_http_info( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1351,6 +1393,8 @@ def fax_line_get_without_preload_content( Returns the properties and settings of a Fax Line. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineGetExample.py + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one @@ -1387,6 +1431,7 @@ def fax_line_get_without_preload_content( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1488,6 +1533,8 @@ def fax_line_list( Returns the properties and settings of multiple Fax Lines. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineListExample.py + :param account_id: Account ID :type account_id: str :param page: Which page number of the Fax Line List to return. Defaults to `1`. @@ -1533,6 +1580,7 @@ def fax_line_list( "200": "FaxLineListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1582,6 +1630,8 @@ def fax_line_list_with_http_info( Returns the properties and settings of multiple Fax Lines. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineListExample.py + :param account_id: Account ID :type account_id: str :param page: Which page number of the Fax Line List to return. Defaults to `1`. @@ -1627,6 +1677,7 @@ def fax_line_list_with_http_info( "200": "FaxLineListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1676,6 +1727,8 @@ def fax_line_list_without_preload_content( Returns the properties and settings of multiple Fax Lines. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineListExample.py + :param account_id: Account ID :type account_id: str :param page: Which page number of the Fax Line List to return. Defaults to `1`. @@ -1721,6 +1774,7 @@ def fax_line_list_without_preload_content( "200": "FaxLineListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1817,6 +1871,8 @@ def fax_line_remove_user( Removes a user's access to the specified Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineRemoveUserExample.py + :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest :param _request_timeout: timeout setting for this request. If one @@ -1853,6 +1909,7 @@ def fax_line_remove_user( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1882,6 +1939,8 @@ def fax_line_remove_user_with_http_info( Removes a user's access to the specified Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineRemoveUserExample.py + :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest :param _request_timeout: timeout setting for this request. If one @@ -1918,6 +1977,7 @@ def fax_line_remove_user_with_http_info( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1947,6 +2007,8 @@ def fax_line_remove_user_without_preload_content( Removes a user's access to the specified Fax Line + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/FaxLineRemoveUserExample.py + :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest :param _request_timeout: timeout setting for this request. If one @@ -1983,6 +2045,7 @@ def fax_line_remove_user_without_preload_content( "200": "FaxLineResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/o_auth_api.py b/dropbox_sign/api/o_auth_api.py index 6ea59b5..c173208 100644 --- a/dropbox_sign/api/o_auth_api.py +++ b/dropbox_sign/api/o_auth_api.py @@ -59,6 +59,8 @@ def oauth_token_generate( Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenGenerateExample.py + :param o_auth_token_generate_request: (required) :type o_auth_token_generate_request: OAuthTokenGenerateRequest :param _request_timeout: timeout setting for this request. If one @@ -95,6 +97,7 @@ def oauth_token_generate( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -124,6 +127,8 @@ def oauth_token_generate_with_http_info( Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenGenerateExample.py + :param o_auth_token_generate_request: (required) :type o_auth_token_generate_request: OAuthTokenGenerateRequest :param _request_timeout: timeout setting for this request. If one @@ -160,6 +165,7 @@ def oauth_token_generate_with_http_info( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -189,6 +195,8 @@ def oauth_token_generate_without_preload_content( Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenGenerateExample.py + :param o_auth_token_generate_request: (required) :type o_auth_token_generate_request: OAuthTokenGenerateRequest :param _request_timeout: timeout setting for this request. If one @@ -225,6 +233,7 @@ def oauth_token_generate_without_preload_content( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -337,6 +346,8 @@ def oauth_token_refresh( Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenRefreshExample.py + :param o_auth_token_refresh_request: (required) :type o_auth_token_refresh_request: OAuthTokenRefreshRequest :param _request_timeout: timeout setting for this request. If one @@ -373,6 +384,7 @@ def oauth_token_refresh( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -402,6 +414,8 @@ def oauth_token_refresh_with_http_info( Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenRefreshExample.py + :param o_auth_token_refresh_request: (required) :type o_auth_token_refresh_request: OAuthTokenRefreshRequest :param _request_timeout: timeout setting for this request. If one @@ -438,6 +452,7 @@ def oauth_token_refresh_with_http_info( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -467,6 +482,8 @@ def oauth_token_refresh_without_preload_content( Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/OauthTokenRefreshExample.py + :param o_auth_token_refresh_request: (required) :type o_auth_token_refresh_request: OAuthTokenRefreshRequest :param _request_timeout: timeout setting for this request. If one @@ -503,6 +520,7 @@ def oauth_token_refresh_without_preload_content( "200": "OAuthTokenResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/report_api.py b/dropbox_sign/api/report_api.py index f739dcb..38b120b 100644 --- a/dropbox_sign/api/report_api.py +++ b/dropbox_sign/api/report_api.py @@ -58,6 +58,8 @@ def report_create( Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ReportCreateExample.py + :param report_create_request: (required) :type report_create_request: ReportCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -94,6 +96,7 @@ def report_create( "200": "ReportCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -123,6 +126,8 @@ def report_create_with_http_info( Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ReportCreateExample.py + :param report_create_request: (required) :type report_create_request: ReportCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -159,6 +164,7 @@ def report_create_with_http_info( "200": "ReportCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -188,6 +194,8 @@ def report_create_without_preload_content( Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/ReportCreateExample.py + :param report_create_request: (required) :type report_create_request: ReportCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -224,6 +232,7 @@ def report_create_without_preload_content( "200": "ReportCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/signature_request_api.py b/dropbox_sign/api/signature_request_api.py index e7c1dc4..77f3c71 100644 --- a/dropbox_sign/api/signature_request_api.py +++ b/dropbox_sign/api/signature_request_api.py @@ -104,6 +104,8 @@ def signature_request_bulk_create_embedded_with_template( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py + :param signature_request_bulk_create_embedded_with_template_request: (required) :type signature_request_bulk_create_embedded_with_template_request: SignatureRequestBulkCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -140,6 +142,7 @@ def signature_request_bulk_create_embedded_with_template( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -169,6 +172,8 @@ def signature_request_bulk_create_embedded_with_template_with_http_info( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py + :param signature_request_bulk_create_embedded_with_template_request: (required) :type signature_request_bulk_create_embedded_with_template_request: SignatureRequestBulkCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -205,6 +210,7 @@ def signature_request_bulk_create_embedded_with_template_with_http_info( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -234,6 +240,8 @@ def signature_request_bulk_create_embedded_with_template_without_preload_content Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py + :param signature_request_bulk_create_embedded_with_template_request: (required) :type signature_request_bulk_create_embedded_with_template_request: SignatureRequestBulkCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -270,6 +278,7 @@ def signature_request_bulk_create_embedded_with_template_without_preload_content "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -384,6 +393,8 @@ def signature_request_bulk_send_with_template( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.py + :param signature_request_bulk_send_with_template_request: (required) :type signature_request_bulk_send_with_template_request: SignatureRequestBulkSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -420,6 +431,7 @@ def signature_request_bulk_send_with_template( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -449,6 +461,8 @@ def signature_request_bulk_send_with_template_with_http_info( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.py + :param signature_request_bulk_send_with_template_request: (required) :type signature_request_bulk_send_with_template_request: SignatureRequestBulkSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -485,6 +499,7 @@ def signature_request_bulk_send_with_template_with_http_info( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -514,6 +529,8 @@ def signature_request_bulk_send_with_template_without_preload_content( Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.py + :param signature_request_bulk_send_with_template_request: (required) :type signature_request_bulk_send_with_template_request: SignatureRequestBulkSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -550,6 +567,7 @@ def signature_request_bulk_send_with_template_without_preload_content( "200": "BulkSendJobSendResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -667,6 +685,8 @@ def signature_request_cancel( Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCancelExample.py + :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -703,6 +723,7 @@ def signature_request_cancel( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -735,6 +756,8 @@ def signature_request_cancel_with_http_info( Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCancelExample.py + :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -771,6 +794,7 @@ def signature_request_cancel_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -803,6 +827,8 @@ def signature_request_cancel_without_preload_content( Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCancelExample.py + :param signature_request_id: The id of the incomplete SignatureRequest to cancel. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -839,6 +865,7 @@ def signature_request_cancel_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -918,6 +945,8 @@ def signature_request_create_embedded( Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedExample.py + :param signature_request_create_embedded_request: (required) :type signature_request_create_embedded_request: SignatureRequestCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -954,6 +983,7 @@ def signature_request_create_embedded( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -983,6 +1013,8 @@ def signature_request_create_embedded_with_http_info( Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedExample.py + :param signature_request_create_embedded_request: (required) :type signature_request_create_embedded_request: SignatureRequestCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -1019,6 +1051,7 @@ def signature_request_create_embedded_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1048,6 +1081,8 @@ def signature_request_create_embedded_without_preload_content( Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedExample.py + :param signature_request_create_embedded_request: (required) :type signature_request_create_embedded_request: SignatureRequestCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -1084,6 +1119,7 @@ def signature_request_create_embedded_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1195,6 +1231,8 @@ def signature_request_create_embedded_with_template( Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py + :param signature_request_create_embedded_with_template_request: (required) :type signature_request_create_embedded_with_template_request: SignatureRequestCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -1231,6 +1269,7 @@ def signature_request_create_embedded_with_template( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1260,6 +1299,8 @@ def signature_request_create_embedded_with_template_with_http_info( Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py + :param signature_request_create_embedded_with_template_request: (required) :type signature_request_create_embedded_with_template_request: SignatureRequestCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -1296,6 +1337,7 @@ def signature_request_create_embedded_with_template_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1325,6 +1367,8 @@ def signature_request_create_embedded_with_template_without_preload_content( Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py + :param signature_request_create_embedded_with_template_request: (required) :type signature_request_create_embedded_with_template_request: SignatureRequestCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -1361,6 +1405,7 @@ def signature_request_create_embedded_with_template_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1478,6 +1523,8 @@ def signature_request_edit( Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_request: (required) @@ -1517,6 +1564,7 @@ def signature_request_edit( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1549,6 +1597,8 @@ def signature_request_edit_with_http_info( Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_request: (required) @@ -1588,6 +1638,7 @@ def signature_request_edit_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1620,6 +1671,8 @@ def signature_request_edit_without_preload_content( Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_request: (required) @@ -1659,6 +1712,7 @@ def signature_request_edit_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1776,6 +1830,8 @@ def signature_request_edit_embedded( Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_request: (required) @@ -1815,6 +1871,7 @@ def signature_request_edit_embedded( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1847,6 +1904,8 @@ def signature_request_edit_embedded_with_http_info( Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_request: (required) @@ -1886,6 +1945,7 @@ def signature_request_edit_embedded_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1918,6 +1978,8 @@ def signature_request_edit_embedded_without_preload_content( Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_request: (required) @@ -1957,6 +2019,7 @@ def signature_request_edit_embedded_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2074,6 +2137,8 @@ def signature_request_edit_embedded_with_template( Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_with_template_request: (required) @@ -2113,6 +2178,7 @@ def signature_request_edit_embedded_with_template( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2145,6 +2211,8 @@ def signature_request_edit_embedded_with_template_with_http_info( Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_with_template_request: (required) @@ -2184,6 +2252,7 @@ def signature_request_edit_embedded_with_template_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2216,6 +2285,8 @@ def signature_request_edit_embedded_with_template_without_preload_content( Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_embedded_with_template_request: (required) @@ -2255,6 +2326,7 @@ def signature_request_edit_embedded_with_template_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2375,6 +2447,8 @@ def signature_request_edit_with_template( Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_with_template_request: (required) @@ -2414,6 +2488,7 @@ def signature_request_edit_with_template( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2446,6 +2521,8 @@ def signature_request_edit_with_template_with_http_info( Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_with_template_request: (required) @@ -2485,6 +2562,7 @@ def signature_request_edit_with_template_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2517,6 +2595,8 @@ def signature_request_edit_with_template_without_preload_content( Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestEditWithTemplateExample.py + :param signature_request_id: The id of the SignatureRequest to edit. (required) :type signature_request_id: str :param signature_request_edit_with_template_request: (required) @@ -2556,6 +2636,7 @@ def signature_request_edit_with_template_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2681,6 +2762,8 @@ def signature_request_files( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -2720,6 +2803,7 @@ def signature_request_files( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2757,6 +2841,8 @@ def signature_request_files_with_http_info( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -2796,6 +2882,7 @@ def signature_request_files_with_http_info( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2833,6 +2920,8 @@ def signature_request_files_without_preload_content( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -2872,6 +2961,7 @@ def signature_request_files_without_preload_content( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2958,6 +3048,8 @@ def signature_request_files_as_data_uri( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsDataUriExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -2994,6 +3086,7 @@ def signature_request_files_as_data_uri( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3025,6 +3118,8 @@ def signature_request_files_as_data_uri_with_http_info( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsDataUriExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3061,6 +3156,7 @@ def signature_request_files_as_data_uri_with_http_info( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3092,6 +3188,8 @@ def signature_request_files_as_data_uri_without_preload_content( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsDataUriExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3128,6 +3226,7 @@ def signature_request_files_as_data_uri_without_preload_content( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3215,6 +3314,8 @@ def signature_request_files_as_file_url( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsFileUrlExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -3254,6 +3355,7 @@ def signature_request_files_as_file_url( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3291,6 +3393,8 @@ def signature_request_files_as_file_url_with_http_info( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsFileUrlExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -3330,6 +3434,7 @@ def signature_request_files_as_file_url_with_http_info( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3367,6 +3472,8 @@ def signature_request_files_as_file_url_without_preload_content( Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestFilesAsFileUrlExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -3406,6 +3513,7 @@ def signature_request_files_as_file_url_without_preload_content( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3492,6 +3600,8 @@ def signature_request_get( Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestGetExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3528,6 +3638,7 @@ def signature_request_get( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3559,6 +3670,8 @@ def signature_request_get_with_http_info( Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestGetExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3595,6 +3708,7 @@ def signature_request_get_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3626,6 +3740,8 @@ def signature_request_get_without_preload_content( Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestGetExample.py + :param signature_request_id: The id of the SignatureRequest to retrieve. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -3662,6 +3778,7 @@ def signature_request_get_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3764,6 +3881,8 @@ def signature_request_list( Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestListExample.py + :param account_id: Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the SignatureRequest List to return. Defaults to `1`. @@ -3809,6 +3928,7 @@ def signature_request_list( "200": "SignatureRequestListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3861,6 +3981,8 @@ def signature_request_list_with_http_info( Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestListExample.py + :param account_id: Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the SignatureRequest List to return. Defaults to `1`. @@ -3906,6 +4028,7 @@ def signature_request_list_with_http_info( "200": "SignatureRequestListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3958,6 +4081,8 @@ def signature_request_list_without_preload_content( Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestListExample.py + :param account_id: Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the SignatureRequest List to return. Defaults to `1`. @@ -4003,6 +4128,7 @@ def signature_request_list_without_preload_content( "200": "SignatureRequestListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4101,6 +4227,8 @@ def signature_request_release_hold( Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestReleaseHoldExample.py + :param signature_request_id: The id of the SignatureRequest to release. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4137,6 +4265,7 @@ def signature_request_release_hold( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4168,6 +4297,8 @@ def signature_request_release_hold_with_http_info( Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestReleaseHoldExample.py + :param signature_request_id: The id of the SignatureRequest to release. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4204,6 +4335,7 @@ def signature_request_release_hold_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4235,6 +4367,8 @@ def signature_request_release_hold_without_preload_content( Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestReleaseHoldExample.py + :param signature_request_id: The id of the SignatureRequest to release. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4271,6 +4405,7 @@ def signature_request_release_hold_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4354,6 +4489,8 @@ def signature_request_remind( Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemindExample.py + :param signature_request_id: The id of the SignatureRequest to send a reminder for. (required) :type signature_request_id: str :param signature_request_remind_request: (required) @@ -4393,6 +4530,7 @@ def signature_request_remind( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4426,6 +4564,8 @@ def signature_request_remind_with_http_info( Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemindExample.py + :param signature_request_id: The id of the SignatureRequest to send a reminder for. (required) :type signature_request_id: str :param signature_request_remind_request: (required) @@ -4465,6 +4605,7 @@ def signature_request_remind_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4498,6 +4639,8 @@ def signature_request_remind_without_preload_content( Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemindExample.py + :param signature_request_id: The id of the SignatureRequest to send a reminder for. (required) :type signature_request_id: str :param signature_request_remind_request: (required) @@ -4537,6 +4680,7 @@ def signature_request_remind_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4653,6 +4797,8 @@ def signature_request_remove( Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemoveExample.py + :param signature_request_id: The id of the SignatureRequest to remove. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4689,6 +4835,7 @@ def signature_request_remove( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4720,6 +4867,8 @@ def signature_request_remove_with_http_info( Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemoveExample.py + :param signature_request_id: The id of the SignatureRequest to remove. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4756,6 +4905,7 @@ def signature_request_remove_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4787,6 +4937,8 @@ def signature_request_remove_without_preload_content( Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestRemoveExample.py + :param signature_request_id: The id of the SignatureRequest to remove. (required) :type signature_request_id: str :param _request_timeout: timeout setting for this request. If one @@ -4823,6 +4975,7 @@ def signature_request_remove_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4902,6 +5055,8 @@ def signature_request_send( Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendExample.py + :param signature_request_send_request: (required) :type signature_request_send_request: SignatureRequestSendRequest :param _request_timeout: timeout setting for this request. If one @@ -4938,6 +5093,7 @@ def signature_request_send( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -4967,6 +5123,8 @@ def signature_request_send_with_http_info( Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendExample.py + :param signature_request_send_request: (required) :type signature_request_send_request: SignatureRequestSendRequest :param _request_timeout: timeout setting for this request. If one @@ -5003,6 +5161,7 @@ def signature_request_send_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5032,6 +5191,8 @@ def signature_request_send_without_preload_content( Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendExample.py + :param signature_request_send_request: (required) :type signature_request_send_request: SignatureRequestSendRequest :param _request_timeout: timeout setting for this request. If one @@ -5068,6 +5229,7 @@ def signature_request_send_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5179,6 +5341,8 @@ def signature_request_send_with_template( Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendWithTemplateExample.py + :param signature_request_send_with_template_request: (required) :type signature_request_send_with_template_request: SignatureRequestSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -5215,6 +5379,7 @@ def signature_request_send_with_template( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5244,6 +5409,8 @@ def signature_request_send_with_template_with_http_info( Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendWithTemplateExample.py + :param signature_request_send_with_template_request: (required) :type signature_request_send_with_template_request: SignatureRequestSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -5280,6 +5447,7 @@ def signature_request_send_with_template_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5309,6 +5477,8 @@ def signature_request_send_with_template_without_preload_content( Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestSendWithTemplateExample.py + :param signature_request_send_with_template_request: (required) :type signature_request_send_with_template_request: SignatureRequestSendWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -5345,6 +5515,7 @@ def signature_request_send_with_template_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5462,6 +5633,8 @@ def signature_request_update( Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestUpdateExample.py + :param signature_request_id: The id of the SignatureRequest to update. (required) :type signature_request_id: str :param signature_request_update_request: (required) @@ -5501,6 +5674,7 @@ def signature_request_update( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5533,6 +5707,8 @@ def signature_request_update_with_http_info( Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestUpdateExample.py + :param signature_request_id: The id of the SignatureRequest to update. (required) :type signature_request_id: str :param signature_request_update_request: (required) @@ -5572,6 +5748,7 @@ def signature_request_update_with_http_info( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -5604,6 +5781,8 @@ def signature_request_update_without_preload_content( Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/SignatureRequestUpdateExample.py + :param signature_request_id: The id of the SignatureRequest to update. (required) :type signature_request_id: str :param signature_request_update_request: (required) @@ -5643,6 +5822,7 @@ def signature_request_update_without_preload_content( "200": "SignatureRequestGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/team_api.py b/dropbox_sign/api/team_api.py index f59cf5e..db6adcc 100644 --- a/dropbox_sign/api/team_api.py +++ b/dropbox_sign/api/team_api.py @@ -71,6 +71,8 @@ def team_add_member( Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamAddMemberExample.py + :param team_add_member_request: (required) :type team_add_member_request: TeamAddMemberRequest :param team_id: The id of the team. @@ -110,6 +112,7 @@ def team_add_member( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -142,6 +145,8 @@ def team_add_member_with_http_info( Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamAddMemberExample.py + :param team_add_member_request: (required) :type team_add_member_request: TeamAddMemberRequest :param team_id: The id of the team. @@ -181,6 +186,7 @@ def team_add_member_with_http_info( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -213,6 +219,8 @@ def team_add_member_without_preload_content( Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamAddMemberExample.py + :param team_add_member_request: (required) :type team_add_member_request: TeamAddMemberRequest :param team_id: The id of the team. @@ -252,6 +260,7 @@ def team_add_member_without_preload_content( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -368,6 +377,8 @@ def team_create( Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamCreateExample.py + :param team_create_request: (required) :type team_create_request: TeamCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -404,6 +415,7 @@ def team_create( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -433,6 +445,8 @@ def team_create_with_http_info( Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamCreateExample.py + :param team_create_request: (required) :type team_create_request: TeamCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -469,6 +483,7 @@ def team_create_with_http_info( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -498,6 +513,8 @@ def team_create_without_preload_content( Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamCreateExample.py + :param team_create_request: (required) :type team_create_request: TeamCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -534,6 +551,7 @@ def team_create_without_preload_content( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -644,6 +662,8 @@ def team_delete( Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamDeleteExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -677,6 +697,7 @@ def team_delete( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -705,6 +726,8 @@ def team_delete_with_http_info( Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamDeleteExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -738,6 +761,7 @@ def team_delete_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -766,6 +790,8 @@ def team_delete_without_preload_content( Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamDeleteExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -799,6 +825,7 @@ def team_delete_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -874,6 +901,8 @@ def team_get( Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamGetExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -907,6 +936,7 @@ def team_get( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -935,6 +965,8 @@ def team_get_with_http_info( Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamGetExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -968,6 +1000,7 @@ def team_get_with_http_info( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -996,6 +1029,8 @@ def team_get_without_preload_content( Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamGetExample.py + :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1029,6 +1064,7 @@ def team_get_without_preload_content( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1107,6 +1143,8 @@ def team_info( Provides information about a team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInfoExample.py + :param team_id: The id of the team. :type team_id: str :param _request_timeout: timeout setting for this request. If one @@ -1143,6 +1181,7 @@ def team_info( "200": "TeamGetInfoResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1174,6 +1213,8 @@ def team_info_with_http_info( Provides information about a team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInfoExample.py + :param team_id: The id of the team. :type team_id: str :param _request_timeout: timeout setting for this request. If one @@ -1210,6 +1251,7 @@ def team_info_with_http_info( "200": "TeamGetInfoResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1241,6 +1283,8 @@ def team_info_without_preload_content( Provides information about a team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInfoExample.py + :param team_id: The id of the team. :type team_id: str :param _request_timeout: timeout setting for this request. If one @@ -1277,6 +1321,7 @@ def team_info_without_preload_content( "200": "TeamGetInfoResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1363,6 +1408,8 @@ def team_invites( Provides a list of team invites (and their roles). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInvitesExample.py + :param email_address: The email address for which to display the team invites. :type email_address: str :param _request_timeout: timeout setting for this request. If one @@ -1399,6 +1446,7 @@ def team_invites( "200": "TeamInvitesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1433,6 +1481,8 @@ def team_invites_with_http_info( Provides a list of team invites (and their roles). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInvitesExample.py + :param email_address: The email address for which to display the team invites. :type email_address: str :param _request_timeout: timeout setting for this request. If one @@ -1469,6 +1519,7 @@ def team_invites_with_http_info( "200": "TeamInvitesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1503,6 +1554,8 @@ def team_invites_without_preload_content( Provides a list of team invites (and their roles). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamInvitesExample.py + :param email_address: The email address for which to display the team invites. :type email_address: str :param _request_timeout: timeout setting for this request. If one @@ -1539,6 +1592,7 @@ def team_invites_without_preload_content( "200": "TeamInvitesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1637,6 +1691,8 @@ def team_members( Provides a paginated list of members (and their roles) that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamMembersExample.py + :param team_id: The id of the team that a member list is being requested from. (required) :type team_id: str :param page: Which page number of the team member list to return. Defaults to `1`. @@ -1679,6 +1735,7 @@ def team_members( "200": "TeamMembersResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1725,6 +1782,8 @@ def team_members_with_http_info( Provides a paginated list of members (and their roles) that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamMembersExample.py + :param team_id: The id of the team that a member list is being requested from. (required) :type team_id: str :param page: Which page number of the team member list to return. Defaults to `1`. @@ -1767,6 +1826,7 @@ def team_members_with_http_info( "200": "TeamMembersResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1813,6 +1873,8 @@ def team_members_without_preload_content( Provides a paginated list of members (and their roles) that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamMembersExample.py + :param team_id: The id of the team that a member list is being requested from. (required) :type team_id: str :param page: Which page number of the team member list to return. Defaults to `1`. @@ -1855,6 +1917,7 @@ def team_members_without_preload_content( "200": "TeamMembersResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1944,6 +2007,8 @@ def team_remove_member( Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamRemoveMemberExample.py + :param team_remove_member_request: (required) :type team_remove_member_request: TeamRemoveMemberRequest :param _request_timeout: timeout setting for this request. If one @@ -1980,6 +2045,7 @@ def team_remove_member( "201": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2009,6 +2075,8 @@ def team_remove_member_with_http_info( Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamRemoveMemberExample.py + :param team_remove_member_request: (required) :type team_remove_member_request: TeamRemoveMemberRequest :param _request_timeout: timeout setting for this request. If one @@ -2045,6 +2113,7 @@ def team_remove_member_with_http_info( "201": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2074,6 +2143,8 @@ def team_remove_member_without_preload_content( Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamRemoveMemberExample.py + :param team_remove_member_request: (required) :type team_remove_member_request: TeamRemoveMemberRequest :param _request_timeout: timeout setting for this request. If one @@ -2110,6 +2181,7 @@ def team_remove_member_without_preload_content( "201": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2233,6 +2305,8 @@ def team_sub_teams( Provides a paginated list of sub teams that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamSubTeamsExample.py + :param team_id: The id of the parent Team. (required) :type team_id: str :param page: Which page number of the SubTeam List to return. Defaults to `1`. @@ -2275,6 +2349,7 @@ def team_sub_teams( "200": "TeamSubTeamsResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2316,6 +2391,8 @@ def team_sub_teams_with_http_info( Provides a paginated list of sub teams that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamSubTeamsExample.py + :param team_id: The id of the parent Team. (required) :type team_id: str :param page: Which page number of the SubTeam List to return. Defaults to `1`. @@ -2358,6 +2435,7 @@ def team_sub_teams_with_http_info( "200": "TeamSubTeamsResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2399,6 +2477,8 @@ def team_sub_teams_without_preload_content( Provides a paginated list of sub teams that belong to a given team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamSubTeamsExample.py + :param team_id: The id of the parent Team. (required) :type team_id: str :param page: Which page number of the SubTeam List to return. Defaults to `1`. @@ -2441,6 +2521,7 @@ def team_sub_teams_without_preload_content( "200": "TeamSubTeamsResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2530,6 +2611,8 @@ def team_update( Updates the name of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamUpdateExample.py + :param team_update_request: (required) :type team_update_request: TeamUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -2566,6 +2649,7 @@ def team_update( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2595,6 +2679,8 @@ def team_update_with_http_info( Updates the name of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamUpdateExample.py + :param team_update_request: (required) :type team_update_request: TeamUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -2631,6 +2717,7 @@ def team_update_with_http_info( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2660,6 +2747,8 @@ def team_update_without_preload_content( Updates the name of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TeamUpdateExample.py + :param team_update_request: (required) :type team_update_request: TeamUpdateRequest :param _request_timeout: timeout setting for this request. If one @@ -2696,6 +2785,7 @@ def team_update_without_preload_content( "200": "TeamGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/template_api.py b/dropbox_sign/api/template_api.py index 7234889..4ae3b44 100644 --- a/dropbox_sign/api/template_api.py +++ b/dropbox_sign/api/template_api.py @@ -81,6 +81,8 @@ def template_add_user( Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateAddUserExample.py + :param template_id: The id of the Template to give the Account access to. (required) :type template_id: str :param template_add_user_request: (required) @@ -120,6 +122,7 @@ def template_add_user( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -153,6 +156,8 @@ def template_add_user_with_http_info( Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateAddUserExample.py + :param template_id: The id of the Template to give the Account access to. (required) :type template_id: str :param template_add_user_request: (required) @@ -192,6 +197,7 @@ def template_add_user_with_http_info( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -225,6 +231,8 @@ def template_add_user_without_preload_content( Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateAddUserExample.py + :param template_id: The id of the Template to give the Account access to. (required) :type template_id: str :param template_add_user_request: (required) @@ -264,6 +272,7 @@ def template_add_user_without_preload_content( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -378,6 +387,8 @@ def template_create( Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateExample.py + :param template_create_request: (required) :type template_create_request: TemplateCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -414,6 +425,7 @@ def template_create( "200": "TemplateCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -443,6 +455,8 @@ def template_create_with_http_info( Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateExample.py + :param template_create_request: (required) :type template_create_request: TemplateCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -479,6 +493,7 @@ def template_create_with_http_info( "200": "TemplateCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -508,6 +523,8 @@ def template_create_without_preload_content( Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateExample.py + :param template_create_request: (required) :type template_create_request: TemplateCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -544,6 +561,7 @@ def template_create_without_preload_content( "200": "TemplateCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -655,6 +673,8 @@ def template_create_embedded_draft( The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateEmbeddedDraftExample.py + :param template_create_embedded_draft_request: (required) :type template_create_embedded_draft_request: TemplateCreateEmbeddedDraftRequest :param _request_timeout: timeout setting for this request. If one @@ -691,6 +711,7 @@ def template_create_embedded_draft( "200": "TemplateCreateEmbeddedDraftResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -720,6 +741,8 @@ def template_create_embedded_draft_with_http_info( The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateEmbeddedDraftExample.py + :param template_create_embedded_draft_request: (required) :type template_create_embedded_draft_request: TemplateCreateEmbeddedDraftRequest :param _request_timeout: timeout setting for this request. If one @@ -756,6 +779,7 @@ def template_create_embedded_draft_with_http_info( "200": "TemplateCreateEmbeddedDraftResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -785,6 +809,8 @@ def template_create_embedded_draft_without_preload_content( The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateCreateEmbeddedDraftExample.py + :param template_create_embedded_draft_request: (required) :type template_create_embedded_draft_request: TemplateCreateEmbeddedDraftRequest :param _request_timeout: timeout setting for this request. If one @@ -821,6 +847,7 @@ def template_create_embedded_draft_without_preload_content( "200": "TemplateCreateEmbeddedDraftResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -934,6 +961,8 @@ def template_delete( Completely deletes the template specified from the account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateDeleteExample.py + :param template_id: The id of the Template to delete. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -970,6 +999,7 @@ def template_delete( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1001,6 +1031,8 @@ def template_delete_with_http_info( Completely deletes the template specified from the account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateDeleteExample.py + :param template_id: The id of the Template to delete. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1037,6 +1069,7 @@ def template_delete_with_http_info( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1068,6 +1101,8 @@ def template_delete_without_preload_content( Completely deletes the template specified from the account. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateDeleteExample.py + :param template_id: The id of the Template to delete. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1104,6 +1139,7 @@ def template_delete_without_preload_content( "200": None, "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1191,6 +1227,8 @@ def template_files( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -1230,6 +1268,7 @@ def template_files( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1267,6 +1306,8 @@ def template_files_with_http_info( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -1306,6 +1347,7 @@ def template_files_with_http_info( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1343,6 +1385,8 @@ def template_files_without_preload_content( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param file_type: Set to `pdf` for a single merged document or `zip` for a collection of individual documents. @@ -1382,6 +1426,7 @@ def template_files_without_preload_content( "200": "io.IOBase", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1468,6 +1513,8 @@ def template_files_as_data_uri( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsDataUriExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1504,6 +1551,7 @@ def template_files_as_data_uri( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1535,6 +1583,8 @@ def template_files_as_data_uri_with_http_info( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsDataUriExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1571,6 +1621,7 @@ def template_files_as_data_uri_with_http_info( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1602,6 +1653,8 @@ def template_files_as_data_uri_without_preload_content( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsDataUriExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -1638,6 +1691,7 @@ def template_files_as_data_uri_without_preload_content( "200": "FileResponseDataUri", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1725,6 +1779,8 @@ def template_files_as_file_url( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsFileUrlExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -1764,6 +1820,7 @@ def template_files_as_file_url( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1801,6 +1858,8 @@ def template_files_as_file_url_with_http_info( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsFileUrlExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -1840,6 +1899,7 @@ def template_files_as_file_url_with_http_info( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1877,6 +1937,8 @@ def template_files_as_file_url_without_preload_content( Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateFilesAsFileUrlExample.py + :param template_id: The id of the template files to retrieve. (required) :type template_id: str :param force_download: By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. @@ -1916,6 +1978,7 @@ def template_files_as_file_url_without_preload_content( "200": "FileResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2002,6 +2065,8 @@ def template_get( Returns the Template specified by the `template_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateGetExample.py + :param template_id: The id of the Template to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -2038,6 +2103,7 @@ def template_get( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2069,6 +2135,8 @@ def template_get_with_http_info( Returns the Template specified by the `template_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateGetExample.py + :param template_id: The id of the Template to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -2105,6 +2173,7 @@ def template_get_with_http_info( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2136,6 +2205,8 @@ def template_get_without_preload_content( Returns the Template specified by the `template_id` parameter. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateGetExample.py + :param template_id: The id of the Template to retrieve. (required) :type template_id: str :param _request_timeout: timeout setting for this request. If one @@ -2172,6 +2243,7 @@ def template_get_without_preload_content( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2274,6 +2346,8 @@ def template_list( Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateListExample.py + :param account_id: Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the Template List to return. Defaults to `1`. @@ -2319,6 +2393,7 @@ def template_list( "200": "TemplateListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2371,6 +2446,8 @@ def template_list_with_http_info( Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateListExample.py + :param account_id: Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the Template List to return. Defaults to `1`. @@ -2416,6 +2493,7 @@ def template_list_with_http_info( "200": "TemplateListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2468,6 +2546,8 @@ def template_list_without_preload_content( Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateListExample.py + :param account_id: Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. :type account_id: str :param page: Which page number of the Template List to return. Defaults to `1`. @@ -2513,6 +2593,7 @@ def template_list_without_preload_content( "200": "TemplateListResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2615,6 +2696,8 @@ def template_remove_user( Removes the specified Account's access to the specified Template. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateRemoveUserExample.py + :param template_id: The id of the Template to remove the Account's access to. (required) :type template_id: str :param template_remove_user_request: (required) @@ -2654,6 +2737,7 @@ def template_remove_user( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2689,6 +2773,8 @@ def template_remove_user_with_http_info( Removes the specified Account's access to the specified Template. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateRemoveUserExample.py + :param template_id: The id of the Template to remove the Account's access to. (required) :type template_id: str :param template_remove_user_request: (required) @@ -2728,6 +2814,7 @@ def template_remove_user_with_http_info( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2763,6 +2850,8 @@ def template_remove_user_without_preload_content( Removes the specified Account's access to the specified Template. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateRemoveUserExample.py + :param template_id: The id of the Template to remove the Account's access to. (required) :type template_id: str :param template_remove_user_request: (required) @@ -2802,6 +2891,7 @@ def template_remove_user_without_preload_content( "200": "TemplateGetResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2920,6 +3010,8 @@ def template_update_files( Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateUpdateFilesExample.py + :param template_id: The ID of the template whose files to update. (required) :type template_id: str :param template_update_files_request: (required) @@ -2959,6 +3051,7 @@ def template_update_files( "200": "TemplateUpdateFilesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -2992,6 +3085,8 @@ def template_update_files_with_http_info( Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateUpdateFilesExample.py + :param template_id: The ID of the template whose files to update. (required) :type template_id: str :param template_update_files_request: (required) @@ -3031,6 +3126,7 @@ def template_update_files_with_http_info( "200": "TemplateUpdateFilesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -3064,6 +3160,8 @@ def template_update_files_without_preload_content( Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/TemplateUpdateFilesExample.py + :param template_id: The ID of the template whose files to update. (required) :type template_id: str :param template_update_files_request: (required) @@ -3103,6 +3201,7 @@ def template_update_files_without_preload_content( "200": "TemplateUpdateFilesResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api/unclaimed_draft_api.py b/dropbox_sign/api/unclaimed_draft_api.py index 4d4d743..3c99361 100644 --- a/dropbox_sign/api/unclaimed_draft_api.py +++ b/dropbox_sign/api/unclaimed_draft_api.py @@ -73,6 +73,8 @@ def unclaimed_draft_create( Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateExample.py + :param unclaimed_draft_create_request: (required) :type unclaimed_draft_create_request: UnclaimedDraftCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -109,6 +111,7 @@ def unclaimed_draft_create( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -138,6 +141,8 @@ def unclaimed_draft_create_with_http_info( Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateExample.py + :param unclaimed_draft_create_request: (required) :type unclaimed_draft_create_request: UnclaimedDraftCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -174,6 +179,7 @@ def unclaimed_draft_create_with_http_info( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -203,6 +209,8 @@ def unclaimed_draft_create_without_preload_content( Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateExample.py + :param unclaimed_draft_create_request: (required) :type unclaimed_draft_create_request: UnclaimedDraftCreateRequest :param _request_timeout: timeout setting for this request. If one @@ -239,6 +247,7 @@ def unclaimed_draft_create_without_preload_content( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -350,6 +359,8 @@ def unclaimed_draft_create_embedded( Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.py + :param unclaimed_draft_create_embedded_request: (required) :type unclaimed_draft_create_embedded_request: UnclaimedDraftCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -386,6 +397,7 @@ def unclaimed_draft_create_embedded( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -415,6 +427,8 @@ def unclaimed_draft_create_embedded_with_http_info( Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.py + :param unclaimed_draft_create_embedded_request: (required) :type unclaimed_draft_create_embedded_request: UnclaimedDraftCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -451,6 +465,7 @@ def unclaimed_draft_create_embedded_with_http_info( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -480,6 +495,8 @@ def unclaimed_draft_create_embedded_without_preload_content( Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.py + :param unclaimed_draft_create_embedded_request: (required) :type unclaimed_draft_create_embedded_request: UnclaimedDraftCreateEmbeddedRequest :param _request_timeout: timeout setting for this request. If one @@ -516,6 +533,7 @@ def unclaimed_draft_create_embedded_without_preload_content( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -627,6 +645,8 @@ def unclaimed_draft_create_embedded_with_template( Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py + :param unclaimed_draft_create_embedded_with_template_request: (required) :type unclaimed_draft_create_embedded_with_template_request: UnclaimedDraftCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -663,6 +683,7 @@ def unclaimed_draft_create_embedded_with_template( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -692,6 +713,8 @@ def unclaimed_draft_create_embedded_with_template_with_http_info( Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py + :param unclaimed_draft_create_embedded_with_template_request: (required) :type unclaimed_draft_create_embedded_with_template_request: UnclaimedDraftCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -728,6 +751,7 @@ def unclaimed_draft_create_embedded_with_template_with_http_info( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -757,6 +781,8 @@ def unclaimed_draft_create_embedded_with_template_without_preload_content( Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py + :param unclaimed_draft_create_embedded_with_template_request: (required) :type unclaimed_draft_create_embedded_with_template_request: UnclaimedDraftCreateEmbeddedWithTemplateRequest :param _request_timeout: timeout setting for this request. If one @@ -793,6 +819,7 @@ def unclaimed_draft_create_embedded_with_template_without_preload_content( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -911,6 +938,8 @@ def unclaimed_draft_edit_and_resend( Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftEditAndResendExample.py + :param signature_request_id: The ID of the signature request to edit and resend. (required) :type signature_request_id: str :param unclaimed_draft_edit_and_resend_request: (required) @@ -950,6 +979,7 @@ def unclaimed_draft_edit_and_resend( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -983,6 +1013,8 @@ def unclaimed_draft_edit_and_resend_with_http_info( Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftEditAndResendExample.py + :param signature_request_id: The ID of the signature request to edit and resend. (required) :type signature_request_id: str :param unclaimed_draft_edit_and_resend_request: (required) @@ -1022,6 +1054,7 @@ def unclaimed_draft_edit_and_resend_with_http_info( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) @@ -1055,6 +1088,8 @@ def unclaimed_draft_edit_and_resend_without_preload_content( Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/UnclaimedDraftEditAndResendExample.py + :param signature_request_id: The ID of the signature request to edit and resend. (required) :type signature_request_id: str :param unclaimed_draft_edit_and_resend_request: (required) @@ -1094,6 +1129,7 @@ def unclaimed_draft_edit_and_resend_without_preload_content( "200": "UnclaimedDraftCreateResponse", "4XX": "ErrorResponse", } + response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout ) diff --git a/dropbox_sign/api_client.py b/dropbox_sign/api_client.py index 98b3eb1..37146d5 100644 --- a/dropbox_sign/api_client.py +++ b/dropbox_sign/api_client.py @@ -89,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.13.0/python" + self.user_agent = "OpenAPI-Generator/1.14.0/python" self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/dropbox_sign/apis/__init__.py b/dropbox_sign/apis/__init__.py index 0df6380..819c49c 100644 --- a/dropbox_sign/apis/__init__.py +++ b/dropbox_sign/apis/__init__.py @@ -4,6 +4,7 @@ from dropbox_sign.api.account_api import AccountApi from dropbox_sign.api.api_app_api import ApiAppApi from dropbox_sign.api.bulk_send_job_api import BulkSendJobApi +from dropbox_sign.api.document_api import DocumentApi from dropbox_sign.api.embedded_api import EmbeddedApi from dropbox_sign.api.fax_api import FaxApi from dropbox_sign.api.fax_line_api import FaxLineApi diff --git a/dropbox_sign/configuration.py b/dropbox_sign/configuration.py index df3305e..3894320 100644 --- a/dropbox_sign/configuration.py +++ b/dropbox_sign/configuration.py @@ -546,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.13.0".format( + "SDK Package Version: 1.14.0".format( env=sys.platform, pyversion=sys.version ) ) diff --git a/dropbox_sign/models/__init__.py b/dropbox_sign/models/__init__.py index 2fd3342..fd379cc 100644 --- a/dropbox_sign/models/__init__.py +++ b/dropbox_sign/models/__init__.py @@ -48,6 +48,15 @@ from dropbox_sign.models.bulk_send_job_list_response import BulkSendJobListResponse from dropbox_sign.models.bulk_send_job_response import BulkSendJobResponse from dropbox_sign.models.bulk_send_job_send_response import BulkSendJobSendResponse +from dropbox_sign.models.document_field_detection_request import ( + DocumentFieldDetectionRequest, +) +from dropbox_sign.models.document_field_detection_response import ( + DocumentFieldDetectionResponse, +) +from dropbox_sign.models.document_field_detection_response_detection_result import ( + DocumentFieldDetectionResponseDetectionResult, +) from dropbox_sign.models.embedded_edit_url_request import EmbeddedEditUrlRequest from dropbox_sign.models.embedded_edit_url_response import EmbeddedEditUrlResponse from dropbox_sign.models.embedded_edit_url_response_embedded import ( diff --git a/dropbox_sign/models/document_field_detection_request.py b/dropbox_sign/models/document_field_detection_request.py new file mode 100644 index 0000000..7c501fc --- /dev/null +++ b/dropbox_sign/models/document_field_detection_request.py @@ -0,0 +1,171 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import ( + BaseModel, + ConfigDict, + Field, + StrictBytes, + StrictStr, + field_validator, +) +from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class DocumentFieldDetectionRequest(BaseModel): + """ + DocumentFieldDetectionRequest + """ # noqa: E501 + + detection_mode: StrictStr = Field( + description="The field detection method to use. Set to `annotations` to detect PDF form annotations or `text_tags` to detect Dropbox Sign text tags." + ) + file: Optional[Union[StrictBytes, StrictStr, io.IOBase, Tuple[StrictStr, StrictBytes, io.IOBase]]] = ( + Field( + default=None, + description="The PDF file to analyze. This endpoint requires either `file` or `file_url`, but not both.", + ) + ) + file_url: Optional[StrictStr] = Field( + default=None, + description="The URL of the PDF file to analyze. This endpoint requires either `file` or `file_url`, but not both.", + ) + page_range: Optional[Annotated[str, Field(strict=True)]] = Field( + default=None, + description="The zero-based page indexes to analyze. Accepts `all`, individual pages, inclusive ranges, or comma-separated combinations, such as `0-2,5,7-9`. Defaults to `all`.", + ) + __properties: ClassVar[List[str]] = [ + "detection_mode", + "file", + "file_url", + "page_range", + ] + + @field_validator("page_range") + def page_range_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^(?:all|\d+(?:-\d+)?(?:,\d+(?:-\d+)?)*)$", value): + raise ValueError( + r"must validate the regular expression /^(?:all|\d+(?:-\d+)?(?:,\d+(?:-\d+)?)*)$/" + ) + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DocumentFieldDetectionRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DocumentFieldDetectionRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "detection_mode": obj.get("detection_mode"), + "file": obj.get("file"), + "file_url": obj.get("file_url"), + "page_range": obj.get("page_range"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "detection_mode": "(str,)", + "file": "(io.IOBase,)", + "file_url": "(str,)", + "page_range": "(str,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [] diff --git a/dropbox_sign/models/document_field_detection_response.py b/dropbox_sign/models/document_field_detection_response.py new file mode 100644 index 0000000..c20a6a8 --- /dev/null +++ b/dropbox_sign/models/document_field_detection_response.py @@ -0,0 +1,155 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dropbox_sign.models.document_field_detection_response_detection_result import ( + DocumentFieldDetectionResponseDetectionResult, +) +from dropbox_sign.models.warning_response import WarningResponse +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class DocumentFieldDetectionResponse(BaseModel): + """ + DocumentFieldDetectionResponse + """ # noqa: E501 + + detection_result: DocumentFieldDetectionResponseDetectionResult + warnings: Optional[List[WarningResponse]] = Field( + default=None, description="A list of warnings." + ) + __properties: ClassVar[List[str]] = ["detection_result", "warnings"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DocumentFieldDetectionResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of detection_result + if self.detection_result: + _dict["detection_result"] = self.detection_result.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in warnings (list) + _items = [] + if self.warnings: + for _item_warnings in self.warnings: + if _item_warnings: + _items.append(_item_warnings.to_dict()) + _dict["warnings"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DocumentFieldDetectionResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "detection_result": ( + DocumentFieldDetectionResponseDetectionResult.from_dict( + obj["detection_result"] + ) + if obj.get("detection_result") is not None + else None + ), + "warnings": ( + [WarningResponse.from_dict(_item) for _item in obj["warnings"]] + if obj.get("warnings") is not None + else None + ), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "detection_result": "(DocumentFieldDetectionResponseDetectionResult,)", + "warnings": "(List[WarningResponse],)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "warnings", + ] diff --git a/dropbox_sign/models/document_field_detection_response_detection_result.py b/dropbox_sign/models/document_field_detection_response_detection_result.py new file mode 100644 index 0000000..e242b08 --- /dev/null +++ b/dropbox_sign/models/document_field_detection_response_detection_result.py @@ -0,0 +1,245 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List +from typing_extensions import Annotated +from dropbox_sign.models.error_response_error import ErrorResponseError +from dropbox_sign.models.sub_form_field_group import SubFormFieldGroup +from dropbox_sign.models.sub_form_fields_per_document_base import ( + SubFormFieldsPerDocumentBase, +) +from dropbox_sign.models.warning_response import WarningResponse +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class DocumentFieldDetectionResponseDetectionResult(BaseModel): + """ + DocumentFieldDetectionResponseDetectionResult + """ # noqa: E501 + + document_hash: Annotated[str, Field(min_length=64, strict=True, max_length=64)] = ( + Field(description="The SHA-256 hash of the analyzed document.") + ) + detection_mode: StrictStr = Field( + description="The field detection method used to analyze the document: `annotations` or `text_tags`." + ) + page_count: Annotated[int, Field(strict=True, ge=0)] = Field( + description="The total number of pages in the document." + ) + pages_analyzed: StrictStr = Field( + description="The zero-based page indexes analyzed, represented by the requested `page_range`, or `all` when every page was analyzed." + ) + detected_at: StrictInt = Field( + description="The Unix timestamp when the field detection result was generated." + ) + form_fields_per_document: List[SubFormFieldsPerDocumentBase] = Field( + description="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`" + ) + form_field_groups: List[SubFormFieldGroup] = Field( + description="Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`." + ) + warnings: List[WarningResponse] = Field( + description="Non-fatal issues encountered during field detection." + ) + errors: List[ErrorResponseError] = Field( + description="Errors encountered during field detection. Successfully detected fields may still be included in the response." + ) + suggestions: List[StrictStr] = Field( + description="Suggestions for improving the field detection results." + ) + __properties: ClassVar[List[str]] = [ + "document_hash", + "detection_mode", + "page_count", + "pages_analyzed", + "detected_at", + "form_fields_per_document", + "form_field_groups", + "warnings", + "errors", + "suggestions", + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DocumentFieldDetectionResponseDetectionResult from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in form_fields_per_document (list) + _items = [] + if self.form_fields_per_document: + for _item_form_fields_per_document in self.form_fields_per_document: + if _item_form_fields_per_document: + _items.append(_item_form_fields_per_document.to_dict()) + _dict["form_fields_per_document"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in form_field_groups (list) + _items = [] + if self.form_field_groups: + for _item_form_field_groups in self.form_field_groups: + if _item_form_field_groups: + _items.append(_item_form_field_groups.to_dict()) + _dict["form_field_groups"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in warnings (list) + _items = [] + if self.warnings: + for _item_warnings in self.warnings: + if _item_warnings: + _items.append(_item_warnings.to_dict()) + _dict["warnings"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in errors (list) + _items = [] + if self.errors: + for _item_errors in self.errors: + if _item_errors: + _items.append(_item_errors.to_dict()) + _dict["errors"] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DocumentFieldDetectionResponseDetectionResult from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate( + { + "document_hash": obj.get("document_hash"), + "detection_mode": obj.get("detection_mode"), + "page_count": obj.get("page_count"), + "pages_analyzed": obj.get("pages_analyzed"), + "detected_at": obj.get("detected_at"), + "form_fields_per_document": ( + [ + SubFormFieldsPerDocumentBase.from_dict(_item) + for _item in obj["form_fields_per_document"] + ] + if obj.get("form_fields_per_document") is not None + else None + ), + "form_field_groups": ( + [ + SubFormFieldGroup.from_dict(_item) + for _item in obj["form_field_groups"] + ] + if obj.get("form_field_groups") is not None + else None + ), + "warnings": ( + [WarningResponse.from_dict(_item) for _item in obj["warnings"]] + if obj.get("warnings") is not None + else None + ), + "errors": ( + [ErrorResponseError.from_dict(_item) for _item in obj["errors"]] + if obj.get("errors") is not None + else None + ), + "suggestions": obj.get("suggestions"), + } + ) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "document_hash": "(str,)", + "detection_mode": "(str,)", + "page_count": "(int,)", + "pages_analyzed": "(str,)", + "detected_at": "(int,)", + "form_fields_per_document": "(List[SubFormFieldsPerDocumentBase],)", + "form_field_groups": "(List[SubFormFieldGroup],)", + "warnings": "(List[WarningResponse],)", + "errors": "(List[ErrorResponseError],)", + "suggestions": "(List[str],)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [ + "form_fields_per_document", + "form_field_groups", + "warnings", + "errors", + "suggestions", + ] diff --git a/dropbox_sign/models/error_response_error.py b/dropbox_sign/models/error_response_error.py index 6991a0a..b8b0a47 100644 --- a/dropbox_sign/models/error_response_error.py +++ b/dropbox_sign/models/error_response_error.py @@ -33,7 +33,9 @@ class ErrorResponseError(BaseModel): """ # noqa: E501 error_msg: StrictStr = Field(description="Message describing an error.") - error_name: StrictStr = Field(description="Name of the error.") + error_name: StrictStr = Field( + description="Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance." + ) error_path: Optional[StrictStr] = Field( default=None, description="Path at which an error occurred." ) diff --git a/dropbox_sign/models/event_callback_request_event.py b/dropbox_sign/models/event_callback_request_event.py index 7f263da..adada9b 100644 --- a/dropbox_sign/models/event_callback_request_event.py +++ b/dropbox_sign/models/event_callback_request_event.py @@ -80,10 +80,17 @@ def event_type_validate_enum(cls, value): "template_error", "callback_test", "signature_request_signer_removed", + "fax_received", + "fax_sent", + "fax_on_hold", + "fax_busy", + "fax_no_answer", + "fax_disconnected", + "fax_blacklisted", ] ): raise ValueError( - "must be one of enum values ('account_confirmed', 'unknown_error', 'file_error', 'sign_url_invalid', 'signature_request_viewed', 'signature_request_signed', 'signature_request_sent', 'signature_request_all_signed', 'signature_request_email_bounce', 'signature_request_remind', 'signature_request_incomplete_qes', 'signature_request_destroyed', 'signature_request_canceled', 'signature_request_downloadable', 'signature_request_declined', 'signature_request_reassigned', 'signature_request_invalid', 'signature_request_prepared', 'signature_request_expired', 'template_created', 'template_error', 'callback_test', 'signature_request_signer_removed')" + "must be one of enum values ('account_confirmed', 'unknown_error', 'file_error', 'sign_url_invalid', 'signature_request_viewed', 'signature_request_signed', 'signature_request_sent', 'signature_request_all_signed', 'signature_request_email_bounce', 'signature_request_remind', 'signature_request_incomplete_qes', 'signature_request_destroyed', 'signature_request_canceled', 'signature_request_downloadable', 'signature_request_declined', 'signature_request_reassigned', 'signature_request_invalid', 'signature_request_prepared', 'signature_request_expired', 'template_created', 'template_error', 'callback_test', 'signature_request_signer_removed', 'fax_received', 'fax_sent', 'fax_on_hold', 'fax_busy', 'fax_no_answer', 'fax_disconnected', 'fax_blacklisted')" ) return value diff --git a/dropbox_sign/models/fax_response.py b/dropbox_sign/models/fax_response.py index 1648df8..2fab76f 100644 --- a/dropbox_sign/models/fax_response.py +++ b/dropbox_sign/models/fax_response.py @@ -18,7 +18,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.fax_response_transmission import FaxResponseTransmission from typing import Optional, Set @@ -43,6 +43,9 @@ class FaxResponse(BaseModel): transmissions: List[FaxResponseTransmission] = Field( description="Fax Transmissions List" ) + test_mode: StrictBool = Field( + description="Whether this is a test fax. Test faxes are not delivered to the recipient. Defaults to `false`." + ) subject: Optional[StrictStr] = Field(default=None, description="Fax Subject") message: Optional[StrictStr] = Field(default=None, description="Fax Message") final_copy_uri: Optional[StrictStr] = Field( @@ -58,6 +61,7 @@ class FaxResponse(BaseModel): "sender", "files_url", "transmissions", + "test_mode", "subject", "message", "final_copy_uri", @@ -148,6 +152,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("transmissions") is not None else None ), + "test_mode": ( + obj.get("test_mode") if obj.get("test_mode") is not None else False + ), "subject": obj.get("subject"), "message": obj.get("message"), "final_copy_uri": obj.get("final_copy_uri"), @@ -176,6 +183,7 @@ def openapi_types(cls) -> Dict[str, str]: "sender": "(str,)", "files_url": "(str,)", "transmissions": "(List[FaxResponseTransmission],)", + "test_mode": "(bool,)", "subject": "(str,)", "message": "(str,)", "final_copy_uri": "(str,)", diff --git a/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py b/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py index 54fd997..b1558bc 100644 --- a/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py +++ b/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py @@ -18,7 +18,15 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr +from pydantic import ( + BaseModel, + ConfigDict, + Field, + StrictBool, + StrictBytes, + StrictInt, + StrictStr, +) from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_bulk_signer_list import SubBulkSignerList @@ -88,6 +96,10 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest(BaseModel): default=None, description="The title you want to assign to the SignatureRequest.", ) + expires_at: Optional[StrictInt] = Field( + default=None, + 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.", + ) __properties: ClassVar[List[str]] = [ "template_ids", "client_id", @@ -102,6 +114,7 @@ class SignatureRequestBulkCreateEmbeddedWithTemplateRequest(BaseModel): "subject", "test_mode", "title", + "expires_at", ] model_config = ConfigDict( @@ -219,6 +232,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: obj.get("test_mode") if obj.get("test_mode") is not None else False ), "title": obj.get("title"), + "expires_at": obj.get("expires_at"), } ) return _obj @@ -249,6 +263,7 @@ def openapi_types(cls) -> Dict[str, str]: "subject": "(str,)", "test_mode": "(bool,)", "title": "(str,)", + "expires_at": "(int,)", } @classmethod diff --git a/dropbox_sign/models/signature_request_bulk_send_with_template_request.py b/dropbox_sign/models/signature_request_bulk_send_with_template_request.py index 54cb980..80abb08 100644 --- a/dropbox_sign/models/signature_request_bulk_send_with_template_request.py +++ b/dropbox_sign/models/signature_request_bulk_send_with_template_request.py @@ -18,7 +18,15 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr +from pydantic import ( + BaseModel, + ConfigDict, + Field, + StrictBool, + StrictBytes, + StrictInt, + StrictStr, +) from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_bulk_signer_list import SubBulkSignerList @@ -89,6 +97,10 @@ class SignatureRequestBulkSendWithTemplateRequest(BaseModel): default=None, description="The title you want to assign to the SignatureRequest.", ) + expires_at: Optional[StrictInt] = Field( + default=None, + 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.", + ) __properties: ClassVar[List[str]] = [ "template_ids", "signer_file", @@ -103,6 +115,7 @@ class SignatureRequestBulkSendWithTemplateRequest(BaseModel): "subject", "test_mode", "title", + "expires_at", ] model_config = ConfigDict( @@ -220,6 +233,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: obj.get("test_mode") if obj.get("test_mode") is not None else False ), "title": obj.get("title"), + "expires_at": obj.get("expires_at"), } ) return _obj @@ -250,6 +264,7 @@ def openapi_types(cls) -> Dict[str, str]: "subject": "(str,)", "test_mode": "(bool,)", "title": "(str,)", + "expires_at": "(int,)", } @classmethod diff --git a/dropbox_sign/models/signature_request_create_embedded_with_template_request.py b/dropbox_sign/models/signature_request_create_embedded_with_template_request.py index 07c2d0c..e0e0699 100644 --- a/dropbox_sign/models/signature_request_create_embedded_with_template_request.py +++ b/dropbox_sign/models/signature_request_create_embedded_with_template_request.py @@ -18,7 +18,15 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr +from pydantic import ( + BaseModel, + ConfigDict, + Field, + StrictBool, + StrictBytes, + StrictInt, + StrictStr, +) from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_cc import SubCC @@ -95,6 +103,10 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest(BaseModel): default=False, description="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.", ) + expires_at: Optional[StrictInt] = Field( + default=None, + 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.", + ) __properties: ClassVar[List[str]] = [ "template_ids", "client_id", @@ -111,6 +123,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest(BaseModel): "test_mode", "title", "populate_auto_fill_fields", + "expires_at", ] model_config = ConfigDict( @@ -244,6 +257,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("populate_auto_fill_fields") is not None else False ), + "expires_at": obj.get("expires_at"), } ) return _obj @@ -276,6 +290,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "populate_auto_fill_fields": "(bool,)", + "expires_at": "(int,)", } @classmethod diff --git a/dropbox_sign/models/signature_request_send_with_template_request.py b/dropbox_sign/models/signature_request_send_with_template_request.py index 71cbf11..f5c064c 100644 --- a/dropbox_sign/models/signature_request_send_with_template_request.py +++ b/dropbox_sign/models/signature_request_send_with_template_request.py @@ -18,7 +18,15 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictBytes, StrictStr +from pydantic import ( + BaseModel, + ConfigDict, + Field, + StrictBool, + StrictBytes, + StrictInt, + StrictStr, +) from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.sub_cc import SubCC @@ -102,6 +110,10 @@ class SignatureRequestSendWithTemplateRequest(BaseModel): default=None, description="The title you want to assign to the SignatureRequest.", ) + expires_at: Optional[StrictInt] = Field( + default=None, + 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.", + ) __properties: ClassVar[List[str]] = [ "template_ids", "signers", @@ -120,6 +132,7 @@ class SignatureRequestSendWithTemplateRequest(BaseModel): "subject", "test_mode", "title", + "expires_at", ] model_config = ConfigDict( @@ -255,6 +268,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: obj.get("test_mode") if obj.get("test_mode") is not None else False ), "title": obj.get("title"), + "expires_at": obj.get("expires_at"), } ) return _obj @@ -289,6 +303,7 @@ def openapi_types(cls) -> Dict[str, str]: "subject": "(str,)", "test_mode": "(bool,)", "title": "(str,)", + "expires_at": "(int,)", } @classmethod diff --git a/examples/DocumentDetectFieldsExample.py b/examples/DocumentDetectFieldsExample.py new file mode 100644 index 0000000..eca19a2 --- /dev/null +++ b/examples/DocumentDetectFieldsExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + document_field_detection_request = models.DocumentFieldDetectionRequest( + detection_mode="annotations", + file=open("./example_document.pdf", "rb").read(), + page_range="all", + ) + + try: + response = api.DocumentApi(api_client).document_detect_fields( + document_field_detection_request=document_field_detection_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling DocumentApi#document_detect_fields: %s\n" % e) diff --git a/openapi-config.yaml b/openapi-config.yaml index d168bca..9ce2d29 100644 --- a/openapi-config.yaml +++ b/openapi-config.yaml @@ -5,7 +5,7 @@ additionalProperties: generatorLanguageVersion: ">=3.8" packageName: dropbox_sign projectName: dropbox-sign - packageVersion: 1.13.0 + packageVersion: 1.14.0 sortModelPropertiesByRequiredFlag: true legacyDiscriminatorBehavior: true packageAuthor: Dropbox Sign API Team diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 576b442..a05971e 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1153,6 +1153,104 @@ paths: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of BulkSendJob that you can access, click here.' + /document/detect_fields: + post: + tags: + - Document + summary: 'Detect Document Fields' + description: 'Detects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags.' + operationId: documentDetectFields + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentFieldDetectionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/DocumentFieldDetectionRequest' + 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/DocumentFieldDetectionResponse' + '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' + 422_example: + $ref: '#/components/examples/Error422Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/DocumentDetectFieldsExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/DocumentDetectFieldsExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/DocumentDetectFieldsExample.ts + - + lang: Java + label: Java + source: + $ref: examples/DocumentDetectFieldsExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/DocumentDetectFieldsExample.rb + - + lang: Python + label: Python + source: + $ref: examples/DocumentDetectFieldsExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/DocumentDetectFieldsExample.sh + x-meta: + seo: + title: 'Detect Document Fields | API Documentation | Dropbox Sign for Developers' + description: 'Use the Dropbox Sign API to detect form fields in PDF documents from PDF form annotations or Dropbox Sign text tags.' '/embedded/edit_url/{template_id}': post: tags: @@ -5087,6 +5185,8 @@ paths: $ref: '#/components/examples/Error429Response' 404_example: $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' 4XX_example: $ref: '#/components/examples/Error4XXResponse' security: @@ -7925,6 +8025,42 @@ components: white_labeling_options: $ref: '#/components/schemas/SubWhiteLabelingOptions' type: object + DocumentFieldDetectionRequest: + required: + - detection_mode + properties: + file: + description: |- + The PDF file to analyze. + + This endpoint requires either `file` or `file_url`, but not both. + type: string + format: binary + file_url: + description: |- + The URL of the PDF file to analyze. + + This endpoint requires either `file` or `file_url`, but not both. + type: string + format: uri + detection_mode: + description: 'The field detection method to use. Set to `annotations` to detect PDF form annotations or `text_tags` to detect Dropbox Sign text tags.' + type: string + oneOf: + - + type: string + pattern: ^annotations$ + example: annotations + - + type: string + pattern: ^text_tags$ + example: text_tags + page_range: + description: 'The zero-based page indexes to analyze. Accepts `all`, individual pages, inclusive ranges, or comma-separated combinations, such as `0-2,5,7-9`. Defaults to `all`.' + type: string + pattern: '^(?:all|\d+(?:-\d+)?(?:,\d+(?:-\d+)?)*)$' + example: '0-2,5,7-9' + type: object EmbeddedEditUrlRequest: properties: allow_edit_ccs: @@ -8323,6 +8459,10 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + 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 + nullable: true type: object SignatureRequestBulkSendWithTemplateRequest: required: @@ -8412,6 +8552,10 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + 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 + nullable: true type: object SignatureRequestCreateEmbeddedRequest: required: @@ -8652,6 +8796,10 @@ 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 + 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 + nullable: true type: object SignatureRequestEditRequest: properties: @@ -9416,6 +9564,10 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + 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 + nullable: true type: object SignatureRequestUpdateRequest: required: @@ -11520,6 +11672,19 @@ components: $ref: '#/components/schemas/WarningResponse' type: object x-internal-class: true + DocumentFieldDetectionResponse: + required: + - detection_result + properties: + detection_result: + $ref: '#/components/schemas/DocumentFieldDetectionResponseDetectionResult' + warnings: + description: 'A list of warnings.' + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true EmbeddedEditUrlResponse: required: - embedded @@ -11940,6 +12105,89 @@ components: type: object additionalProperties: {} x-internal-class: true + DocumentFieldDetectionResponseDetectionResult: + required: + - document_hash + - detection_mode + - page_count + - pages_analyzed + - detected_at + - form_fields_per_document + - form_field_groups + - warnings + - errors + - suggestions + properties: + document_hash: + description: 'The SHA-256 hash of the analyzed document.' + type: string + maxLength: 64 + minLength: 64 + detection_mode: + description: 'The field detection method used to analyze the document: `annotations` or `text_tags`.' + type: string + oneOf: + - + type: string + pattern: ^annotations$ + example: annotations + - + type: string + pattern: ^text_tags$ + example: text_tags + page_count: + description: 'The total number of pages in the document.' + type: integer + minimum: 0 + pages_analyzed: + description: 'The zero-based page indexes analyzed, represented by the requested `page_range`, or `all` when every page was analyzed.' + type: string + example: all + detected_at: + description: 'The Unix timestamp when the field detection result was generated.' + type: integer + format: int64 + form_fields_per_document: + description: |- + 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` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + form_field_groups: + description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + warnings: + description: 'Non-fatal issues encountered during field detection.' + type: array + items: + $ref: '#/components/schemas/WarningResponse' + errors: + description: 'Errors encountered during field detection. Successfully detected fields may still be included in the response.' + type: array + items: + $ref: '#/components/schemas/ErrorResponseError' + suggestions: + description: 'Suggestions for improving the field detection results.' + type: array + items: + type: string + type: object + x-internal-class: true EmbeddedEditUrlResponseEmbedded: description: 'An embedded template object.' properties: @@ -11975,7 +12223,7 @@ components: description: 'Path at which an error occurred.' type: string error_name: - description: 'Name of the error.' + description: 'Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance.' type: string type: object FaxResponse: @@ -11988,6 +12236,7 @@ components: - sender - files_url - transmissions + - test_mode properties: fax_id: description: 'Fax ID' @@ -12028,6 +12277,10 @@ components: type: array items: $ref: '#/components/schemas/FaxResponseTransmission' + test_mode: + description: 'Whether this is a test fax. Test faxes are not delivered to the recipient. Defaults to `false`.' + type: boolean + default: false type: object x-internal-class: true FaxLineResponseFaxLine: @@ -13782,6 +14035,8 @@ components: template: $ref: '#/components/schemas/TemplateResponse' type: object + x-fern-audiences: + - events EventCallbackRequestEvent: description: 'Basic information about the event that occurred.' required: @@ -13819,12 +14074,21 @@ components: - template_error - callback_test - signature_request_signer_removed + - fax_received + - fax_sent + - fax_on_hold + - fax_busy + - fax_no_answer + - fax_disconnected + - fax_blacklisted event_hash: description: 'Generated hash used to verify source of event data.' type: string event_metadata: $ref: '#/components/schemas/EventCallbackRequestEventMetadata' type: object + x-fern-audiences: + - events EventCallbackRequestEventMetadata: description: 'Specific metadata about the event.' properties: @@ -13845,6 +14109,8 @@ components: type: string nullable: true type: object + x-fern-audiences: + - events responses: EventCallbackResponse: description: 'successful operation' @@ -13853,6 +14119,8 @@ components: schema: type: string default: 'Hello API Event Received' + x-fern-audiences: + - events examples: AccountCreateRequest: summary: 'Default Example' @@ -14354,22 +14622,212 @@ components: summary: 'Example: signature_request_sent' value: $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + x-fern-audiences: + - events EventCallbackAccountTemplateCreated: summary: 'Example: template_created' value: $ref: examples/json/EventCallbackAccountTemplateCreated.json + x-fern-audiences: + - events EventCallbackAppAccountConfirmed: summary: 'Example: account_confirmed' value: $ref: examples/json/EventCallbackAppAccountConfirmed.json + x-fern-audiences: + - events EventCallbackAppSignatureRequestSent: summary: 'Example: signature_request_sent' value: $ref: examples/json/EventCallbackAppSignatureRequestSent.json + x-fern-audiences: + - events EventCallbackAppTemplateCreated: summary: 'Example: template_created' value: $ref: examples/json/EventCallbackAppTemplateCreated.json + x-fern-audiences: + - events + EventCallbackSignatureRequestViewed: + summary: 'Signature Request Viewed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestViewed.json + x-fern-audiences: + - events + EventCallbackSignatureRequestSigned: + summary: 'Signature Request Signed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestSigned.json + x-fern-audiences: + - events + EventCallbackSignatureRequestSignerRemoved: + summary: 'Signature Request Signer Removed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestSignerRemoved.json + x-fern-audiences: + - events + EventCallbackSignatureRequestDownloadable: + summary: 'Signature Request Downloadable Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestDownloadable.json + x-fern-audiences: + - events + EventCallbackSignatureRequestSent: + summary: 'Signature Request Sent Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestSent.json + x-fern-audiences: + - events + EventCallbackSignatureRequestAllSigned: + summary: 'Signature Request All Signed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestAllSigned.json + x-fern-audiences: + - events + EventCallbackSignatureRequestInvalid: + summary: 'Signature Request Invalid Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestInvalid.json + x-fern-audiences: + - events + EventCallbackSignatureRequestEmailBounce: + summary: 'Signature Request Email Bounce Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestEmailBounce.json + x-fern-audiences: + - events + EventCallbackSignatureRequestRemind: + summary: 'Signature Request Remind Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestRemind.json + x-fern-audiences: + - events + EventCallbackSignatureRequestIncompleteQes: + summary: 'Signature Request Incomplete QES Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestIncompleteQes.json + x-fern-audiences: + - events + EventCallbackSignatureRequestDestroyed: + summary: 'Signature Request Destroyed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestDestroyed.json + x-fern-audiences: + - events + EventCallbackSignatureRequestCanceled: + summary: 'Signature Request Canceled Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestCanceled.json + x-fern-audiences: + - events + EventCallbackSignatureRequestDeclined: + summary: 'Signature Request Declined Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestDeclined.json + x-fern-audiences: + - events + EventCallbackSignatureRequestExpired: + summary: 'Signature Request Expired Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestExpired.json + x-fern-audiences: + - events + EventCallbackSignatureRequestReassigned: + summary: 'Signature Request Reassigned Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestReassigned.json + x-fern-audiences: + - events + EventCallbackSignatureRequestPrepared: + summary: 'Signature Request Prepared Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestPrepared.json + x-fern-audiences: + - events + EventCallbackAccountConfirmed: + summary: 'Account Confirmed Event Example' + value: + $ref: examples/json/EventCallbackAccountConfirmed.json + x-fern-audiences: + - events + EventCallbackUnknownError: + summary: 'Unknown Error Event Example' + value: + $ref: examples/json/EventCallbackUnknownError.json + x-fern-audiences: + - events + EventCallbackFileError: + summary: 'File Error Event Example' + value: + $ref: examples/json/EventCallbackFileError.json + x-fern-audiences: + - events + EventCallbackTemplateCreated: + summary: 'Template Created Event Example' + value: + $ref: examples/json/EventCallbackTemplateCreated.json + x-fern-audiences: + - events + EventCallbackTemplateError: + summary: 'Template Error Event Example' + value: + $ref: examples/json/EventCallbackTemplateError.json + x-fern-audiences: + - events + EventCallbackSignUrlInvalid: + summary: 'Sign URL Invalid Event Example' + value: + $ref: examples/json/EventCallbackSignUrlInvalid.json + x-fern-audiences: + - events + EventCallbackCallbackTest: + summary: 'Callback Test Event Example' + value: + $ref: examples/json/EventCallbackCallbackTest.json + x-fern-audiences: + - events + EventCallbackFaxReceived: + summary: 'Fax Received Event Example' + value: + $ref: examples/json/EventCallbackFaxReceived.json + x-fern-audiences: + - events + EventCallbackFaxSent: + summary: 'Fax Sent Event Example' + value: + $ref: examples/json/EventCallbackFaxSent.json + x-fern-audiences: + - events + EventCallbackFaxOnHold: + summary: 'Fax On Hold Event Example' + value: + $ref: examples/json/EventCallbackFaxOnHold.json + x-fern-audiences: + - events + EventCallbackFaxBusy: + summary: 'Fax Busy Event Example' + value: + $ref: examples/json/EventCallbackFaxBusy.json + x-fern-audiences: + - events + EventCallbackFaxNoAnswer: + summary: 'Fax No Answer Event Example' + value: + $ref: examples/json/EventCallbackFaxNoAnswer.json + x-fern-audiences: + - events + EventCallbackFaxDisconnected: + summary: 'Fax Disconnected Event Example' + value: + $ref: examples/json/EventCallbackFaxDisconnected.json + x-fern-audiences: + - events + EventCallbackFaxBlacklisted: + summary: 'Fax Blacklisted Event Example' + value: + $ref: examples/json/EventCallbackFaxBlacklisted.json + x-fern-audiences: + - events requestBodies: EventCallbackAccountRequest: description: |- @@ -14447,100 +14905,242 @@ security: externalDocs: description: 'Legacy API Reference' url: 'https://app.hellosign.com/api/reference' -x-webhooks: - accountCallback: - post: - summary: 'Account Callbacks' - operationId: accountUpdateEventCallback - description: - $ref: ./markdown/en/descriptions/account-callback-description.md - x-meta: - seo: - title: 'Account Callbacks | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the account level, click here.' - x-codeSamples: - - - lang: PHP - label: PHP - source: - $ref: examples/EventCallbackExample.php - - - lang: 'C#' - label: 'C#' - source: - $ref: examples/EventCallbackExample.cs - - - lang: TypeScript - label: TypeScript - source: - $ref: examples/EventCallbackExample.ts - - - lang: Java - label: Java - source: - $ref: examples/EventCallbackExample.java - - - lang: Ruby - label: Ruby - source: - $ref: examples/EventCallbackExample.rb - - - lang: Python - label: Python - source: - $ref: examples/EventCallbackExample.py - tags: - - 'Callbacks and Events' - requestBody: - $ref: '#/components/requestBodies/EventCallbackAccountRequest' - responses: - 200: - $ref: '#/components/responses/EventCallbackResponse' - appCallback: - post: - summary: 'App Callbacks' - description: - $ref: ./markdown/en/descriptions/api-app-callback-description.md - operationId: apiAppCreateEventCallback - x-meta: - seo: - title: 'App Callbacks | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the App level, click here.' - x-codeSamples: - - - lang: PHP - label: PHP - source: - $ref: examples/EventCallbackExample.php - - - lang: 'C#' - label: 'C#' - source: - $ref: examples/EventCallbackExample.cs - - - lang: TypeScript - label: TypeScript - source: - $ref: examples/EventCallbackExample.ts - - - lang: Java - label: Java - source: - $ref: examples/EventCallbackExample.java - - - lang: Ruby - label: Ruby - source: - $ref: examples/EventCallbackExample.rb - - - lang: Python - label: Python - source: - $ref: examples/EventCallbackExample.py - tags: - - 'Callbacks and Events' - requestBody: - $ref: '#/components/requestBodies/EventCallbackAppRequest' - responses: - 200: - $ref: '#/components/responses/EventCallbackResponse' +x-webhooks: [] +x-error-codes: + bad_request: + http_status: 400 + summary: 'The request contained invalid or malformed parameters.' + cause: 'A parameter failed validation, or the request body was malformed.' + remediation: 'Inspect error_msg and error_path, correct the offending parameter, and resend.' + retryable: 'no' + unauthorized: + http_status: 401 + summary: 'The credentials supplied are missing or invalid.' + cause: 'Missing, malformed, or invalid API key or OAuth access token.' + remediation: 'Verify the API key or OAuth token and the Authorization header, then retry.' + retryable: 'no' + payment_required: + http_status: 402 + summary: 'The account must be credited or upgraded to perform this action.' + cause: 'The action requires a paid plan, additional quota, or API credits.' + remediation: 'Upgrade the plan or add the required credits/quota, then retry.' + retryable: 'no' + forbidden: + http_status: 403 + summary: 'The action is not allowed for these credentials or in the current context.' + cause: 'The authenticated account lacks access to the resource or operation.' + remediation: 'Confirm the account has access to the resource and the required permissions.' + retryable: 'no' + not_found: + http_status: 404 + summary: 'Nothing matches the requested resource.' + cause: 'The resource id does not exist or is not visible to this account.' + remediation: 'Verify the id and that the resource belongs to the authenticated account.' + retryable: 'no' + conflict: + http_status: 409 + summary: 'The request was well-formed but conflicts with the current state.' + cause: 'The target resource is in a state incompatible with the request (e.g. a signature request is still being set up).' + remediation: 'Wait briefly and retry, or listen for a callback event confirming the resource is ready.' + retryable: conditional + exceeded_rate: + http_status: 429 + summary: 'Your account''s API request rate limit has been exceeded.' + cause: 'Too many requests were sent within the rate-limit window for this request type.' + remediation: 'Pace requests using the X-RateLimit-* response headers and retry after the window resets.' + retryable: 'yes' + backoff: 'Honor X-Ratelimit-Reset (Unix epoch); otherwise exponential backoff with jitter. No Retry-After header is sent.' + unknown: + http_status: 500 + summary: 'An unexpected error occurred.' + cause: 'An unhandled server-side error, or a status code without a more specific error_name.' + remediation: 'Retry transient failures; if it persists, contact support with the request details.' + retryable: conditional + backoff: 'For transient 5xx, retry with exponential backoff; otherwise do not retry.' + team_invite_failed: + http_status: 403 + summary: 'The team invitation could not be completed.' + cause: 'The invitee already belongs to a team, or the invite is otherwise not permitted.' + remediation: 'Confirm the invitee is not already on a team before inviting.' + retryable: 'no' + max_faxes: + http_status: 429 + summary: 'Too many fax transmissions are currently pending or transmitting.' + cause: 'The account has reached the limit of concurrent in-flight fax transmissions.' + remediation: 'Wait for outstanding transmissions to complete, then retry.' + retryable: 'yes' + backoff: 'Retry with exponential backoff once pending transmissions clear.' + invalid_recipient: + http_status: 400 + summary: 'The recipient (fax number or email address) is invalid.' + cause: 'A recipient value did not pass validation.' + remediation: 'Correct the recipient value and resend.' + retryable: 'no' + signature_request_cancel_failed: + http_status: 400 + summary: 'The signature request could not be cancelled.' + cause: 'The caller is not the requester, or the request is already fully executed/closed.' + remediation: 'Only the requester can cancel, and only before the request is fully executed.' + retryable: 'no' + signature_request_remove_failed: + http_status: 400 + summary: 'Access to the signature request could not be removed.' + cause: 'The signature request has not yet been fully executed, so access cannot be revoked.' + remediation: 'Wait until all parties have signed, or call /signature_request/cancel to cancel incomplete requests instead.' + retryable: 'no' + maintenance: + http_status: 503 + summary: 'The request could not be completed because the site is under maintenance.' + cause: 'The API is in a scheduled maintenance window.' + remediation: 'Retry once the maintenance window ends.' + retryable: 'yes' + backoff: 'Retry later with exponential backoff.' + method_not_supported: + http_status: 405 + summary: 'The HTTP method is not supported for this endpoint.' + cause: 'The request used a verb the endpoint does not accept.' + remediation: 'Use the HTTP method documented for the endpoint.' + retryable: 'no' + invalid_reminder: + http_status: 400 + summary: 'The signature request reminder was invalid.' + cause: 'A reminder was attempted against an ineligible request (e.g. embedded, closed, or expired).' + remediation: 'Only send reminders for eligible (non-embedded, open) signature requests.' + retryable: 'no' + unavailable: + http_status: 503 + summary: 'The service is temporarily unavailable.' + cause: 'A downstream dependency or the service itself is temporarily unavailable.' + remediation: 'Retry later with exponential backoff.' + retryable: 'yes' + backoff: 'Retry later with exponential backoff and jitter.' + unprocessable_entity: + http_status: 422 + summary: 'The request was understood but the target entity cannot be processed.' + cause: 'The resource is still being processed, or it is in an error state.' + remediation: 'If the resource is still processing, wait and retry; if it is in an error state, recreate/resend it instead of retrying.' + retryable: conditional + backoff: 'If still processing, retry with exponential backoff; if in an error state, do not retry.' + signature_request_expired: + http_status: + - 400 + - 403 + summary: 'The signature request has expired.' + cause: 'The operation targets a request whose expiration has passed. Most endpoints return 400; final-copy/download endpoints return 403.' + remediation: 'The request can no longer be acted upon; create a new signature request.' + retryable: 'no' + deleted: + http_status: 410 + summary: 'The request was cancelled or deleted.' + cause: 'The resource has been cancelled or removed and is no longer available.' + remediation: 'Do not retry; the resource is permanently gone.' + retryable: 'no' +x-oauth-error-codes: + invalid_grant: + http_status: + - 400 + - 401 + summary: 'The OAuth grant (authorization code or refresh token) is invalid or expired.' + cause: 'The code/token was already used, expired, or does not match the client.' + remediation: 'Re-initiate the OAuth flow to obtain a fresh authorization code.' + retryable: 'no' + invalid_client: + http_status: 400 + summary: 'The OAuth client credentials are invalid.' + cause: 'The client_id or client_secret is unrecognized or incorrect.' + remediation: 'Verify the client_id and client_secret from the API app settings.' + retryable: 'no' + invalid_request: + http_status: 400 + summary: 'The OAuth request is malformed or missing required parameters.' + cause: 'A required parameter is missing, or the request format is invalid.' + remediation: 'Check the request against the OAuth token endpoint documentation.' + retryable: 'no' + unauthorized_client: + http_status: + - 401 + - 403 + summary: 'The OAuth client is not authorized to perform this action.' + cause: 'The app has not been approved, or the action is outside the granted scopes.' + remediation: 'Ensure the app is approved and the required scopes are granted.' + retryable: 'no' + unsupported_grant_type: + http_status: 400 + summary: 'The grant type is not supported.' + cause: 'The grant_type parameter value is not recognized.' + remediation: 'Use authorization_code or refresh_token as the grant_type.' + retryable: 'no' + payment_required: + http_status: 402 + summary: 'The account requires a paid plan to use this OAuth app.' + cause: 'The authorizing account does not have a plan that supports this integration.' + remediation: 'Upgrade the account to a plan that includes OAuth app access.' + retryable: 'no' + addon_required: + http_status: 402 + summary: 'An add-on is required to use this OAuth app.' + cause: 'The account plan does not include the add-on needed for this integration.' + remediation: 'Add the required add-on to the account subscription.' + retryable: 'no' + invalid_scope: + http_status: 400 + summary: 'The requested OAuth scope is invalid.' + cause: 'The scope parameter contains values not permitted for the app.' + remediation: 'Request only scopes that the app is configured to use.' + retryable: 'no' + quota_reached: + http_status: 402 + summary: 'The account has reached its usage quota for this OAuth app.' + cause: 'The authorizing account has exhausted its quota for the integration.' + remediation: 'Contact the app owner or upgrade the account quota.' + retryable: 'no' + server_error: + http_status: 500 + summary: 'An internal server error occurred during OAuth processing.' + cause: 'An unexpected error on the server side while handling the OAuth request.' + remediation: 'Retry the request; if it persists, contact support.' + retryable: 'yes' + backoff: 'Retry with exponential backoff.' + temporary_unavailable: + http_status: 503 + summary: 'The OAuth service is temporarily unavailable.' + cause: 'The service is under maintenance or experiencing temporary issues.' + remediation: 'Retry after a short delay.' + retryable: 'yes' + backoff: 'Retry with exponential backoff.' +x-error-events: + signature_request_invalid: + event_type: signature_request_invalid + delivery: webhook + summary: 'Asynchronous error while processing a signature request.' + cause: 'A signature request could not be processed (e.g. invalid tags, fields, or merge data).' + remediation: 'Inspect event.event_metadata.event_message in the callback, correct the request, and resend.' + retryable: conditional + unknown_error: + event_type: unknown_error + delivery: webhook + summary: 'An unspecified asynchronous processing error occurred.' + cause: 'An unexpected error occurred while processing the request asynchronously.' + remediation: 'Check the request status in the API dashboard; retry or contact support if it persists.' + retryable: conditional + file_error: + event_type: file_error + delivery: webhook + summary: 'Asynchronous error while processing an uploaded file.' + cause: 'A file attached to a request could not be processed.' + remediation: 'Resend the request with a supported, non-corrupt file.' + retryable: conditional + template_error: + event_type: template_error + delivery: webhook + summary: 'Asynchronous error while creating a template.' + cause: 'Template file processing failed (e.g. unsupported or corrupt file).' + remediation: 'Recreate the template with a valid file; check status in the API dashboard.' + retryable: conditional + sign_url_invalid: + event_type: sign_url_invalid + delivery: webhook + summary: 'An embedded signing URL has expired or become invalid.' + cause: 'The embedded sign_url is no longer valid (e.g. expired).' + remediation: 'Generate a fresh embedded sign_url via the embedded sign URL endpoint.' + retryable: 'yes' diff --git a/pyproject.toml b/pyproject.toml index 8a4a7a4..290209b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "dropbox_sign" -version = "1.13.0" +version = "1.14.0" description = "Dropbox Sign API" authors = ["Official Python SDK for the Dropbox Sign API "] license = "MIT" diff --git a/setup.py b/setup.py index 9ea30d3..5d5923b 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "dropbox-sign" -VERSION = "1.13.0" +VERSION = "1.14.0" PYTHON_REQUIRES = ">= 3.8" REQUIRES = [ "urllib3 >= 1.25.3, < 3.0.0", diff --git a/templates/partial_api.mustache b/templates/partial_api.mustache index dd3a9a1..58a9269 100644 --- a/templates/partial_api.mustache +++ b/templates/partial_api.mustache @@ -4,6 +4,8 @@ {{{.}}} {{/notes}} + Example: https://github.com/hellosign/dropbox-sign-python/blob/main/examples/{{operationIdCamelCase}}Example.py + {{#allParams}} :param {{paramName}}:{{#description}} {{{.}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}} :type {{paramName}}: {{dataType}}{{#optional}}, optional{{/optional}} @@ -49,4 +51,4 @@ '{{code}}': {{#dataType}}"{{.}}"{{/dataType}}{{^dataType}}None{{/dataType}}, {{/isWildcard}} {{/responses}} - } \ No newline at end of file + } diff --git a/test_fixtures/FaxGetResponse.json b/test_fixtures/FaxGetResponse.json index 0d668e0..f4bf435 100644 --- a/test_fixtures/FaxGetResponse.json +++ b/test_fixtures/FaxGetResponse.json @@ -24,7 +24,8 @@ "status_code": "success" } ], - "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + "test_mode": false } } } diff --git a/test_fixtures/FaxListResponse.json b/test_fixtures/FaxListResponse.json index d0ce7fe..9dbdb96 100644 --- a/test_fixtures/FaxListResponse.json +++ b/test_fixtures/FaxListResponse.json @@ -31,7 +31,8 @@ "status_code": "success" } ], - "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + "test_mode": false } ] }