Skip to content

Commit e325917

Browse files
Merge pull request #27 from hellosign/release-1.14.0
Release 1.14.0
2 parents 68905c0 + bf1a9c4 commit e325917

49 files changed

Lines changed: 2539 additions & 118 deletions

Some content is hidden

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

‎README.md‎

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

5151
```shell
52-
python3 -m pip install dropbox-sign==1.13.0
52+
python3 -m pip install dropbox-sign==1.14.0
5353
```
5454

5555
Alternatively:
@@ -114,6 +114,7 @@ Class | Method | HTTP request | Description
114114
```ApiAppApi``` | [```api_app_update```](docs/ApiAppApi.md#api_app_update) | ```PUT /api_app/{client_id}``` | Update API App|
115115
|```BulkSendJobApi``` | [```bulk_send_job_get```](docs/BulkSendJobApi.md#bulk_send_job_get) | ```GET /bulk_send_job/{bulk_send_job_id}``` | Get Bulk Send Job|
116116
```BulkSendJobApi``` | [```bulk_send_job_list```](docs/BulkSendJobApi.md#bulk_send_job_list) | ```GET /bulk_send_job/list``` | List Bulk Send Jobs|
117+
|```DocumentApi``` | [```document_detect_fields```](docs/DocumentApi.md#document_detect_fields) | ```POST /document/detect_fields``` | Detect Document Fields|
117118
|```EmbeddedApi``` | [```embedded_edit_url```](docs/EmbeddedApi.md#embedded_edit_url) | ```POST /embedded/edit_url/{template_id}``` | Get Embedded Template Edit URL|
118119
```EmbeddedApi``` | [```embedded_sign_url```](docs/EmbeddedApi.md#embedded_sign_url) | ```GET /embedded/sign_url/{signature_id}``` | Get Embedded Sign URL|
119120
|```FaxApi``` | [```fax_delete```](docs/FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax|
@@ -205,6 +206,9 @@ Class | Method | HTTP request | Description
205206
- [BulkSendJobListResponse](docs/BulkSendJobListResponse.md)
206207
- [BulkSendJobResponse](docs/BulkSendJobResponse.md)
207208
- [BulkSendJobSendResponse](docs/BulkSendJobSendResponse.md)
209+
- [DocumentFieldDetectionRequest](docs/DocumentFieldDetectionRequest.md)
210+
- [DocumentFieldDetectionResponse](docs/DocumentFieldDetectionResponse.md)
211+
- [DocumentFieldDetectionResponseDetectionResult](docs/DocumentFieldDetectionResponseDetectionResult.md)
208212
- [EmbeddedEditUrlRequest](docs/EmbeddedEditUrlRequest.md)
209213
- [EmbeddedEditUrlResponse](docs/EmbeddedEditUrlResponse.md)
210214
- [EmbeddedEditUrlResponseEmbedded](docs/EmbeddedEditUrlResponseEmbedded.md)
@@ -400,6 +404,6 @@ apisupport@hellosign.com
400404
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
401405

402406
- API version: 3.0.0
403-
- Package version: 1.13.0
407+
- Package version: 1.14.0
404408
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
405409

‎VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.13.0
1+
1.14.0

‎docs/DocumentApi.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# ```dropbox_sign.DocumentApi```
2+
3+
All URIs are relative to *https://api.hellosign.com/v3*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
|[```document_detect_fields```](DocumentApi.md#document_detect_fields) | ```POST /document/detect_fields``` | Detect Document Fields|
8+
9+
10+
# ```document_detect_fields```
11+
> ```DocumentFieldDetectionResponse document_detect_fields(document_field_detection_request)```
12+
13+
Detect Document Fields
14+
15+
Detects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags.
16+
17+
### Example
18+
19+
* Basic Authentication (api_key):
20+
* Bearer (JWT) Authentication (oauth2):
21+
22+
```python
23+
import json
24+
from datetime import date, datetime
25+
from pprint import pprint
26+
27+
from dropbox_sign import ApiClient, ApiException, Configuration, api, models
28+
29+
configuration = Configuration(
30+
username="YOUR_API_KEY",
31+
# access_token="YOUR_ACCESS_TOKEN",
32+
)
33+
34+
with ApiClient(configuration) as api_client:
35+
document_field_detection_request = models.DocumentFieldDetectionRequest(
36+
detection_mode="annotations",
37+
file=open("./example_document.pdf", "rb").read(),
38+
page_range="all",
39+
)
40+
41+
try:
42+
response = api.DocumentApi(api_client).document_detect_fields(
43+
document_field_detection_request=document_field_detection_request,
44+
)
45+
46+
pprint(response)
47+
except ApiException as e:
48+
print("Exception when calling DocumentApi#document_detect_fields: %s\n" % e)
49+
50+
```
51+
```
52+
53+
### Parameters
54+
| Name | Type | Description | Notes |
55+
| ---- | ---- | ----------- | ----- |
56+
| `document_field_detection_request` | [**DocumentFieldDetectionRequest**](DocumentFieldDetectionRequest.md) | | |
57+
58+
### Return type
59+
60+
[**DocumentFieldDetectionResponse**](DocumentFieldDetectionResponse.md)
61+
62+
### Authorization
63+
64+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
65+
66+
### HTTP request headers
67+
68+
- **Content-Type**: application/json, multipart/form-data
69+
- **Accept**: application/json
70+
71+
### HTTP response details
72+
73+
| Status code | Description | Response headers |
74+
|-------------|-------------|------------------|
75+
**200** | successful operation | * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> |
76+
**4XX** | failed_operation | - |
77+
78+
[[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)
79+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# DocumentFieldDetectionRequest
2+
3+
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
| `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. | |
9+
| `file` | ```io.IOBase``` | The PDF file to analyze.<br><br>This endpoint requires either `file` or `file_url`, but not both. | |
10+
| `file_url` | ```str``` | The URL of the PDF file to analyze.<br><br>This endpoint requires either `file` or `file_url`, but not both. | |
11+
| `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`. | |
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# DocumentFieldDetectionResponse
2+
3+
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
| `detection_result`<sup>*_required_</sup> | [```DocumentFieldDetectionResponseDetectionResult```](DocumentFieldDetectionResponseDetectionResult.md) | | |
9+
| `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | |
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# DocumentFieldDetectionResponseDetectionResult
2+
3+
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
| `document_hash`<sup>*_required_</sup> | ```str``` | The SHA-256 hash of the analyzed document. | |
9+
| `detection_mode`<sup>*_required_</sup> | ```str``` | The field detection method used to analyze the document: `annotations` or `text_tags`. | |
10+
| `page_count`<sup>*_required_</sup> | ```int``` | The total number of pages in the document. | |
11+
| `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. | |
12+
| `detected_at`<sup>*_required_</sup> | ```int``` | The Unix timestamp when the field detection result was generated. | |
13+
| `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` | |
14+
| `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`. | |
15+
| `warnings`<sup>*_required_</sup> | [```List[WarningResponse]```](WarningResponse.md) | Non-fatal issues encountered during field detection. | |
16+
| `errors`<sup>*_required_</sup> | [```List[ErrorResponseError]```](ErrorResponseError.md) | Errors encountered during field detection. Successfully detected fields may still be included in the response. | |
17+
| `suggestions`<sup>*_required_</sup> | ```List[str]``` | Suggestions for improving the field detection results. | |
18+
19+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
20+
21+

‎docs/ErrorResponseError.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Contains information about an error that occurred.
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
| `error_msg`<sup>*_required_</sup> | ```str``` | Message describing an error. | |
9-
| `error_name`<sup>*_required_</sup> | ```str``` | Name of the error. | |
9+
| `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. | |
1010
| `error_path` | ```str``` | Path at which an error occurred. | |
1111

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

‎docs/FaxResponse.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
| `sender`<sup>*_required_</sup> | ```str``` | Fax Sender Email | |
1414
| `files_url`<sup>*_required_</sup> | ```str``` | Fax Files URL | |
1515
| `transmissions`<sup>*_required_</sup> | [```List[FaxResponseTransmission]```](FaxResponseTransmission.md) | Fax Transmissions List | |
16+
| `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] |
1617
| `subject` | ```str``` | Fax Subject | |
1718
| `message` | ```str``` | Fax Message | |
1819
| `final_copy_uri` | ```str``` | The path where the completed document can be downloaded | |

‎docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
1818
| `subject` | ```str``` | The subject in the email that will be sent to the signers. | |
1919
| `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] |
2020
| `title` | ```str``` | The title you want to assign to the SignatureRequest. | |
21+
| `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. | |
2122

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

‎docs/SignatureRequestBulkSendWithTemplateRequest.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
1818
| `subject` | ```str``` | The subject in the email that will be sent to the signers. | |
1919
| `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] |
2020
| `title` | ```str``` | The title you want to assign to the SignatureRequest. | |
21+
| `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. | |
2122

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

0 commit comments

Comments
 (0)