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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Python 3.8+
Install using `pip`:

```shell
python3 -m pip install dropbox-sign==1.13.0
python3 -m pip install dropbox-sign==1.14.0
```

Alternatively:
Expand Down Expand Up @@ -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|
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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

2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.13.0
1.14.0
79 changes: 79 additions & 0 deletions docs/DocumentApi.md
Original file line number Diff line number Diff line change
@@ -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 - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> |
**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)

15 changes: 15 additions & 0 deletions docs/DocumentFieldDetectionRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# DocumentFieldDetectionRequest



## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `detection_mode`<sup>*_required_</sup> | ```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.<br><br>This endpoint requires either `file` or `file_url`, but not both. | |
| `file_url` | ```str``` | The URL of the PDF file to analyze.<br><br>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)


13 changes: 13 additions & 0 deletions docs/DocumentFieldDetectionResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# DocumentFieldDetectionResponse



## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `detection_result`<sup>*_required_</sup> | [```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)


21 changes: 21 additions & 0 deletions docs/DocumentFieldDetectionResponseDetectionResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# DocumentFieldDetectionResponseDetectionResult



## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `document_hash`<sup>*_required_</sup> | ```str``` | The SHA-256 hash of the analyzed document. | |
| `detection_mode`<sup>*_required_</sup> | ```str``` | The field detection method used to analyze the document: `annotations` or `text_tags`. | |
| `page_count`<sup>*_required_</sup> | ```int``` | The total number of pages in the document. | |
| `pages_analyzed`<sup>*_required_</sup> | ```str``` | The zero-based page indexes analyzed, represented by the requested `page_range`, or `all` when every page was analyzed. | |
| `detected_at`<sup>*_required_</sup> | ```int``` | The Unix timestamp when the field detection result was generated. | |
| `form_fields_per_document`<sup>*_required_</sup> | [```List[SubFormFieldsPerDocumentBase]```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
| `form_field_groups`<sup>*_required_</sup> | [```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`<sup>*_required_</sup> | [```List[WarningResponse]```](WarningResponse.md) | Non-fatal issues encountered during field detection. | |
| `errors`<sup>*_required_</sup> | [```List[ErrorResponseError]```](ErrorResponseError.md) | Errors encountered during field detection. Successfully detected fields may still be included in the response. | |
| `suggestions`<sup>*_required_</sup> | ```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)


2 changes: 1 addition & 1 deletion docs/ErrorResponseError.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Contains information about an error that occurred.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
| `error_msg`<sup>*_required_</sup> | ```str``` | Message describing an error. | |
| `error_name`<sup>*_required_</sup> | ```str``` | Name of the error. | |
| `error_name`<sup>*_required_</sup> | ```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)
Expand Down
1 change: 1 addition & 0 deletions docs/FaxResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
| `sender`<sup>*_required_</sup> | ```str``` | Fax Sender Email | |
| `files_url`<sup>*_required_</sup> | ```str``` | Fax Files URL | |
| `transmissions`<sup>*_required_</sup> | [```List[FaxResponseTransmission]```](FaxResponseTransmission.md) | Fax Transmissions List | |
| `test_mode`<sup>*_required_</sup> | ```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 | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
1 change: 1 addition & 0 deletions docs/SignatureRequestBulkSendWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
1 change: 1 addition & 0 deletions docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&#39;s information during signing.<br><br>**NOTE:** Keep your signer&#39;s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] |
| `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |

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

Expand Down
1 change: 1 addition & 0 deletions docs/SignatureRequestSendWithTemplateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
11 changes: 10 additions & 1 deletion dropbox_sign/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
""" # noqa: E501


__version__ = "1.13.0"
__version__ = "1.14.0"

# import apis into sdk package
from dropbox_sign.apis import *
Expand Down Expand Up @@ -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 (
Expand Down
1 change: 1 addition & 0 deletions dropbox_sign/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading