Release 1.14.0

README.md

@@ -55,7 +55,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.dropbox.sign</groupId>
   <artifactId>dropbox-sign</artifactId>
-  <version>1.13.0</version>
+  <version>1.14.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -71,7 +71,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-     implementation "com.dropbox.sign:dropbox-sign:1.13.0"
+     implementation "com.dropbox.sign:dropbox-sign:1.14.0"
   }
 ```
 
@@ -85,7 +85,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-- `target/dropbox-sign-1.13.0.jar`
+- `target/dropbox-sign-1.14.0.jar`
 - `target/lib/*.jar`
 
 ## Getting Started
@@ -185,6 +185,7 @@ Class | Method | HTTP request | Description
 *ApiAppApi* | [**apiAppUpdate**](docs/ApiAppApi.md#apiAppUpdate) | **PUT** /api_app/{client_id} | Update API App
 *BulkSendJobApi* | [**bulkSendJobGet**](docs/BulkSendJobApi.md#bulkSendJobGet) | **GET** /bulk_send_job/{bulk_send_job_id} | Get Bulk Send Job
 *BulkSendJobApi* | [**bulkSendJobList**](docs/BulkSendJobApi.md#bulkSendJobList) | **GET** /bulk_send_job/list | List Bulk Send Jobs
+*DocumentApi* | [**documentDetectFields**](docs/DocumentApi.md#documentDetectFields) | **POST** /document/detect_fields | Detect Document Fields
 *EmbeddedApi* | [**embeddedEditUrl**](docs/EmbeddedApi.md#embeddedEditUrl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL
 *EmbeddedApi* | [**embeddedSignUrl**](docs/EmbeddedApi.md#embeddedSignUrl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL
 *FaxApi* | [**faxDelete**](docs/FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax
@@ -276,6 +277,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)
@@ -477,7 +481,7 @@ apisupport@hellosign.com
 This Java 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.JavaClientCodegen`
 
 

VERSION

@@ -1 +1 @@
-1.13.0
+1.14.0

build.gradle

@@ -7,7 +7,7 @@ plugins {
 }
 
 group = 'com.dropbox.sign'
-version = '1.13.0'
+version = '1.14.0'
 
 base {
     archivesName.set('dropbox-sign')

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.dropbox.sign",
     name := "dropbox-sign",
-    version := "1.13.0",
+    version := "1.14.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     Compile / javacOptions ++= Seq("-Xlint:deprecation"),

docs/DocumentApi.md

@@ -0,0 +1,96 @@
+# DocumentApi
+
+All URIs are relative to *https://api.hellosign.com/v3*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+[**documentDetectFields**](DocumentApi.md#documentDetectFields) | **POST** /document/detect_fields | Detect Document Fields
+
+
+
+## documentDetectFields
+
+> DocumentFieldDetectionResponse documentDetectFields(documentFieldDetectionRequest)
+
+Detect Document Fields
+
+Detects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags.
+
+### Example
+
+```java
+package com.dropbox.sign_sandbox;
+
+import com.dropbox.sign.ApiException;
+import com.dropbox.sign.Configuration;
+import com.dropbox.sign.api.*;
+import com.dropbox.sign.auth.*;
+import com.dropbox.sign.JSON;
+import com.dropbox.sign.model.*;
+
+import java.io.File;
+import java.math.BigDecimal;
+import java.time.LocalDate;
+import java.time.OffsetDateTime;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+public class DocumentDetectFieldsExample
+{
+    public static void main(String[] args)
+    {
+        var config = Configuration.getDefaultApiClient();
+        ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY");
+        // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN");
+
+        var documentFieldDetectionRequest = new DocumentFieldDetectionRequest();
+        documentFieldDetectionRequest.detectionMode("annotations");
+        documentFieldDetectionRequest._file(new File("./example_document.pdf"));
+        documentFieldDetectionRequest.pageRange("all");
+
+        try
+        {
+            var response = new DocumentApi(config).documentDetectFields(
+                documentFieldDetectionRequest
+            );
+
+            System.out.println(response);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DocumentApi#documentDetectFields");
+            System.err.println("Status code: " + e.getCode());
+            System.err.println("Reason: " + e.getResponseBody());
+            System.err.println("Response headers: " + e.getResponseHeaders());
+            e.printStackTrace();
+        }
+    }
+}
+
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+ **documentFieldDetectionRequest** | [**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 |  -  |
+

docs/DocumentFieldDetectionRequest.md

@@ -0,0 +1,17 @@
+
+
+# DocumentFieldDetectionRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `detectionMode`<sup>*_required_</sup> | [```String```](String.md) |  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.  |  |
+| `fileUrl` | ```URI``` |  The URL of the PDF file to analyze.<br><br>This endpoint requires either `file` or `file_url`, but not both.  |  |
+| `pageRange` | ```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`.  |  |
+
+
+

docs/DocumentFieldDetectionResponse.md

@@ -0,0 +1,15 @@
+
+
+# DocumentFieldDetectionResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `detectionResult`<sup>*_required_</sup> | [```DocumentFieldDetectionResponseDetectionResult```](DocumentFieldDetectionResponseDetectionResult.md) |    |  |
+| `warnings` | [```List<WarningResponse>```](WarningResponse.md) |  A list of warnings.  |  |
+
+
+

docs/DocumentFieldDetectionResponseDetectionResult.md

@@ -0,0 +1,23 @@
+
+
+# DocumentFieldDetectionResponseDetectionResult
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `documentHash`<sup>*_required_</sup> | ```String``` |  The SHA-256 hash of the analyzed document.  |  |
+| `detectionMode`<sup>*_required_</sup> | [```String```](String.md) |  The field detection method used to analyze the document: `annotations` or `text_tags`.  |  |
+| `pageCount`<sup>*_required_</sup> | ```Integer``` |  The total number of pages in the document.  |  |
+| `pagesAnalyzed`<sup>*_required_</sup> | ```String``` |  The zero-based page indexes analyzed, represented by the requested `page_range`, or `all` when every page was analyzed.  |  |
+| `detectedAt`<sup>*_required_</sup> | ```Long``` |  The Unix timestamp when the field detection result was generated.  |  |
+| `formFieldsPerDocument`<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`  |  |
+| `formFieldGroups`<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<String>``` |  Suggestions for improving the field detection results.  |  |
+
+
+

docs/ErrorResponseError.md

@@ -9,7 +9,7 @@ Contains information about an error that occurred.
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 | `errorMsg`<sup>*_required_</sup> | ```String``` |  Message describing an error.  |  |
-| `errorName`<sup>*_required_</sup> | ```String``` |  Name of the error.  |  |
+| `errorName`<sup>*_required_</sup> | ```String``` |  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.  |  |
 | `errorPath` | ```String``` |  Path at which an error occurred.  |  |
 
 

docs/EventCallbackRequestEvent.md

@@ -42,6 +42,13 @@ Basic information about the event that occurred.
 | TEMPLATE_ERROR | "template_error" |
 | CALLBACK_TEST | "callback_test" |
 | SIGNATURE_REQUEST_SIGNER_REMOVED | "signature_request_signer_removed" |
+| FAX_RECEIVED | "fax_received" |
+| FAX_SENT | "fax_sent" |
+| FAX_ON_HOLD | "fax_on_hold" |
+| FAX_BUSY | "fax_busy" |
+| FAX_NO_ANSWER | "fax_no_answer" |
+| FAX_DISCONNECTED | "fax_disconnected" |
+| FAX_BLACKLISTED | "fax_blacklisted" |
 
 
 

docs/FaxResponse.md

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

docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md

@@ -21,6 +21,7 @@
 | `subject` | ```String``` |  The subject in the email that will be sent to the signers.  |  |
 | `testMode` | ```Boolean``` |  Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.  |  |
 | `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
+| `expiresAt` | ```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.  |  |
 
 
 

docs/SignatureRequestBulkSendWithTemplateRequest.md

@@ -21,6 +21,7 @@
 | `subject` | ```String``` |  The subject in the email that will be sent to the signers.  |  |
 | `testMode` | ```Boolean``` |  Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.  |  |
 | `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
+| `expiresAt` | ```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.  |  |
 
 
 

docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md

@@ -23,6 +23,7 @@
 | `testMode` | ```Boolean``` |  Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.  |  |
 | `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
 | `populateAutoFillFields` | ```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.  |  |
+| `expiresAt` | ```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.  |  |
 
 
 

docs/SignatureRequestSendWithTemplateRequest.md

@@ -25,6 +25,7 @@
 | `subject` | ```String``` |  The subject in the email that will be sent to the signers.  |  |
 | `testMode` | ```Boolean``` |  Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.  |  |
 | `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
+| `expiresAt` | ```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.  |  |
 
 
 

examples/DocumentDetectFieldsExample.java

@@ -0,0 +1,46 @@
+package com.dropbox.sign_sandbox;
+
+import com.dropbox.sign.ApiException;
+import com.dropbox.sign.Configuration;
+import com.dropbox.sign.api.*;
+import com.dropbox.sign.auth.*;
+import com.dropbox.sign.JSON;
+import com.dropbox.sign.model.*;
+
+import java.io.File;
+import java.math.BigDecimal;
+import java.time.LocalDate;
+import java.time.OffsetDateTime;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+public class DocumentDetectFieldsExample
+{
+    public static void main(String[] args)
+    {
+        var config = Configuration.getDefaultApiClient();
+        ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY");
+        // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN");
+
+        var documentFieldDetectionRequest = new DocumentFieldDetectionRequest();
+        documentFieldDetectionRequest.detectionMode("annotations");
+        documentFieldDetectionRequest._file(new File("./example_document.pdf"));
+        documentFieldDetectionRequest.pageRange("all");
+
+        try
+        {
+            var response = new DocumentApi(config).documentDetectFields(
+                documentFieldDetectionRequest
+            );
+
+            System.out.println(response);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DocumentApi#documentDetectFields");
+            System.err.println("Status code: " + e.getCode());
+            System.err.println("Reason: " + e.getResponseBody());
+            System.err.println("Response headers: " + e.getResponseHeaders());
+            e.printStackTrace();
+        }
+    }
+}

gradle.properties

@@ -6,7 +6,7 @@
 #target = android
 GROUP=com.dropbox.sign
 POM_ARTIFACT_ID=dropbox-sign
-VERSION_NAME=1.13.0
+VERSION_NAME=1.14.0
 
 POM_NAME=Dropbox Sign Java SDK
 POM_DESCRIPTION=Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds!

openapi-config.yaml

@@ -16,7 +16,7 @@ additionalProperties:
   groupId: com.dropbox.sign
   artifactId: dropbox-sign
   artifactName: Dropbox Sign Java SDK
-  artifactVersion: "1.13.0"
+  artifactVersion: "1.14.0"
   artifactUrl: https://github.com/hellosign/dropbox-sign-java
   artifactDescription: Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds!
   scmConnection: scm:git:git://github.com/hellosign/dropbox-sign-java.git