dropbox-sign 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f9c82135d14ebed022ffbf2c5c97da90e03b45182bbf9f9aa8af5ce647fa066
-  data.tar.gz: 41ff5d35a8f10c21c77130429297857d679a0711700301d7b3632280e6163a51
+  metadata.gz: 66c64680be83c560ae134f58c13ca3a3a41fff2f82f00ef5e566a7bdcad28813
+  data.tar.gz: 73c5200e2b3c56a7b0932fe54d3b73fa30ac9ebd9245d8ee9e95012ef16389df
 SHA512:
-  metadata.gz: 69642272372050900aeb9421cd424341f4cd2496d58b144355ef01aac023eb047471790382b8f3f291984f1f2bd817f15c6dc67b2d153388e3dbff159c28e6e1
-  data.tar.gz: dbc743ceb70dd1f85329363d6a5401ed0739138257bbc524af8a3abc23995d144087dd5779a23485e2260fce637ad9acd4c2da0ba32de000112555abadc8fae0
+  metadata.gz: '009500eee44aae84325a1ed8dcb28db787461dc5175ecba11eb7476d5faed8585785e583659205f08668ea4742777384ed4e70dc123336f4a40c18d114c57848'
+  data.tar.gz: 30bac0e87d605a0c0e0e359c74b76d6639b5d2c9464b793f1f91a090e79e7d17f9c730fd8a15ca71915e8ac33ef0fd5d9679f51aada04ae682039e8760216794

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dropbox-sign (1.14.0)
+    dropbox-sign (1.15.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -25,7 +25,7 @@ directory that corresponds to the file you want updated.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 3.0.0
-- Package version: 1.14.0
+- Package version: 1.15.0
 - Generator version: 7.12.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./dropbox-sign-1.14.0.gem
+gem install ./dropbox-sign-1.15.0.gem
 ```
 
-(for development, run `gem install --dev ./dropbox-sign-1.14.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dropbox-sign-1.15.0.gem` to install the development dependencies)
 
 
 Finally add this to the Gemfile:
 
-    gem 'dropbox-sign', '~> 1.14.0'
+    gem 'dropbox-sign', '~> 1.15.0'
 
 ### Install from Git
 
@@ -118,6 +118,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
 |*Dropbox::Sign::ApiAppApi* | [**api_app_update**](docs/ApiAppApi.md#api_app_update) | **PUT** /api_app/{client_id} | Update API App |
 |*Dropbox::Sign::BulkSendJobApi* | [**bulk_send_job_get**](docs/BulkSendJobApi.md#bulk_send_job_get) | **GET** /bulk_send_job/{bulk_send_job_id} | Get Bulk Send Job |
 |*Dropbox::Sign::BulkSendJobApi* | [**bulk_send_job_list**](docs/BulkSendJobApi.md#bulk_send_job_list) | **GET** /bulk_send_job/list | List Bulk Send Jobs |
+|*Dropbox::Sign::DocumentApi* | [**document_detect_fields**](docs/DocumentApi.md#document_detect_fields) | **POST** /document/detect_fields | Detect Document Fields |
 |*Dropbox::Sign::EmbeddedApi* | [**embedded_edit_url**](docs/EmbeddedApi.md#embedded_edit_url) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL |
 |*Dropbox::Sign::EmbeddedApi* | [**embedded_sign_url**](docs/EmbeddedApi.md#embedded_sign_url) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL |
 |*Dropbox::Sign::FaxApi* | [**fax_delete**](docs/FaxApi.md#fax_delete) | **DELETE** /fax/{fax_id} | Delete Fax |
@@ -209,6 +210,9 @@ All URIs are relative to *https://api.hellosign.com/v3*
  - [Dropbox::Sign::BulkSendJobListResponse](docs/BulkSendJobListResponse.md)
  - [Dropbox::Sign::BulkSendJobResponse](docs/BulkSendJobResponse.md)
  - [Dropbox::Sign::BulkSendJobSendResponse](docs/BulkSendJobSendResponse.md)
+ - [Dropbox::Sign::DocumentFieldDetectionRequest](docs/DocumentFieldDetectionRequest.md)
+ - [Dropbox::Sign::DocumentFieldDetectionResponse](docs/DocumentFieldDetectionResponse.md)
+ - [Dropbox::Sign::DocumentFieldDetectionResponseDetectionResult](docs/DocumentFieldDetectionResponseDetectionResult.md)
  - [Dropbox::Sign::EmbeddedEditUrlRequest](docs/EmbeddedEditUrlRequest.md)
  - [Dropbox::Sign::EmbeddedEditUrlResponse](docs/EmbeddedEditUrlResponse.md)
  - [Dropbox::Sign::EmbeddedEditUrlResponseEmbedded](docs/EmbeddedEditUrlResponseEmbedded.md)

data/VERSION

@@ -1 +1 @@
-1.14.0
+1.15.0

data/docs/DocumentApi.md

@@ -0,0 +1,82 @@
+# 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.
+
+### Examples
+
+```ruby
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+document_field_detection_request = Dropbox::Sign::DocumentFieldDetectionRequest.new
+document_field_detection_request.detection_mode = "annotations"
+document_field_detection_request.file = File.new("./example_document.pdf", "r")
+document_field_detection_request.page_range = "all"
+
+begin
+  response = Dropbox::Sign::DocumentApi.new.document_detect_fields(
+    document_field_detection_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling DocumentApi#document_detect_fields: #{e}"
+end
+
+```
+
+#### Using the `document_detect_fields_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<DocumentFieldDetectionResponse>, Integer, Hash)> document_detect_fields_with_http_info(document_field_detection_request)`
+
+```ruby
+begin
+  # Detect Document Fields
+  data, status_code, headers = api_instance.document_detect_fields_with_http_info(document_field_detection_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DocumentFieldDetectionResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling DocumentApi->document_detect_fields_with_http_info: #{e}"
+end
+```
+
+### 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
+

data/docs/DocumentFieldDetectionRequest.md

@@ -0,0 +1,13 @@
+# Dropbox::Sign::DocumentFieldDetectionRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `detection_mode`<sup>*_required_</sup> | ```String``` |  The field detection method to use. Set to `annotations` to detect PDF form annotations or `text_tags` to detect Dropbox Sign text tags.  |  |
+| `file` | ```File``` |  The PDF file to analyze.<br><br>This endpoint requires either `file` or `file_url`, but not both.  |  |
+| `file_url` | ```String``` |  The URL of the PDF file to analyze.<br><br>This endpoint requires either `file` or `file_url`, but not both.  |  |
+| `page_range` | ```String``` |  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`.  |  |
+

data/docs/DocumentFieldDetectionResponse.md

@@ -0,0 +1,11 @@
+# Dropbox::Sign::DocumentFieldDetectionResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `detection_result`<sup>*_required_</sup> | [```DocumentFieldDetectionResponseDetectionResult```](DocumentFieldDetectionResponseDetectionResult.md) |    |  |
+| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) |  A list of warnings.  |  |
+

data/docs/DocumentFieldDetectionResponseDetectionResult.md

@@ -0,0 +1,19 @@
+# Dropbox::Sign::DocumentFieldDetectionResponseDetectionResult
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `document_hash`<sup>*_required_</sup> | ```String``` |  The SHA-256 hash of the analyzed document.  |  |
+| `detection_mode`<sup>*_required_</sup> | ```String``` |  The field detection method used to analyze the document: `annotations` or `text_tags`.  |  |
+| `page_count`<sup>*_required_</sup> | ```Integer``` |  The total number of pages in the document.  |  |
+| `pages_analyzed`<sup>*_required_</sup> | ```String``` |  The zero-based page indexes analyzed, represented by the requested `page_range`, or `all` when every page was analyzed.  |  |
+| `detected_at`<sup>*_required_</sup> | ```Integer``` |  The Unix timestamp when the field detection result was generated.  |  |
+| `form_fields_per_document`<sup>*_required_</sup> | [```Array<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> | [```Array<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> | [```Array<WarningResponse>```](WarningResponse.md) |  Non-fatal issues encountered during field detection.  |  |
+| `errors`<sup>*_required_</sup> | [```Array<ErrorResponseError>```](ErrorResponseError.md) |  Errors encountered during field detection. Successfully detected fields may still be included in the response.  |  |
+| `suggestions`<sup>*_required_</sup> | ```Array<String>``` |  Suggestions for improving the field detection results.  |  |
+

data/docs/FaxResponse.md

@@ -14,6 +14,7 @@
 | `sender`<sup>*_required_</sup> | ```String``` |  Fax Sender Email  |  |
 | `files_url`<sup>*_required_</sup> | ```String``` |  Fax Files URL  |  |
 | `transmissions`<sup>*_required_</sup> | [```Array<FaxResponseTransmission>```](FaxResponseTransmission.md) |  Fax Transmissions List  |  |
+| `test_mode`<sup>*_required_</sup> | ```Boolean``` |  Whether this is a test fax. Test faxes are not delivered to the recipient. Defaults to `false`.  |  [default to false] |
 | `subject` | ```String``` |  Fax Subject  |  |
 | `message` | ```String``` |  Fax Message  |  |
 | `final_copy_uri` | ```String``` |  The path where the completed document can be downloaded  |  |

data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md

@@ -19,4 +19,5 @@
 | `subject` | ```String``` |  The subject in the email that will be sent to the signers.  |  |
 | `test_mode` | ```Boolean``` |  Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.  |  [default to false] |
 | `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
+| `expires_at` | ```Integer``` |  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.  |  |
 

data/docs/SignatureRequestBulkSendWithTemplateRequest.md

@@ -19,4 +19,5 @@
 | `subject` | ```String``` |  The subject in the email that will be sent to the signers.  |  |
 | `test_mode` | ```Boolean``` |  Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.  |  [default to false] |
 | `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
+| `expires_at` | ```Integer``` |  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.  |  |
 

data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md

@@ -21,4 +21,5 @@
 | `test_mode` | ```Boolean``` |  Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.  |  [default to false] |
 | `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
 | `populate_auto_fill_fields` | ```Boolean``` |  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` | ```Integer``` |  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.  |  |
 

data/docs/SignatureRequestSendWithTemplateRequest.md

@@ -23,4 +23,5 @@
 | `subject` | ```String``` |  The subject in the email that will be sent to the signers.  |  |
 | `test_mode` | ```Boolean``` |  Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.  |  [default to false] |
 | `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
+| `expires_at` | ```Integer``` |  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.  |  |
 

data/examples/DocumentDetectFieldsExample.rb

@@ -0,0 +1,22 @@
+require "json"
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  config.username = "YOUR_API_KEY"
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+document_field_detection_request = Dropbox::Sign::DocumentFieldDetectionRequest.new
+document_field_detection_request.detection_mode = "annotations"
+document_field_detection_request.file = File.new("./example_document.pdf", "r")
+document_field_detection_request.page_range = "all"
+
+begin
+  response = Dropbox::Sign::DocumentApi.new.document_detect_fields(
+    document_field_detection_request,
+  )
+
+  p response
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling DocumentApi#document_detect_fields: #{e}"
+end

data/lib/dropbox-sign/api/account_api.rb

@@ -24,6 +24,7 @@ module Dropbox::Sign
     end
     # Create Account
     # Creates a new Dropbox Sign Account that is associated with the specified `email_address`.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountCreateExample.rb
     # @param account_create_request [AccountCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AccountCreateResponse]
@@ -34,6 +35,7 @@ module Dropbox::Sign
 
     # Create Account
     # Creates a new Dropbox Sign Account that is associated with the specified `email_address`.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountCreateExample.rb
     # @param account_create_request [AccountCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountCreateResponse, Integer, Hash)>] AccountCreateResponse data, response status code and response headers
@@ -134,6 +136,7 @@ module Dropbox::Sign
 
     # Get Account
     # Returns the properties and settings of your Account.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountGetExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [String] :account_id &#x60;account_id&#x60; or &#x60;email_address&#x60; is required. If both are provided, the account id prevails.  The ID of the Account.
     # @option opts [String] :email_address &#x60;account_id&#x60; or &#x60;email_address&#x60; is required, If both are provided, the account id prevails.  The email address of the Account.
@@ -145,6 +148,7 @@ module Dropbox::Sign
 
     # Get Account
     # Returns the properties and settings of your Account.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountGetExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [String] :account_id &#x60;account_id&#x60; or &#x60;email_address&#x60; is required. If both are provided, the account id prevails.  The ID of the Account.
     # @option opts [String] :email_address &#x60;account_id&#x60; or &#x60;email_address&#x60; is required, If both are provided, the account id prevails.  The email address of the Account.
@@ -229,6 +233,7 @@ module Dropbox::Sign
 
     # Update Account
     # 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-ruby/blob/main/examples/AccountUpdateExample.rb
     # @param account_update_request [AccountUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AccountGetResponse]
@@ -239,6 +244,7 @@ module Dropbox::Sign
 
     # Update Account
     # 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-ruby/blob/main/examples/AccountUpdateExample.rb
     # @param account_update_request [AccountUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountGetResponse, Integer, Hash)>] AccountGetResponse data, response status code and response headers
@@ -339,6 +345,7 @@ module Dropbox::Sign
 
     # Verify Account
     # Verifies whether an Dropbox Sign Account exists for the given email address.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountVerifyExample.rb
     # @param account_verify_request [AccountVerifyRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AccountVerifyResponse]
@@ -349,6 +356,7 @@ module Dropbox::Sign
 
     # Verify Account
     # Verifies whether an Dropbox Sign Account exists for the given email address.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/AccountVerifyExample.rb
     # @param account_verify_request [AccountVerifyRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AccountVerifyResponse, Integer, Hash)>] AccountVerifyResponse data, response status code and response headers

data/lib/dropbox-sign/api/api_app_api.rb

@@ -24,6 +24,7 @@ module Dropbox::Sign
     end
     # Create API App
     # Creates a new API App.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppCreateExample.rb
     # @param api_app_create_request [ApiAppCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ApiAppGetResponse]
@@ -34,6 +35,7 @@ module Dropbox::Sign
 
     # Create API App
     # Creates a new API App.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppCreateExample.rb
     # @param api_app_create_request [ApiAppCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApiAppGetResponse, Integer, Hash)>] ApiAppGetResponse data, response status code and response headers
@@ -134,6 +136,7 @@ module Dropbox::Sign
 
     # Delete API App
     # Deletes an API App. Can only be invoked for apps you own.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppDeleteExample.rb
     # @param client_id [String] The client id of the API App to delete.
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -144,6 +147,7 @@ module Dropbox::Sign
 
     # Delete API App
     # Deletes an API App. Can only be invoked for apps you own.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppDeleteExample.rb
     # @param client_id [String] The client id of the API App to delete.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -202,6 +206,7 @@ module Dropbox::Sign
 
     # Get API App
     # Returns an object with information about an API App.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppGetExample.rb
     # @param client_id [String] The client id of the API App to retrieve.
     # @param [Hash] opts the optional parameters
     # @return [ApiAppGetResponse]
@@ -212,6 +217,7 @@ module Dropbox::Sign
 
     # Get API App
     # Returns an object with information about an API App.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ApiAppGetExample.rb
     # @param client_id [String] The client id of the API App to retrieve.
     # @param [Hash] opts the optional parameters
     # @return [Array<(ApiAppGetResponse, Integer, Hash)>] ApiAppGetResponse data, response status code and response headers
@@ -297,6 +303,7 @@ module Dropbox::Sign
 
     # List API Apps
     # 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-ruby/blob/main/examples/ApiAppListExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Which page number of the API App List to return. Defaults to &#x60;1&#x60;. (default to 1)
     # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;. (default to 20)
@@ -308,6 +315,7 @@ module Dropbox::Sign
 
     # List API Apps
     # 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-ruby/blob/main/examples/ApiAppListExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Which page number of the API App List to return. Defaults to &#x60;1&#x60;. (default to 1)
     # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;. (default to 20)
@@ -392,6 +400,7 @@ module Dropbox::Sign
 
     # Update API App
     # 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-ruby/blob/main/examples/ApiAppUpdateExample.rb
     # @param client_id [String] The client id of the API App to update.
     # @param api_app_update_request [ApiAppUpdateRequest] 
     # @param [Hash] opts the optional parameters
@@ -403,6 +412,7 @@ module Dropbox::Sign
 
     # Update API App
     # 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-ruby/blob/main/examples/ApiAppUpdateExample.rb
     # @param client_id [String] The client id of the API App to update.
     # @param api_app_update_request [ApiAppUpdateRequest] 
     # @param [Hash] opts the optional parameters

data/lib/dropbox-sign/api/bulk_send_job_api.rb

@@ -24,6 +24,7 @@ module Dropbox::Sign
     end
     # Get Bulk Send Job
     # Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/BulkSendJobGetExample.rb
     # @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to `1`. (default to 1)
@@ -36,6 +37,7 @@ module Dropbox::Sign
 
     # Get Bulk Send Job
     # Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/BulkSendJobGetExample.rb
     # @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to `1`. (default to 1)
@@ -125,6 +127,7 @@ module Dropbox::Sign
 
     # List Bulk Send Jobs
     # Returns a list of BulkSendJob that you can access.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/BulkSendJobListExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Which page number of the BulkSendJob List to return. Defaults to `1`. (default to 1)
     # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (default to 20)
@@ -136,6 +139,7 @@ module Dropbox::Sign
 
     # List Bulk Send Jobs
     # Returns a list of BulkSendJob that you can access.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/BulkSendJobListExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Which page number of the BulkSendJob List to return. Defaults to `1`. (default to 1)
     # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (default to 20)

data/lib/dropbox-sign/api/document_api.rb

@@ -0,0 +1,137 @@
+=begin
+#Dropbox Sign API
+
+#Dropbox Sign v3 API
+
+The version of the OpenAPI document: 3.0.0
+Contact: apisupport@hellosign.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'cgi'
+
+module Dropbox
+end
+
+module Dropbox::Sign
+  class DocumentApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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-ruby/blob/main/examples/DocumentDetectFieldsExample.rb
+    # @param document_field_detection_request [DocumentFieldDetectionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [DocumentFieldDetectionResponse]
+    def document_detect_fields(document_field_detection_request, opts = {})
+      data, _status_code, _headers = document_detect_fields_with_http_info(document_field_detection_request, opts)
+      data
+    end
+
+    # 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-ruby/blob/main/examples/DocumentDetectFieldsExample.rb
+    # @param document_field_detection_request [DocumentFieldDetectionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DocumentFieldDetectionResponse, Integer, Hash)>] DocumentFieldDetectionResponse data, response status code and response headers
+    def document_detect_fields_with_http_info(document_field_detection_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DocumentApi.document_detect_fields ...'
+      end
+      # verify the required parameter 'document_field_detection_request' is set
+      if @api_client.config.client_side_validation && document_field_detection_request.nil?
+        fail ArgumentError, "Missing the required parameter 'document_field_detection_request' when calling DocumentApi.document_detect_fields"
+      end
+      # resource path
+      local_var_path = '/document/detect_fields'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      post_body = {}
+      form_params = opts[:form_params] || {}
+      result = @api_client.generate_form_data(
+        document_field_detection_request,
+        Dropbox::Sign::DocumentFieldDetectionRequest.openapi_types
+      )
+
+      # form parameters
+      if result[:has_file]
+        form_params = opts[:form_params] || result[:params]
+        header_params['Content-Type'] = 'multipart/form-data'
+      else
+        # http body (model)
+        post_body = opts[:debug_body] || result[:params]
+      end
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DocumentFieldDetectionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
+
+      new_options = opts.merge(
+        :operation => :"DocumentApi.document_detect_fields",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      begin
+        data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      rescue Dropbox::Sign::ApiError => e
+        if e.code === 200
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::DocumentFieldDetectionResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+        range_code = "4XX".split('').first
+        range_code_left = "#{range_code}00".to_i
+        range_code_right = "#{range_code}99".to_i
+        if e.code && e.code >= range_code_left && e.code <= range_code_right
+          body = @api_client.convert_to_type(
+            JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
+            "Dropbox::Sign::ErrorResponse"
+          )
+
+          fail ApiError.new(:code => e.code,
+                            :response_headers => e.response_headers,
+                            :response_body => body),
+               e.message
+        end
+
+        raise e
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DocumentApi#document_detect_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/dropbox-sign/api/embedded_api.rb

@@ -24,6 +24,7 @@ module Dropbox::Sign
     end
     # Get Embedded Template 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-ruby/blob/main/examples/EmbeddedEditUrlExample.rb
     # @param template_id [String] The id of the template to edit.
     # @param embedded_edit_url_request [EmbeddedEditUrlRequest] 
     # @param [Hash] opts the optional parameters
@@ -35,6 +36,7 @@ module Dropbox::Sign
 
     # Get Embedded Template 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-ruby/blob/main/examples/EmbeddedEditUrlExample.rb
     # @param template_id [String] The id of the template to edit.
     # @param embedded_edit_url_request [EmbeddedEditUrlRequest] 
     # @param [Hash] opts the optional parameters
@@ -140,6 +142,7 @@ module Dropbox::Sign
 
     # Get 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-ruby/blob/main/examples/EmbeddedSignUrlExample.rb
     # @param signature_id [String] The id of the signature to get a signature url for.
     # @param [Hash] opts the optional parameters
     # @return [EmbeddedSignUrlResponse]
@@ -150,6 +153,7 @@ module Dropbox::Sign
 
     # Get 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-ruby/blob/main/examples/EmbeddedSignUrlExample.rb
     # @param signature_id [String] The id of the signature to get a signature url for.
     # @param [Hash] opts the optional parameters
     # @return [Array<(EmbeddedSignUrlResponse, Integer, Hash)>] EmbeddedSignUrlResponse data, response status code and response headers