|
| 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 | +
|
0 commit comments