From 443e3a35119ba7f99e0d63600e8f17a9c00a712a Mon Sep 17 00:00:00 2001 From: Grzegorz Biernacki Date: Mon, 12 Oct 2026 12:02:23 +0200 Subject: [PATCH] Release 2.10.0 --- README.md | 12 +- VERSION | 2 +- build.gradle | 2 +- build.sbt | 2 +- docs/DocumentApi.md | 96 +++ docs/DocumentFieldDetectionRequest.md | 17 + docs/DocumentFieldDetectionResponse.md | 15 + ...ntFieldDetectionResponseDetectionResult.md | 23 + docs/ErrorResponseError.md | 2 +- docs/EventCallbackRequestEvent.md | 7 + docs/FaxResponse.md | 1 + ...stBulkCreateEmbeddedWithTemplateRequest.md | 1 + ...atureRequestBulkSendWithTemplateRequest.md | 1 + ...equestCreateEmbeddedWithTemplateRequest.md | 1 + ...SignatureRequestSendWithTemplateRequest.md | 1 + examples/DocumentDetectFieldsExample.java | 46 + gradle.properties | 2 +- openapi-config.yaml | 2 +- openapi-sdk.yaml | 796 +++++++++++++++--- pom.xml | 2 +- src/main/java/com/dropbox/sign/ApiClient.java | 2 +- .../java/com/dropbox/sign/Configuration.java | 2 +- .../java/com/dropbox/sign/api/AccountApi.java | 8 + .../java/com/dropbox/sign/api/ApiAppApi.java | 10 + .../com/dropbox/sign/api/BulkSendJobApi.java | 4 + .../com/dropbox/sign/api/DocumentApi.java | 116 +++ .../com/dropbox/sign/api/EmbeddedApi.java | 4 + .../java/com/dropbox/sign/api/FaxApi.java | 10 + .../java/com/dropbox/sign/api/FaxLineApi.java | 14 + .../java/com/dropbox/sign/api/OAuthApi.java | 4 + .../java/com/dropbox/sign/api/ReportApi.java | 2 + .../dropbox/sign/api/SignatureRequestApi.java | 40 + .../java/com/dropbox/sign/api/TeamApi.java | 20 + .../com/dropbox/sign/api/TemplateApi.java | 22 + .../dropbox/sign/api/UnclaimedDraftApi.java | 8 + .../model/DocumentFieldDetectionRequest.java | 334 ++++++++ .../model/DocumentFieldDetectionResponse.java | 242 ++++++ ...FieldDetectionResponseDetectionResult.java | 685 +++++++++++++++ .../sign/model/ErrorResponseError.java | 2 +- .../sign/model/EventCallbackRequestEvent.java | 16 +- .../com/dropbox/sign/model/FaxResponse.java | 53 +- ...BulkCreateEmbeddedWithTemplateRequest.java | 57 +- ...ureRequestBulkSendWithTemplateRequest.java | 57 +- ...uestCreateEmbeddedWithTemplateRequest.java | 57 +- ...gnatureRequestSendWithTemplateRequest.java | 57 +- templates/libraries/jersey3/api.mustache | 5 + test_fixtures/FaxGetResponse.json | 3 +- test_fixtures/FaxListResponse.json | 3 +- 48 files changed, 2740 insertions(+), 128 deletions(-) create mode 100644 docs/DocumentApi.md create mode 100644 docs/DocumentFieldDetectionRequest.md create mode 100644 docs/DocumentFieldDetectionResponse.md create mode 100644 docs/DocumentFieldDetectionResponseDetectionResult.md create mode 100644 examples/DocumentDetectFieldsExample.java create mode 100644 src/main/java/com/dropbox/sign/api/DocumentApi.java create mode 100644 src/main/java/com/dropbox/sign/model/DocumentFieldDetectionRequest.java create mode 100644 src/main/java/com/dropbox/sign/model/DocumentFieldDetectionResponse.java create mode 100644 src/main/java/com/dropbox/sign/model/DocumentFieldDetectionResponseDetectionResult.java diff --git a/README.md b/README.md index b71392f..354aa74 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ Add this dependency to your project's POM: com.dropbox.sign dropbox-sign - 2.9.0 + 2.10.0 compile ``` @@ -72,7 +72,7 @@ Add this dependency to your project's build file: } dependencies { - implementation "com.dropbox.sign:dropbox-sign:2.9.0" + implementation "com.dropbox.sign:dropbox-sign:2.10.0" } ``` @@ -86,7 +86,7 @@ mvn clean package Then manually install the following JARs: -- `target/dropbox-sign-2.9.0.jar` +- `target/dropbox-sign-2.10.0.jar` - `target/lib/*.jar` ## Getting Started @@ -161,6 +161,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 @@ -252,6 +253,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) @@ -453,7 +457,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: `2.9.0` + - Package version: `2.10.0` - Build package: `org.openapitools.codegen.languages.JavaClientCodegen` diff --git a/VERSION b/VERSION index c8e38b6..10c2c0c 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.9.0 +2.10.0 diff --git a/build.gradle b/build.gradle index f17a563..46cf25b 100644 --- a/build.gradle +++ b/build.gradle @@ -7,7 +7,7 @@ plugins { } group = 'com.dropbox.sign' -version = '2.9.0' +version = '2.10.0' base { archivesName.set('dropbox-sign') diff --git a/build.sbt b/build.sbt index 3073fdc..f46a7ac 100644 --- a/build.sbt +++ b/build.sbt @@ -2,7 +2,7 @@ lazy val root = (project in file(".")). settings( organization := "com.dropbox.sign", name := "dropbox-sign", - version := "2.9.0", + version := "2.10.0", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), Compile / javacOptions ++= Seq("-Xlint:deprecation"), diff --git a/docs/DocumentApi.md b/docs/DocumentApi.md new file mode 100644 index 0000000..c72d11a --- /dev/null +++ b/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 -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | + diff --git a/docs/DocumentFieldDetectionRequest.md b/docs/DocumentFieldDetectionRequest.md new file mode 100644 index 0000000..482d279 --- /dev/null +++ b/docs/DocumentFieldDetectionRequest.md @@ -0,0 +1,17 @@ + + +# DocumentFieldDetectionRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `detectionMode`*_required_ | [```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.

This endpoint requires either `file` or `file_url`, but not both. | | +| `fileUrl` | ```URI``` | The URL of the PDF file to analyze.

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`. | | + + + diff --git a/docs/DocumentFieldDetectionResponse.md b/docs/DocumentFieldDetectionResponse.md new file mode 100644 index 0000000..2a7329e --- /dev/null +++ b/docs/DocumentFieldDetectionResponse.md @@ -0,0 +1,15 @@ + + +# DocumentFieldDetectionResponse + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `detectionResult`*_required_ | [```DocumentFieldDetectionResponseDetectionResult```](DocumentFieldDetectionResponseDetectionResult.md) | | | +| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | + + + diff --git a/docs/DocumentFieldDetectionResponseDetectionResult.md b/docs/DocumentFieldDetectionResponseDetectionResult.md new file mode 100644 index 0000000..b8f0e04 --- /dev/null +++ b/docs/DocumentFieldDetectionResponseDetectionResult.md @@ -0,0 +1,23 @@ + + +# DocumentFieldDetectionResponseDetectionResult + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `documentHash`*_required_ | ```String``` | The SHA-256 hash of the analyzed document. | | +| `detectionMode`*_required_ | [```String```](String.md) | The field detection method used to analyze the document: `annotations` or `text_tags`. | | +| `pageCount`*_required_ | ```Integer``` | The total number of pages in the document. | | +| `pagesAnalyzed`*_required_ | ```String``` | The zero-based page indexes analyzed, represented by the requested `page_range`, or `all` when every page was analyzed. | | +| `detectedAt`*_required_ | ```Long``` | The Unix timestamp when the field detection result was generated. | | +| `formFieldsPerDocument`*_required_ | [```List```](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).)

**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.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | | +| `formFieldGroups`*_required_ | [```List```](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`*_required_ | [```List```](WarningResponse.md) | Non-fatal issues encountered during field detection. | | +| `errors`*_required_ | [```List```](ErrorResponseError.md) | Errors encountered during field detection. Successfully detected fields may still be included in the response. | | +| `suggestions`*_required_ | ```List``` | Suggestions for improving the field detection results. | | + + + diff --git a/docs/ErrorResponseError.md b/docs/ErrorResponseError.md index 656aa5c..9db1a2d 100644 --- a/docs/ErrorResponseError.md +++ b/docs/ErrorResponseError.md @@ -9,7 +9,7 @@ Contains information about an error that occurred. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `errorMsg`*_required_ | ```String``` | Message describing an error. | | -| `errorName`*_required_ | ```String``` | Name of the error. | | +| `errorName`*_required_ | ```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. | | diff --git a/docs/EventCallbackRequestEvent.md b/docs/EventCallbackRequestEvent.md index 19ab491..2f5cbd1 100644 --- a/docs/EventCallbackRequestEvent.md +++ b/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" | diff --git a/docs/FaxResponse.md b/docs/FaxResponse.md index a1c857b..a5707cf 100644 --- a/docs/FaxResponse.md +++ b/docs/FaxResponse.md @@ -16,6 +16,7 @@ | `sender`*_required_ | ```String``` | Fax Sender Email | | | `filesUrl`*_required_ | ```String``` | Fax Files URL | | | `transmissions`*_required_ | [```List```](FaxResponseTransmission.md) | Fax Transmissions List | | +| `testMode`*_required_ | ```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 | | diff --git a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md index 4243ead..ef7454f 100644 --- a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +++ b/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. | | diff --git a/docs/SignatureRequestBulkSendWithTemplateRequest.md b/docs/SignatureRequestBulkSendWithTemplateRequest.md index 1798f6f..34a3281 100644 --- a/docs/SignatureRequestBulkSendWithTemplateRequest.md +++ b/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. | | diff --git a/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 050a7e6..da8343b 100644 --- a/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/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's information during signing.

**NOTE:** Keep your signer'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. | | diff --git a/docs/SignatureRequestSendWithTemplateRequest.md b/docs/SignatureRequestSendWithTemplateRequest.md index 425ccff..621d66a 100644 --- a/docs/SignatureRequestSendWithTemplateRequest.md +++ b/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. | | diff --git a/examples/DocumentDetectFieldsExample.java b/examples/DocumentDetectFieldsExample.java new file mode 100644 index 0000000..ab017fd --- /dev/null +++ b/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(); + } + } +} diff --git a/gradle.properties b/gradle.properties index 7393dc2..85f8352 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ #target = android GROUP=com.dropbox.sign POM_ARTIFACT_ID=dropbox-sign -VERSION_NAME=2.9.0 +VERSION_NAME=2.10.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! diff --git a/openapi-config.yaml b/openapi-config.yaml index e203b6e..2898b10 100644 --- a/openapi-config.yaml +++ b/openapi-config.yaml @@ -18,7 +18,7 @@ additionalProperties: groupId: com.dropbox.sign artifactId: dropbox-sign artifactName: Dropbox Sign Java SDK - artifactVersion: "2.9.0" + artifactVersion: "2.10.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 diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 576b442..a05971e 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1153,6 +1153,104 @@ paths: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of BulkSendJob that you can access, click here.' + /document/detect_fields: + post: + tags: + - Document + summary: 'Detect Document Fields' + description: 'Detects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags.' + operationId: documentDetectFields + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentFieldDetectionRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/DocumentFieldDetectionRequest' + responses: + '200': + description: 'successful operation' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-Ratelimit-Reset: + $ref: '#/components/headers/X-Ratelimit-Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/DocumentFieldDetectionResponse' + '4XX': + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400Response' + 401_example: + $ref: '#/components/examples/Error401Response' + 402_example: + $ref: '#/components/examples/Error402Response' + 403_example: + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 422_example: + $ref: '#/components/examples/Error422Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/DocumentDetectFieldsExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/DocumentDetectFieldsExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/DocumentDetectFieldsExample.ts + - + lang: Java + label: Java + source: + $ref: examples/DocumentDetectFieldsExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/DocumentDetectFieldsExample.rb + - + lang: Python + label: Python + source: + $ref: examples/DocumentDetectFieldsExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/DocumentDetectFieldsExample.sh + x-meta: + seo: + title: 'Detect Document Fields | API Documentation | Dropbox Sign for Developers' + description: 'Use the Dropbox Sign API to detect form fields in PDF documents from PDF form annotations or Dropbox Sign text tags.' '/embedded/edit_url/{template_id}': post: tags: @@ -5087,6 +5185,8 @@ paths: $ref: '#/components/examples/Error429Response' 404_example: $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' 4XX_example: $ref: '#/components/examples/Error4XXResponse' security: @@ -7925,6 +8025,42 @@ components: white_labeling_options: $ref: '#/components/schemas/SubWhiteLabelingOptions' type: object + DocumentFieldDetectionRequest: + required: + - detection_mode + properties: + file: + description: |- + The PDF file to analyze. + + This endpoint requires either `file` or `file_url`, but not both. + type: string + format: binary + file_url: + description: |- + The URL of the PDF file to analyze. + + This endpoint requires either `file` or `file_url`, but not both. + type: string + format: uri + detection_mode: + description: 'The field detection method to use. Set to `annotations` to detect PDF form annotations or `text_tags` to detect Dropbox Sign text tags.' + type: string + oneOf: + - + type: string + pattern: ^annotations$ + example: annotations + - + type: string + pattern: ^text_tags$ + example: text_tags + page_range: + description: '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`.' + type: string + pattern: '^(?:all|\d+(?:-\d+)?(?:,\d+(?:-\d+)?)*)$' + example: '0-2,5,7-9' + type: object EmbeddedEditUrlRequest: properties: allow_edit_ccs: @@ -8323,6 +8459,10 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + expires_at: + description: '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.' + type: integer + nullable: true type: object SignatureRequestBulkSendWithTemplateRequest: required: @@ -8412,6 +8552,10 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + expires_at: + description: '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.' + type: integer + nullable: true type: object SignatureRequestCreateEmbeddedRequest: required: @@ -8652,6 +8796,10 @@ components: **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false + expires_at: + description: '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.' + type: integer + nullable: true type: object SignatureRequestEditRequest: properties: @@ -9416,6 +9564,10 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + expires_at: + description: '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.' + type: integer + nullable: true type: object SignatureRequestUpdateRequest: required: @@ -11520,6 +11672,19 @@ components: $ref: '#/components/schemas/WarningResponse' type: object x-internal-class: true + DocumentFieldDetectionResponse: + required: + - detection_result + properties: + detection_result: + $ref: '#/components/schemas/DocumentFieldDetectionResponseDetectionResult' + warnings: + description: 'A list of warnings.' + type: array + items: + $ref: '#/components/schemas/WarningResponse' + type: object + x-internal-class: true EmbeddedEditUrlResponse: required: - embedded @@ -11940,6 +12105,89 @@ components: type: object additionalProperties: {} x-internal-class: true + DocumentFieldDetectionResponseDetectionResult: + required: + - document_hash + - detection_mode + - page_count + - pages_analyzed + - detected_at + - form_fields_per_document + - form_field_groups + - warnings + - errors + - suggestions + properties: + document_hash: + description: 'The SHA-256 hash of the analyzed document.' + type: string + maxLength: 64 + minLength: 64 + detection_mode: + description: 'The field detection method used to analyze the document: `annotations` or `text_tags`.' + type: string + oneOf: + - + type: string + pattern: ^annotations$ + example: annotations + - + type: string + pattern: ^text_tags$ + example: text_tags + page_count: + description: 'The total number of pages in the document.' + type: integer + minimum: 0 + pages_analyzed: + description: 'The zero-based page indexes analyzed, represented by the requested `page_range`, or `all` when every page was analyzed.' + type: string + example: all + detected_at: + description: 'The Unix timestamp when the field detection result was generated.' + type: integer + format: int64 + form_fields_per_document: + description: |- + 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).) + + **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. + + * Text Field use `SubFormFieldsPerDocumentText` + * Dropdown Field use `SubFormFieldsPerDocumentDropdown` + * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` + * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` + * Radio Field use `SubFormFieldsPerDocumentRadio` + * Signature Field use `SubFormFieldsPerDocumentSignature` + * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` + * Initials Field use `SubFormFieldsPerDocumentInitials` + * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` + * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + type: array + items: + $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' + form_field_groups: + description: '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`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldGroup' + warnings: + description: 'Non-fatal issues encountered during field detection.' + type: array + items: + $ref: '#/components/schemas/WarningResponse' + errors: + description: 'Errors encountered during field detection. Successfully detected fields may still be included in the response.' + type: array + items: + $ref: '#/components/schemas/ErrorResponseError' + suggestions: + description: 'Suggestions for improving the field detection results.' + type: array + items: + type: string + type: object + x-internal-class: true EmbeddedEditUrlResponseEmbedded: description: 'An embedded template object.' properties: @@ -11975,7 +12223,7 @@ components: description: 'Path at which an error occurred.' type: string error_name: - description: 'Name of the error.' + description: '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.' type: string type: object FaxResponse: @@ -11988,6 +12236,7 @@ components: - sender - files_url - transmissions + - test_mode properties: fax_id: description: 'Fax ID' @@ -12028,6 +12277,10 @@ components: type: array items: $ref: '#/components/schemas/FaxResponseTransmission' + test_mode: + description: 'Whether this is a test fax. Test faxes are not delivered to the recipient. Defaults to `false`.' + type: boolean + default: false type: object x-internal-class: true FaxLineResponseFaxLine: @@ -13782,6 +14035,8 @@ components: template: $ref: '#/components/schemas/TemplateResponse' type: object + x-fern-audiences: + - events EventCallbackRequestEvent: description: 'Basic information about the event that occurred.' required: @@ -13819,12 +14074,21 @@ components: - template_error - callback_test - signature_request_signer_removed + - fax_received + - fax_sent + - fax_on_hold + - fax_busy + - fax_no_answer + - fax_disconnected + - fax_blacklisted event_hash: description: 'Generated hash used to verify source of event data.' type: string event_metadata: $ref: '#/components/schemas/EventCallbackRequestEventMetadata' type: object + x-fern-audiences: + - events EventCallbackRequestEventMetadata: description: 'Specific metadata about the event.' properties: @@ -13845,6 +14109,8 @@ components: type: string nullable: true type: object + x-fern-audiences: + - events responses: EventCallbackResponse: description: 'successful operation' @@ -13853,6 +14119,8 @@ components: schema: type: string default: 'Hello API Event Received' + x-fern-audiences: + - events examples: AccountCreateRequest: summary: 'Default Example' @@ -14354,22 +14622,212 @@ components: summary: 'Example: signature_request_sent' value: $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + x-fern-audiences: + - events EventCallbackAccountTemplateCreated: summary: 'Example: template_created' value: $ref: examples/json/EventCallbackAccountTemplateCreated.json + x-fern-audiences: + - events EventCallbackAppAccountConfirmed: summary: 'Example: account_confirmed' value: $ref: examples/json/EventCallbackAppAccountConfirmed.json + x-fern-audiences: + - events EventCallbackAppSignatureRequestSent: summary: 'Example: signature_request_sent' value: $ref: examples/json/EventCallbackAppSignatureRequestSent.json + x-fern-audiences: + - events EventCallbackAppTemplateCreated: summary: 'Example: template_created' value: $ref: examples/json/EventCallbackAppTemplateCreated.json + x-fern-audiences: + - events + EventCallbackSignatureRequestViewed: + summary: 'Signature Request Viewed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestViewed.json + x-fern-audiences: + - events + EventCallbackSignatureRequestSigned: + summary: 'Signature Request Signed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestSigned.json + x-fern-audiences: + - events + EventCallbackSignatureRequestSignerRemoved: + summary: 'Signature Request Signer Removed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestSignerRemoved.json + x-fern-audiences: + - events + EventCallbackSignatureRequestDownloadable: + summary: 'Signature Request Downloadable Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestDownloadable.json + x-fern-audiences: + - events + EventCallbackSignatureRequestSent: + summary: 'Signature Request Sent Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestSent.json + x-fern-audiences: + - events + EventCallbackSignatureRequestAllSigned: + summary: 'Signature Request All Signed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestAllSigned.json + x-fern-audiences: + - events + EventCallbackSignatureRequestInvalid: + summary: 'Signature Request Invalid Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestInvalid.json + x-fern-audiences: + - events + EventCallbackSignatureRequestEmailBounce: + summary: 'Signature Request Email Bounce Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestEmailBounce.json + x-fern-audiences: + - events + EventCallbackSignatureRequestRemind: + summary: 'Signature Request Remind Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestRemind.json + x-fern-audiences: + - events + EventCallbackSignatureRequestIncompleteQes: + summary: 'Signature Request Incomplete QES Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestIncompleteQes.json + x-fern-audiences: + - events + EventCallbackSignatureRequestDestroyed: + summary: 'Signature Request Destroyed Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestDestroyed.json + x-fern-audiences: + - events + EventCallbackSignatureRequestCanceled: + summary: 'Signature Request Canceled Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestCanceled.json + x-fern-audiences: + - events + EventCallbackSignatureRequestDeclined: + summary: 'Signature Request Declined Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestDeclined.json + x-fern-audiences: + - events + EventCallbackSignatureRequestExpired: + summary: 'Signature Request Expired Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestExpired.json + x-fern-audiences: + - events + EventCallbackSignatureRequestReassigned: + summary: 'Signature Request Reassigned Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestReassigned.json + x-fern-audiences: + - events + EventCallbackSignatureRequestPrepared: + summary: 'Signature Request Prepared Event Example' + value: + $ref: examples/json/EventCallbackSignatureRequestPrepared.json + x-fern-audiences: + - events + EventCallbackAccountConfirmed: + summary: 'Account Confirmed Event Example' + value: + $ref: examples/json/EventCallbackAccountConfirmed.json + x-fern-audiences: + - events + EventCallbackUnknownError: + summary: 'Unknown Error Event Example' + value: + $ref: examples/json/EventCallbackUnknownError.json + x-fern-audiences: + - events + EventCallbackFileError: + summary: 'File Error Event Example' + value: + $ref: examples/json/EventCallbackFileError.json + x-fern-audiences: + - events + EventCallbackTemplateCreated: + summary: 'Template Created Event Example' + value: + $ref: examples/json/EventCallbackTemplateCreated.json + x-fern-audiences: + - events + EventCallbackTemplateError: + summary: 'Template Error Event Example' + value: + $ref: examples/json/EventCallbackTemplateError.json + x-fern-audiences: + - events + EventCallbackSignUrlInvalid: + summary: 'Sign URL Invalid Event Example' + value: + $ref: examples/json/EventCallbackSignUrlInvalid.json + x-fern-audiences: + - events + EventCallbackCallbackTest: + summary: 'Callback Test Event Example' + value: + $ref: examples/json/EventCallbackCallbackTest.json + x-fern-audiences: + - events + EventCallbackFaxReceived: + summary: 'Fax Received Event Example' + value: + $ref: examples/json/EventCallbackFaxReceived.json + x-fern-audiences: + - events + EventCallbackFaxSent: + summary: 'Fax Sent Event Example' + value: + $ref: examples/json/EventCallbackFaxSent.json + x-fern-audiences: + - events + EventCallbackFaxOnHold: + summary: 'Fax On Hold Event Example' + value: + $ref: examples/json/EventCallbackFaxOnHold.json + x-fern-audiences: + - events + EventCallbackFaxBusy: + summary: 'Fax Busy Event Example' + value: + $ref: examples/json/EventCallbackFaxBusy.json + x-fern-audiences: + - events + EventCallbackFaxNoAnswer: + summary: 'Fax No Answer Event Example' + value: + $ref: examples/json/EventCallbackFaxNoAnswer.json + x-fern-audiences: + - events + EventCallbackFaxDisconnected: + summary: 'Fax Disconnected Event Example' + value: + $ref: examples/json/EventCallbackFaxDisconnected.json + x-fern-audiences: + - events + EventCallbackFaxBlacklisted: + summary: 'Fax Blacklisted Event Example' + value: + $ref: examples/json/EventCallbackFaxBlacklisted.json + x-fern-audiences: + - events requestBodies: EventCallbackAccountRequest: description: |- @@ -14447,100 +14905,242 @@ security: externalDocs: description: 'Legacy API Reference' url: 'https://app.hellosign.com/api/reference' -x-webhooks: - accountCallback: - post: - summary: 'Account Callbacks' - operationId: accountUpdateEventCallback - description: - $ref: ./markdown/en/descriptions/account-callback-description.md - x-meta: - seo: - title: 'Account Callbacks | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the account level, click here.' - x-codeSamples: - - - lang: PHP - label: PHP - source: - $ref: examples/EventCallbackExample.php - - - lang: 'C#' - label: 'C#' - source: - $ref: examples/EventCallbackExample.cs - - - lang: TypeScript - label: TypeScript - source: - $ref: examples/EventCallbackExample.ts - - - lang: Java - label: Java - source: - $ref: examples/EventCallbackExample.java - - - lang: Ruby - label: Ruby - source: - $ref: examples/EventCallbackExample.rb - - - lang: Python - label: Python - source: - $ref: examples/EventCallbackExample.py - tags: - - 'Callbacks and Events' - requestBody: - $ref: '#/components/requestBodies/EventCallbackAccountRequest' - responses: - 200: - $ref: '#/components/responses/EventCallbackResponse' - appCallback: - post: - summary: 'App Callbacks' - description: - $ref: ./markdown/en/descriptions/api-app-callback-description.md - operationId: apiAppCreateEventCallback - x-meta: - seo: - title: 'App Callbacks | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the App level, click here.' - x-codeSamples: - - - lang: PHP - label: PHP - source: - $ref: examples/EventCallbackExample.php - - - lang: 'C#' - label: 'C#' - source: - $ref: examples/EventCallbackExample.cs - - - lang: TypeScript - label: TypeScript - source: - $ref: examples/EventCallbackExample.ts - - - lang: Java - label: Java - source: - $ref: examples/EventCallbackExample.java - - - lang: Ruby - label: Ruby - source: - $ref: examples/EventCallbackExample.rb - - - lang: Python - label: Python - source: - $ref: examples/EventCallbackExample.py - tags: - - 'Callbacks and Events' - requestBody: - $ref: '#/components/requestBodies/EventCallbackAppRequest' - responses: - 200: - $ref: '#/components/responses/EventCallbackResponse' +x-webhooks: [] +x-error-codes: + bad_request: + http_status: 400 + summary: 'The request contained invalid or malformed parameters.' + cause: 'A parameter failed validation, or the request body was malformed.' + remediation: 'Inspect error_msg and error_path, correct the offending parameter, and resend.' + retryable: 'no' + unauthorized: + http_status: 401 + summary: 'The credentials supplied are missing or invalid.' + cause: 'Missing, malformed, or invalid API key or OAuth access token.' + remediation: 'Verify the API key or OAuth token and the Authorization header, then retry.' + retryable: 'no' + payment_required: + http_status: 402 + summary: 'The account must be credited or upgraded to perform this action.' + cause: 'The action requires a paid plan, additional quota, or API credits.' + remediation: 'Upgrade the plan or add the required credits/quota, then retry.' + retryable: 'no' + forbidden: + http_status: 403 + summary: 'The action is not allowed for these credentials or in the current context.' + cause: 'The authenticated account lacks access to the resource or operation.' + remediation: 'Confirm the account has access to the resource and the required permissions.' + retryable: 'no' + not_found: + http_status: 404 + summary: 'Nothing matches the requested resource.' + cause: 'The resource id does not exist or is not visible to this account.' + remediation: 'Verify the id and that the resource belongs to the authenticated account.' + retryable: 'no' + conflict: + http_status: 409 + summary: 'The request was well-formed but conflicts with the current state.' + cause: 'The target resource is in a state incompatible with the request (e.g. a signature request is still being set up).' + remediation: 'Wait briefly and retry, or listen for a callback event confirming the resource is ready.' + retryable: conditional + exceeded_rate: + http_status: 429 + summary: 'Your account''s API request rate limit has been exceeded.' + cause: 'Too many requests were sent within the rate-limit window for this request type.' + remediation: 'Pace requests using the X-RateLimit-* response headers and retry after the window resets.' + retryable: 'yes' + backoff: 'Honor X-Ratelimit-Reset (Unix epoch); otherwise exponential backoff with jitter. No Retry-After header is sent.' + unknown: + http_status: 500 + summary: 'An unexpected error occurred.' + cause: 'An unhandled server-side error, or a status code without a more specific error_name.' + remediation: 'Retry transient failures; if it persists, contact support with the request details.' + retryable: conditional + backoff: 'For transient 5xx, retry with exponential backoff; otherwise do not retry.' + team_invite_failed: + http_status: 403 + summary: 'The team invitation could not be completed.' + cause: 'The invitee already belongs to a team, or the invite is otherwise not permitted.' + remediation: 'Confirm the invitee is not already on a team before inviting.' + retryable: 'no' + max_faxes: + http_status: 429 + summary: 'Too many fax transmissions are currently pending or transmitting.' + cause: 'The account has reached the limit of concurrent in-flight fax transmissions.' + remediation: 'Wait for outstanding transmissions to complete, then retry.' + retryable: 'yes' + backoff: 'Retry with exponential backoff once pending transmissions clear.' + invalid_recipient: + http_status: 400 + summary: 'The recipient (fax number or email address) is invalid.' + cause: 'A recipient value did not pass validation.' + remediation: 'Correct the recipient value and resend.' + retryable: 'no' + signature_request_cancel_failed: + http_status: 400 + summary: 'The signature request could not be cancelled.' + cause: 'The caller is not the requester, or the request is already fully executed/closed.' + remediation: 'Only the requester can cancel, and only before the request is fully executed.' + retryable: 'no' + signature_request_remove_failed: + http_status: 400 + summary: 'Access to the signature request could not be removed.' + cause: 'The signature request has not yet been fully executed, so access cannot be revoked.' + remediation: 'Wait until all parties have signed, or call /signature_request/cancel to cancel incomplete requests instead.' + retryable: 'no' + maintenance: + http_status: 503 + summary: 'The request could not be completed because the site is under maintenance.' + cause: 'The API is in a scheduled maintenance window.' + remediation: 'Retry once the maintenance window ends.' + retryable: 'yes' + backoff: 'Retry later with exponential backoff.' + method_not_supported: + http_status: 405 + summary: 'The HTTP method is not supported for this endpoint.' + cause: 'The request used a verb the endpoint does not accept.' + remediation: 'Use the HTTP method documented for the endpoint.' + retryable: 'no' + invalid_reminder: + http_status: 400 + summary: 'The signature request reminder was invalid.' + cause: 'A reminder was attempted against an ineligible request (e.g. embedded, closed, or expired).' + remediation: 'Only send reminders for eligible (non-embedded, open) signature requests.' + retryable: 'no' + unavailable: + http_status: 503 + summary: 'The service is temporarily unavailable.' + cause: 'A downstream dependency or the service itself is temporarily unavailable.' + remediation: 'Retry later with exponential backoff.' + retryable: 'yes' + backoff: 'Retry later with exponential backoff and jitter.' + unprocessable_entity: + http_status: 422 + summary: 'The request was understood but the target entity cannot be processed.' + cause: 'The resource is still being processed, or it is in an error state.' + remediation: 'If the resource is still processing, wait and retry; if it is in an error state, recreate/resend it instead of retrying.' + retryable: conditional + backoff: 'If still processing, retry with exponential backoff; if in an error state, do not retry.' + signature_request_expired: + http_status: + - 400 + - 403 + summary: 'The signature request has expired.' + cause: 'The operation targets a request whose expiration has passed. Most endpoints return 400; final-copy/download endpoints return 403.' + remediation: 'The request can no longer be acted upon; create a new signature request.' + retryable: 'no' + deleted: + http_status: 410 + summary: 'The request was cancelled or deleted.' + cause: 'The resource has been cancelled or removed and is no longer available.' + remediation: 'Do not retry; the resource is permanently gone.' + retryable: 'no' +x-oauth-error-codes: + invalid_grant: + http_status: + - 400 + - 401 + summary: 'The OAuth grant (authorization code or refresh token) is invalid or expired.' + cause: 'The code/token was already used, expired, or does not match the client.' + remediation: 'Re-initiate the OAuth flow to obtain a fresh authorization code.' + retryable: 'no' + invalid_client: + http_status: 400 + summary: 'The OAuth client credentials are invalid.' + cause: 'The client_id or client_secret is unrecognized or incorrect.' + remediation: 'Verify the client_id and client_secret from the API app settings.' + retryable: 'no' + invalid_request: + http_status: 400 + summary: 'The OAuth request is malformed or missing required parameters.' + cause: 'A required parameter is missing, or the request format is invalid.' + remediation: 'Check the request against the OAuth token endpoint documentation.' + retryable: 'no' + unauthorized_client: + http_status: + - 401 + - 403 + summary: 'The OAuth client is not authorized to perform this action.' + cause: 'The app has not been approved, or the action is outside the granted scopes.' + remediation: 'Ensure the app is approved and the required scopes are granted.' + retryable: 'no' + unsupported_grant_type: + http_status: 400 + summary: 'The grant type is not supported.' + cause: 'The grant_type parameter value is not recognized.' + remediation: 'Use authorization_code or refresh_token as the grant_type.' + retryable: 'no' + payment_required: + http_status: 402 + summary: 'The account requires a paid plan to use this OAuth app.' + cause: 'The authorizing account does not have a plan that supports this integration.' + remediation: 'Upgrade the account to a plan that includes OAuth app access.' + retryable: 'no' + addon_required: + http_status: 402 + summary: 'An add-on is required to use this OAuth app.' + cause: 'The account plan does not include the add-on needed for this integration.' + remediation: 'Add the required add-on to the account subscription.' + retryable: 'no' + invalid_scope: + http_status: 400 + summary: 'The requested OAuth scope is invalid.' + cause: 'The scope parameter contains values not permitted for the app.' + remediation: 'Request only scopes that the app is configured to use.' + retryable: 'no' + quota_reached: + http_status: 402 + summary: 'The account has reached its usage quota for this OAuth app.' + cause: 'The authorizing account has exhausted its quota for the integration.' + remediation: 'Contact the app owner or upgrade the account quota.' + retryable: 'no' + server_error: + http_status: 500 + summary: 'An internal server error occurred during OAuth processing.' + cause: 'An unexpected error on the server side while handling the OAuth request.' + remediation: 'Retry the request; if it persists, contact support.' + retryable: 'yes' + backoff: 'Retry with exponential backoff.' + temporary_unavailable: + http_status: 503 + summary: 'The OAuth service is temporarily unavailable.' + cause: 'The service is under maintenance or experiencing temporary issues.' + remediation: 'Retry after a short delay.' + retryable: 'yes' + backoff: 'Retry with exponential backoff.' +x-error-events: + signature_request_invalid: + event_type: signature_request_invalid + delivery: webhook + summary: 'Asynchronous error while processing a signature request.' + cause: 'A signature request could not be processed (e.g. invalid tags, fields, or merge data).' + remediation: 'Inspect event.event_metadata.event_message in the callback, correct the request, and resend.' + retryable: conditional + unknown_error: + event_type: unknown_error + delivery: webhook + summary: 'An unspecified asynchronous processing error occurred.' + cause: 'An unexpected error occurred while processing the request asynchronously.' + remediation: 'Check the request status in the API dashboard; retry or contact support if it persists.' + retryable: conditional + file_error: + event_type: file_error + delivery: webhook + summary: 'Asynchronous error while processing an uploaded file.' + cause: 'A file attached to a request could not be processed.' + remediation: 'Resend the request with a supported, non-corrupt file.' + retryable: conditional + template_error: + event_type: template_error + delivery: webhook + summary: 'Asynchronous error while creating a template.' + cause: 'Template file processing failed (e.g. unsupported or corrupt file).' + remediation: 'Recreate the template with a valid file; check status in the API dashboard.' + retryable: conditional + sign_url_invalid: + event_type: sign_url_invalid + delivery: webhook + summary: 'An embedded signing URL has expired or become invalid.' + cause: 'The embedded sign_url is no longer valid (e.g. expired).' + remediation: 'Generate a fresh embedded sign_url via the embedded sign URL endpoint.' + retryable: 'yes' diff --git a/pom.xml b/pom.xml index 36acad2..b597ab4 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ dropbox-sign jar dropbox-sign - 2.9.0 + 2.10.0 https://github.com/hellosign/dropbox-sign-java Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! diff --git a/src/main/java/com/dropbox/sign/ApiClient.java b/src/main/java/com/dropbox/sign/ApiClient.java index 19554e1..bbba972 100644 --- a/src/main/java/com/dropbox/sign/ApiClient.java +++ b/src/main/java/com/dropbox/sign/ApiClient.java @@ -159,7 +159,7 @@ public ApiClient(Map authMap) { this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/2.9.0/java"); + setUserAgent("OpenAPI-Generator/2.10.0/java"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap<>(); diff --git a/src/main/java/com/dropbox/sign/Configuration.java b/src/main/java/com/dropbox/sign/Configuration.java index 054b0cb..8525fd4 100644 --- a/src/main/java/com/dropbox/sign/Configuration.java +++ b/src/main/java/com/dropbox/sign/Configuration.java @@ -15,7 +15,7 @@ @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class Configuration { - public static final String VERSION = "2.9.0"; + public static final String VERSION = "2.10.0"; private static volatile ApiClient defaultApiClient = new ApiClient(); diff --git a/src/main/java/com/dropbox/sign/api/AccountApi.java b/src/main/java/com/dropbox/sign/api/AccountApi.java index 3981d8d..95a9056 100644 --- a/src/main/java/com/dropbox/sign/api/AccountApi.java +++ b/src/main/java/com/dropbox/sign/api/AccountApi.java @@ -55,6 +55,7 @@ public void setApiClient(ApiClient apiClient) { /** * Create Account * Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountCreateExample.java * @param accountCreateRequest (required) * @return AccountCreateResponse * @throws ApiException if fails to make API call @@ -74,6 +75,7 @@ public AccountCreateResponse accountCreate(AccountCreateRequest accountCreateReq /** * Create Account * Creates a new Dropbox Sign Account that is associated with the specified `email_address`. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountCreateExample.java * @param accountCreateRequest (required) * @return ApiResponse<AccountCreateResponse> * @throws ApiException if fails to make API call @@ -118,6 +120,7 @@ public ApiResponse accountCreateWithHttpInfo(AccountCreat /** * Get Account * Returns the properties and settings of your Account. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountGetExample.java * @param accountId `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) * @param emailAddress `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * @return AccountGetResponse @@ -177,6 +180,7 @@ public ApiResponse accountGetWithHttpInfo(String accountId) /** * Get Account * Returns the properties and settings of your Account. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountGetExample.java * @param accountId `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. (optional) * @param emailAddress `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. (optional) * @return ApiResponse<AccountGetResponse> @@ -223,6 +227,7 @@ public ApiResponse accountGetWithHttpInfo(String accountId, /** * 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-java/blob/main/examples/AccountUpdateExample.java * @param accountUpdateRequest (required) * @return AccountGetResponse * @throws ApiException if fails to make API call @@ -242,6 +247,7 @@ public AccountGetResponse accountUpdate(AccountUpdateRequest accountUpdateReques /** * 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-java/blob/main/examples/AccountUpdateExample.java * @param accountUpdateRequest (required) * @return ApiResponse<AccountGetResponse> * @throws ApiException if fails to make API call @@ -286,6 +292,7 @@ public ApiResponse accountUpdateWithHttpInfo(AccountUpdateRe /** * Verify Account * Verifies whether an Dropbox Sign Account exists for the given email address. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountVerifyExample.java * @param accountVerifyRequest (required) * @return AccountVerifyResponse * @throws ApiException if fails to make API call @@ -305,6 +312,7 @@ public AccountVerifyResponse accountVerify(AccountVerifyRequest accountVerifyReq /** * Verify Account * Verifies whether an Dropbox Sign Account exists for the given email address. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/AccountVerifyExample.java * @param accountVerifyRequest (required) * @return ApiResponse<AccountVerifyResponse> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/dropbox/sign/api/ApiAppApi.java b/src/main/java/com/dropbox/sign/api/ApiAppApi.java index 813cf39..b30d650 100644 --- a/src/main/java/com/dropbox/sign/api/ApiAppApi.java +++ b/src/main/java/com/dropbox/sign/api/ApiAppApi.java @@ -53,6 +53,7 @@ public void setApiClient(ApiClient apiClient) { /** * Create API App * Creates a new API App. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppCreateExample.java * @param apiAppCreateRequest (required) * @return ApiAppGetResponse * @throws ApiException if fails to make API call @@ -72,6 +73,7 @@ public ApiAppGetResponse apiAppCreate(ApiAppCreateRequest apiAppCreateRequest) t /** * Create API App * Creates a new API App. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppCreateExample.java * @param apiAppCreateRequest (required) * @return ApiResponse<ApiAppGetResponse> * @throws ApiException if fails to make API call @@ -116,6 +118,7 @@ public ApiResponse apiAppCreateWithHttpInfo(ApiAppCreateReque /** * Delete API App * Deletes an API App. Can only be invoked for apps you own. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppDeleteExample.java * @param clientId The client id of the API App to delete. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -134,6 +137,7 @@ public void apiAppDelete(String clientId) throws ApiException { /** * Delete API App * Deletes an API App. Can only be invoked for apps you own. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppDeleteExample.java * @param clientId The client id of the API App to delete. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -181,6 +185,7 @@ public ApiResponse apiAppDeleteWithHttpInfo(String clientId) throws ApiExc /** * Get API App * Returns an object with information about an API App. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppGetExample.java * @param clientId The client id of the API App to retrieve. (required) * @return ApiAppGetResponse * @throws ApiException if fails to make API call @@ -200,6 +205,7 @@ public ApiAppGetResponse apiAppGet(String clientId) throws ApiException { /** * Get API App * Returns an object with information about an API App. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ApiAppGetExample.java * @param clientId The client id of the API App to retrieve. (required) * @return ApiResponse<ApiAppGetResponse> * @throws ApiException if fails to make API call @@ -248,6 +254,7 @@ public ApiResponse apiAppGetWithHttpInfo(String clientId) thr /** * 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-java/blob/main/examples/ApiAppListExample.java * @param page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return ApiAppListResponse @@ -307,6 +314,7 @@ public ApiResponse apiAppListWithHttpInfo(Integer page) thro /** * 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-java/blob/main/examples/ApiAppListExample.java * @param page Which page number of the API App List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<ApiAppListResponse> @@ -359,6 +367,7 @@ public ApiResponse apiAppListWithHttpInfo(Integer page, Inte /** * 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-java/blob/main/examples/ApiAppUpdateExample.java * @param clientId The client id of the API App to update. (required) * @param apiAppUpdateRequest (required) * @return ApiAppGetResponse @@ -379,6 +388,7 @@ public ApiAppGetResponse apiAppUpdate(String clientId, ApiAppUpdateRequest apiAp /** * 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-java/blob/main/examples/ApiAppUpdateExample.java * @param clientId The client id of the API App to update. (required) * @param apiAppUpdateRequest (required) * @return ApiResponse<ApiAppGetResponse> diff --git a/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java b/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java index 098c28c..bde0673 100644 --- a/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java +++ b/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java @@ -51,6 +51,7 @@ public void setApiClient(ApiClient apiClient) { /** * 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-java/blob/main/examples/BulkSendJobGetExample.java * @param bulkSendJobId The id of the BulkSendJob to retrieve. (required) * @param page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -111,6 +112,7 @@ public ApiResponse bulkSendJobGetWithHttpInfo(String bul /** * 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-java/blob/main/examples/BulkSendJobGetExample.java * @param bulkSendJobId The id of the BulkSendJob to retrieve. (required) * @param page Which page number of the BulkSendJob list to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) @@ -173,6 +175,7 @@ public ApiResponse bulkSendJobGetWithHttpInfo(String bul /** * List Bulk Send Jobs * Returns a list of BulkSendJob that you can access. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/BulkSendJobListExample.java * @param page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * @return BulkSendJobListResponse @@ -232,6 +235,7 @@ public ApiResponse bulkSendJobListWithHttpInfo(Integer /** * List Bulk Send Jobs * Returns a list of BulkSendJob that you can access. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/BulkSendJobListExample.java * @param page Which page number of the BulkSendJob List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. (optional, default to 20) * @return ApiResponse<BulkSendJobListResponse> diff --git a/src/main/java/com/dropbox/sign/api/DocumentApi.java b/src/main/java/com/dropbox/sign/api/DocumentApi.java new file mode 100644 index 0000000..1bf68ca --- /dev/null +++ b/src/main/java/com/dropbox/sign/api/DocumentApi.java @@ -0,0 +1,116 @@ +package com.dropbox.sign.api; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.ApiClient; +import com.dropbox.sign.ApiResponse; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.Pair; + +import jakarta.ws.rs.core.GenericType; + +import com.dropbox.sign.model.DocumentFieldDetectionRequest; +import com.dropbox.sign.model.DocumentFieldDetectionResponse; +import com.dropbox.sign.model.ErrorResponse; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +public class DocumentApi { + private ApiClient apiClient; + + public DocumentApi() { + this(Configuration.getDefaultApiClient()); + } + + public DocumentApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Get the API client + * + * @return API client + */ + public ApiClient getApiClient() { + return apiClient; + } + + /** + * Set the API client + * + * @param apiClient an instance of API client + */ + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * 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-java/blob/main/examples/DocumentDetectFieldsExample.java + * @param documentFieldDetectionRequest (required) + * @return DocumentFieldDetectionResponse + * @throws ApiException if fails to make API call + * @http.response.details + + + + + +
Response Details
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public DocumentFieldDetectionResponse documentDetectFields(DocumentFieldDetectionRequest documentFieldDetectionRequest) throws ApiException { + return documentDetectFieldsWithHttpInfo(documentFieldDetectionRequest).getData(); + } + + + /** + * 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-java/blob/main/examples/DocumentDetectFieldsExample.java + * @param documentFieldDetectionRequest (required) + * @return ApiResponse<DocumentFieldDetectionResponse> + * @throws ApiException if fails to make API call + * @http.response.details + + + + + +
Response Details
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public ApiResponse documentDetectFieldsWithHttpInfo(DocumentFieldDetectionRequest documentFieldDetectionRequest) throws ApiException { + + // Check required parameters + if (documentFieldDetectionRequest == null) { + throw new ApiException(400, "Missing the required parameter 'documentFieldDetectionRequest' when calling documentDetectFields"); + } + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = documentFieldDetectionRequest.createFormData(); + boolean isFileTypeFound = !localVarFormParams.isEmpty(); + String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data"); + String[] localVarAuthNames = new String[] {"api_key", "oauth2"}; + GenericType localVarReturnType = new GenericType() {}; + return apiClient.invokeAPI( + "DocumentApi.documentDetectFields", + "/document/detect_fields", + "POST", + new ArrayList<>(), + isFileTypeFound ? null : documentFieldDetectionRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } +} \ No newline at end of file diff --git a/src/main/java/com/dropbox/sign/api/EmbeddedApi.java b/src/main/java/com/dropbox/sign/api/EmbeddedApi.java index a847620..3cc198b 100644 --- a/src/main/java/com/dropbox/sign/api/EmbeddedApi.java +++ b/src/main/java/com/dropbox/sign/api/EmbeddedApi.java @@ -52,6 +52,7 @@ public void setApiClient(ApiClient apiClient) { /** * 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-java/blob/main/examples/EmbeddedEditUrlExample.java * @param templateId The id of the template to edit. (required) * @param embeddedEditUrlRequest (required) * @return EmbeddedEditUrlResponse @@ -72,6 +73,7 @@ public EmbeddedEditUrlResponse embeddedEditUrl(String templateId, EmbeddedEditUr /** * 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-java/blob/main/examples/EmbeddedEditUrlExample.java * @param templateId The id of the template to edit. (required) * @param embeddedEditUrlRequest (required) * @return ApiResponse<EmbeddedEditUrlResponse> @@ -124,6 +126,7 @@ public ApiResponse embeddedEditUrlWithHttpInfo(String t /** * 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-java/blob/main/examples/EmbeddedSignUrlExample.java * @param signatureId The id of the signature to get a signature url for. (required) * @return EmbeddedSignUrlResponse * @throws ApiException if fails to make API call @@ -143,6 +146,7 @@ public EmbeddedSignUrlResponse embeddedSignUrl(String signatureId) throws ApiExc /** * 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-java/blob/main/examples/EmbeddedSignUrlExample.java * @param signatureId The id of the signature to get a signature url for. (required) * @return ApiResponse<EmbeddedSignUrlResponse> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/dropbox/sign/api/FaxApi.java b/src/main/java/com/dropbox/sign/api/FaxApi.java index e438d0d..07aa92b 100644 --- a/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -53,6 +53,7 @@ public void setApiClient(ApiClient apiClient) { /** * Delete Fax * Deletes the specified Fax from the system + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxDeleteExample.java * @param faxId Fax ID (required) * @throws ApiException if fails to make API call * @http.response.details @@ -71,6 +72,7 @@ public void faxDelete(String faxId) throws ApiException { /** * Delete Fax * Deletes the specified Fax from the system + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxDeleteExample.java * @param faxId Fax ID (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -118,6 +120,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException /** * Download Fax Files * Downloads files associated with a Fax + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxFilesExample.java * @param faxId Fax ID (required) * @return File * @throws ApiException if fails to make API call @@ -137,6 +140,7 @@ public File faxFiles(String faxId) throws ApiException { /** * Download Fax Files * Downloads files associated with a Fax + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxFilesExample.java * @param faxId Fax ID (required) * @return ApiResponse<File> * @throws ApiException if fails to make API call @@ -185,6 +189,7 @@ public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException /** * Get Fax * Returns information about a Fax + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxGetExample.java * @param faxId Fax ID (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -204,6 +209,7 @@ public FaxGetResponse faxGet(String faxId) throws ApiException { /** * Get Fax * Returns information about a Fax + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxGetExample.java * @param faxId Fax ID (required) * @return ApiResponse<FaxGetResponse> * @throws ApiException if fails to make API call @@ -252,6 +258,7 @@ public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiEx /** * Lists Faxes * Returns properties of multiple Faxes + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxListExample.java * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return FaxListResponse @@ -311,6 +318,7 @@ public ApiResponse faxListWithHttpInfo(Integer page) throws Api /** * Lists Faxes * Returns properties of multiple Faxes + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxListExample.java * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<FaxListResponse> @@ -363,6 +371,7 @@ public ApiResponse faxListWithHttpInfo(Integer page, Integer pa /** * Send Fax * Creates and sends a new Fax with the submitted file(s) + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxSendExample.java * @param faxSendRequest (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -382,6 +391,7 @@ public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException /** * Send Fax * Creates and sends a new Fax with the submitted file(s) + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxSendExample.java * @param faxSendRequest (required) * @return ApiResponse<FaxGetResponse> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/src/main/java/com/dropbox/sign/api/FaxLineApi.java index 2d6eb5a..4980f9f 100644 --- a/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -56,6 +56,7 @@ public void setApiClient(ApiClient apiClient) { /** * Add Fax Line User * Grants a user access to the specified Fax Line. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineAddUserExample.java * @param faxLineAddUserRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -75,6 +76,7 @@ public FaxLineResponse faxLineAddUser(FaxLineAddUserRequest faxLineAddUserReques /** * Add Fax Line User * Grants a user access to the specified Fax Line. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineAddUserExample.java * @param faxLineAddUserRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call @@ -119,6 +121,7 @@ public ApiResponse faxLineAddUserWithHttpInfo(FaxLineAddUserReq /** * Get Available Fax Line Area Codes * Returns a list of available area codes for a given state/province and city + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineAreaCodeGetExample.java * @param country Filter area codes by country (required) * @param state Filter area codes by state (optional) * @param province Filter area codes by province (optional) @@ -202,6 +205,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** * Get Available Fax Line Area Codes * Returns a list of available area codes for a given state/province and city + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineAreaCodeGetExample.java * @param country Filter area codes by country (required) * @param state Filter area codes by state (optional) * @param province Filter area codes by province (optional) @@ -257,6 +261,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** * Purchase Fax Line * Purchases a new Fax Line + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineCreateExample.java * @param faxLineCreateRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -276,6 +281,7 @@ public FaxLineResponse faxLineCreate(FaxLineCreateRequest faxLineCreateRequest) /** * Purchase Fax Line * Purchases a new Fax Line + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineCreateExample.java * @param faxLineCreateRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call @@ -320,6 +326,7 @@ public ApiResponse faxLineCreateWithHttpInfo(FaxLineCreateReque /** * Delete Fax Line * Deletes the specified Fax Line from the subscription. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineDeleteExample.java * @param faxLineDeleteRequest (required) * @throws ApiException if fails to make API call * @http.response.details @@ -338,6 +345,7 @@ public void faxLineDelete(FaxLineDeleteRequest faxLineDeleteRequest) throws ApiE /** * Delete Fax Line * Deletes the specified Fax Line from the subscription. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineDeleteExample.java * @param faxLineDeleteRequest (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -381,6 +389,7 @@ public ApiResponse faxLineDeleteWithHttpInfo(FaxLineDeleteRequest faxLineD /** * Get Fax Line * Returns the properties and settings of a Fax Line. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineGetExample.java * @param number The Fax Line number (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -400,6 +409,7 @@ public FaxLineResponse faxLineGet(String number) throws ApiException { /** * Get Fax Line * Returns the properties and settings of a Fax Line. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineGetExample.java * @param number The Fax Line number (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call @@ -449,6 +459,7 @@ public ApiResponse faxLineGetWithHttpInfo(String number) throws /** * List Fax Lines * Returns the properties and settings of multiple Fax Lines. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineListExample.java * @param accountId Account ID (optional) * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -556,6 +567,7 @@ public ApiResponse faxLineListWithHttpInfo(String accountId /** * List Fax Lines * Returns the properties and settings of multiple Fax Lines. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineListExample.java * @param accountId Account ID (optional) * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -612,6 +624,7 @@ public ApiResponse faxLineListWithHttpInfo(String accountId /** * Remove Fax Line Access * Removes a user's access to the specified Fax Line + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineRemoveUserExample.java * @param faxLineRemoveUserRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -631,6 +644,7 @@ public FaxLineResponse faxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU /** * Remove Fax Line Access * Removes a user's access to the specified Fax Line + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/FaxLineRemoveUserExample.java * @param faxLineRemoveUserRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/dropbox/sign/api/OAuthApi.java b/src/main/java/com/dropbox/sign/api/OAuthApi.java index ddcaa24..d14b6cd 100644 --- a/src/main/java/com/dropbox/sign/api/OAuthApi.java +++ b/src/main/java/com/dropbox/sign/api/OAuthApi.java @@ -52,6 +52,7 @@ public void setApiClient(ApiClient apiClient) { /** * OAuth Token Generate * Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/OauthTokenGenerateExample.java * @param oauthTokenGenerateRequest (required) * @return OAuthTokenResponse * @throws ApiException if fails to make API call @@ -71,6 +72,7 @@ public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthToke /** * OAuth Token Generate * Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/OauthTokenGenerateExample.java * @param oauthTokenGenerateRequest (required) * @return ApiResponse<OAuthTokenResponse> * @throws ApiException if fails to make API call @@ -114,6 +116,7 @@ public ApiResponse oauthTokenGenerateWithHttpInfo(OAuthToken /** * OAuth Token Refresh * Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/OauthTokenRefreshExample.java * @param oauthTokenRefreshRequest (required) * @return OAuthTokenResponse * @throws ApiException if fails to make API call @@ -133,6 +136,7 @@ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenR /** * OAuth Token Refresh * Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/OauthTokenRefreshExample.java * @param oauthTokenRefreshRequest (required) * @return ApiResponse<OAuthTokenResponse> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/dropbox/sign/api/ReportApi.java b/src/main/java/com/dropbox/sign/api/ReportApi.java index a9a5905..472111d 100644 --- a/src/main/java/com/dropbox/sign/api/ReportApi.java +++ b/src/main/java/com/dropbox/sign/api/ReportApi.java @@ -51,6 +51,7 @@ public void setApiClient(ApiClient apiClient) { /** * Create Report * Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ReportCreateExample.java * @param reportCreateRequest (required) * @return ReportCreateResponse * @throws ApiException if fails to make API call @@ -70,6 +71,7 @@ public ReportCreateResponse reportCreate(ReportCreateRequest reportCreateRequest /** * Create Report * Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/ReportCreateExample.java * @param reportCreateRequest (required) * @return ApiResponse<ReportCreateResponse> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java b/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java index 88f08b4..539a872 100644 --- a/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java +++ b/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java @@ -67,6 +67,7 @@ public void setApiClient(ApiClient apiClient) { /** * Embedded Bulk Send with Template * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java * @param signatureRequestBulkCreateEmbeddedWithTemplateRequest (required) * @return BulkSendJobSendResponse * @throws ApiException if fails to make API call @@ -86,6 +87,7 @@ public BulkSendJobSendResponse signatureRequestBulkCreateEmbeddedWithTemplate(Si /** * Embedded Bulk Send with Template * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java * @param signatureRequestBulkCreateEmbeddedWithTemplateRequest (required) * @return ApiResponse<BulkSendJobSendResponse> * @throws ApiException if fails to make API call @@ -130,6 +132,7 @@ public ApiResponse signatureRequestBulkCreateEmbeddedWi /** * Bulk Send with Template * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.java * @param signatureRequestBulkSendWithTemplateRequest (required) * @return BulkSendJobSendResponse * @throws ApiException if fails to make API call @@ -149,6 +152,7 @@ public BulkSendJobSendResponse signatureRequestBulkSendWithTemplate(SignatureReq /** * Bulk Send with Template * Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestBulkSendWithTemplateExample.java * @param signatureRequestBulkSendWithTemplateRequest (required) * @return ApiResponse<BulkSendJobSendResponse> * @throws ApiException if fails to make API call @@ -193,6 +197,7 @@ public ApiResponse signatureRequestBulkSendWithTemplate /** * Cancel Incomplete Signature Request * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCancelExample.java * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -211,6 +216,7 @@ public void signatureRequestCancel(String signatureRequestId) throws ApiExceptio /** * Cancel Incomplete Signature Request * Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCancelExample.java * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -258,6 +264,7 @@ public ApiResponse signatureRequestCancelWithHttpInfo(String signatureRequ /** * Create Embedded Signature Request * Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCreateEmbeddedExample.java * @param signatureRequestCreateEmbeddedRequest (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -277,6 +284,7 @@ public SignatureRequestGetResponse signatureRequestCreateEmbedded(SignatureReque /** * Create Embedded Signature Request * Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCreateEmbeddedExample.java * @param signatureRequestCreateEmbeddedRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -321,6 +329,7 @@ public ApiResponse signatureRequestCreateEmbeddedWi /** * Create Embedded Signature Request with Template * Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java * @param signatureRequestCreateEmbeddedWithTemplateRequest (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -340,6 +349,7 @@ public SignatureRequestGetResponse signatureRequestCreateEmbeddedWithTemplate(Si /** * Create Embedded Signature Request with Template * Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java * @param signatureRequestCreateEmbeddedWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -384,6 +394,7 @@ public ApiResponse signatureRequestCreateEmbeddedWi /** * Edit Signature Request * Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditRequest (required) * @return SignatureRequestGetResponse @@ -404,6 +415,7 @@ public SignatureRequestGetResponse signatureRequestEdit(String signatureRequestI /** * Edit Signature Request * Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -456,6 +468,7 @@ public ApiResponse signatureRequestEditWithHttpInfo /** * Edit Embedded Signature Request * Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditEmbeddedExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditEmbeddedRequest (required) * @return SignatureRequestGetResponse @@ -476,6 +489,7 @@ public SignatureRequestGetResponse signatureRequestEditEmbedded(String signature /** * Edit Embedded Signature Request * Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditEmbeddedExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditEmbeddedRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -528,6 +542,7 @@ public ApiResponse signatureRequestEditEmbeddedWith /** * Edit Embedded Signature Request with Template * Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditEmbeddedWithTemplateRequest (required) * @return SignatureRequestGetResponse @@ -548,6 +563,7 @@ public SignatureRequestGetResponse signatureRequestEditEmbeddedWithTemplate(Stri /** * Edit Embedded Signature Request with Template * Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditEmbeddedWithTemplateExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditEmbeddedWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -600,6 +616,7 @@ public ApiResponse signatureRequestEditEmbeddedWith /** * Edit Signature Request With Template * Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditWithTemplateExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditWithTemplateRequest (required) * @return SignatureRequestGetResponse @@ -620,6 +637,7 @@ public SignatureRequestGetResponse signatureRequestEditWithTemplate(String signa /** * Edit Signature Request With Template * Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestEditWithTemplateExample.java * @param signatureRequestId The id of the SignatureRequest to edit. (required) * @param signatureRequestEditWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -672,6 +690,7 @@ public ApiResponse signatureRequestEditWithTemplate /** * Download Files * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) * @return File @@ -711,6 +730,7 @@ public ApiResponse signatureRequestFilesWithHttpInfo(String signatureReque /** * Download Files * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf) * @return ApiResponse<File> @@ -768,6 +788,7 @@ public ApiResponse signatureRequestFilesWithHttpInfo(String signatureReque /** * Download Files as Data Uri * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesAsDataUriExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return FileResponseDataUri * @throws ApiException if fails to make API call @@ -787,6 +808,7 @@ public FileResponseDataUri signatureRequestFilesAsDataUri(String signatureReques /** * Download Files as Data Uri * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesAsDataUriExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return ApiResponse<FileResponseDataUri> * @throws ApiException if fails to make API call @@ -835,6 +857,7 @@ public ApiResponse signatureRequestFilesAsDataUriWithHttpIn /** * Download Files as File Url * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesAsFileUrlExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @return FileResponse @@ -874,6 +897,7 @@ public ApiResponse signatureRequestFilesAsFileUrlWithHttpInfo(Stri /** * Download Files as File Url * Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestFilesAsFileUrlExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @return ApiResponse<FileResponse> @@ -931,6 +955,7 @@ public ApiResponse signatureRequestFilesAsFileUrlWithHttpInfo(Stri /** * Get Signature Request * Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestGetExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -950,6 +975,7 @@ public SignatureRequestGetResponse signatureRequestGet(String signatureRequestId /** * Get Signature Request * Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestGetExample.java * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -998,6 +1024,7 @@ public ApiResponse signatureRequestGetWithHttpInfo( /** * List Signature Requests * Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestListExample.java * @param accountId Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1105,6 +1132,7 @@ public ApiResponse signatureRequestListWithHttpInf /** * List Signature Requests * Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestListExample.java * @param accountId Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param page Which page number of the SignatureRequest List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -1161,6 +1189,7 @@ public ApiResponse signatureRequestListWithHttpInf /** * Release On-Hold Signature Request * Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestReleaseHoldExample.java * @param signatureRequestId The id of the SignatureRequest to release. (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -1180,6 +1209,7 @@ public SignatureRequestGetResponse signatureRequestReleaseHold(String signatureR /** * Release On-Hold Signature Request * Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestReleaseHoldExample.java * @param signatureRequestId The id of the SignatureRequest to release. (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -1228,6 +1258,7 @@ public ApiResponse signatureRequestReleaseHoldWithH /** * Send Request Reminder * Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestRemindExample.java * @param signatureRequestId The id of the SignatureRequest to send a reminder for. (required) * @param signatureRequestRemindRequest (required) * @return SignatureRequestGetResponse @@ -1248,6 +1279,7 @@ public SignatureRequestGetResponse signatureRequestRemind(String signatureReques /** * Send Request Reminder * Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestRemindExample.java * @param signatureRequestId The id of the SignatureRequest to send a reminder for. (required) * @param signatureRequestRemindRequest (required) * @return ApiResponse<SignatureRequestGetResponse> @@ -1300,6 +1332,7 @@ public ApiResponse signatureRequestRemindWithHttpIn /** * Remove Signature Request Access * Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestRemoveExample.java * @param signatureRequestId The id of the SignatureRequest to remove. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -1318,6 +1351,7 @@ public void signatureRequestRemove(String signatureRequestId) throws ApiExceptio /** * Remove Signature Request Access * Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestRemoveExample.java * @param signatureRequestId The id of the SignatureRequest to remove. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -1365,6 +1399,7 @@ public ApiResponse signatureRequestRemoveWithHttpInfo(String signatureRequ /** * Send Signature Request * Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestSendExample.java * @param signatureRequestSendRequest (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -1384,6 +1419,7 @@ public SignatureRequestGetResponse signatureRequestSend(SignatureRequestSendRequ /** * Send Signature Request * Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestSendExample.java * @param signatureRequestSendRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -1428,6 +1464,7 @@ public ApiResponse signatureRequestSendWithHttpInfo /** * Send with Template * Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestSendWithTemplateExample.java * @param signatureRequestSendWithTemplateRequest (required) * @return SignatureRequestGetResponse * @throws ApiException if fails to make API call @@ -1447,6 +1484,7 @@ public SignatureRequestGetResponse signatureRequestSendWithTemplate(SignatureReq /** * Send with Template * Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestSendWithTemplateExample.java * @param signatureRequestSendWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @throws ApiException if fails to make API call @@ -1491,6 +1529,7 @@ public ApiResponse signatureRequestSendWithTemplate /** * Update Signature Request * Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestUpdateExample.java * @param signatureRequestId The id of the SignatureRequest to update. (required) * @param signatureRequestUpdateRequest (required) * @return SignatureRequestGetResponse @@ -1511,6 +1550,7 @@ public SignatureRequestGetResponse signatureRequestUpdate(String signatureReques /** * Update Signature Request * Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/SignatureRequestUpdateExample.java * @param signatureRequestId The id of the SignatureRequest to update. (required) * @param signatureRequestUpdateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> diff --git a/src/main/java/com/dropbox/sign/api/TeamApi.java b/src/main/java/com/dropbox/sign/api/TeamApi.java index ac28133..a2d67bc 100644 --- a/src/main/java/com/dropbox/sign/api/TeamApi.java +++ b/src/main/java/com/dropbox/sign/api/TeamApi.java @@ -58,6 +58,7 @@ public void setApiClient(ApiClient apiClient) { /** * Add User to Team * Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamAddMemberExample.java * @param teamAddMemberRequest (required) * @param teamId The id of the team. (optional) * @return TeamGetResponse @@ -97,6 +98,7 @@ public ApiResponse teamAddMemberWithHttpInfo(TeamAddMemberReque /** * Add User to Team * Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamAddMemberExample.java * @param teamAddMemberRequest (required) * @param teamId The id of the team. (optional) * @return ApiResponse<TeamGetResponse> @@ -147,6 +149,7 @@ public ApiResponse teamAddMemberWithHttpInfo(TeamAddMemberReque /** * Create Team * Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamCreateExample.java * @param teamCreateRequest (required) * @return TeamGetResponse * @throws ApiException if fails to make API call @@ -166,6 +169,7 @@ public TeamGetResponse teamCreate(TeamCreateRequest teamCreateRequest) throws Ap /** * Create Team * Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamCreateExample.java * @param teamCreateRequest (required) * @return ApiResponse<TeamGetResponse> * @throws ApiException if fails to make API call @@ -210,6 +214,7 @@ public ApiResponse teamCreateWithHttpInfo(TeamCreateRequest tea /** * Delete Team * Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamDeleteExample.java * @throws ApiException if fails to make API call * @http.response.details @@ -227,6 +232,7 @@ public void teamDelete() throws ApiException { /** * Delete Team * Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamDeleteExample.java * @return ApiResponse<Void> * @throws ApiException if fails to make API call * @http.response.details @@ -264,6 +270,7 @@ public ApiResponse teamDeleteWithHttpInfo() throws ApiException { /** * Get Team * Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamGetExample.java * @return TeamGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -282,6 +289,7 @@ public TeamGetResponse teamGet() throws ApiException { /** * Get Team * Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamGetExample.java * @return ApiResponse<TeamGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -320,6 +328,7 @@ public ApiResponse teamGetWithHttpInfo() throws ApiException { /** * Get Team Info * Provides information about a team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamInfoExample.java * @param teamId The id of the team. (optional) * @return TeamGetInfoResponse * @throws ApiException if fails to make API call @@ -358,6 +367,7 @@ public ApiResponse teamInfoWithHttpInfo() throws ApiExcepti /** * Get Team Info * Provides information about a team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamInfoExample.java * @param teamId The id of the team. (optional) * @return ApiResponse<TeamGetInfoResponse> * @throws ApiException if fails to make API call @@ -402,6 +412,7 @@ public ApiResponse teamInfoWithHttpInfo(String teamId) thro /** * List Team Invites * Provides a list of team invites (and their roles). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamInvitesExample.java * @param emailAddress The email address for which to display the team invites. (optional) * @return TeamInvitesResponse * @throws ApiException if fails to make API call @@ -440,6 +451,7 @@ public ApiResponse teamInvitesWithHttpInfo() throws ApiExce /** * List Team Invites * Provides a list of team invites (and their roles). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamInvitesExample.java * @param emailAddress The email address for which to display the team invites. (optional) * @return ApiResponse<TeamInvitesResponse> * @throws ApiException if fails to make API call @@ -484,6 +496,7 @@ public ApiResponse teamInvitesWithHttpInfo(String emailAddr /** * List Team Members * Provides a paginated list of members (and their roles) that belong to a given team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamMembersExample.java * @param teamId The id of the team that a member list is being requested from. (required) * @param page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -544,6 +557,7 @@ public ApiResponse teamMembersWithHttpInfo(String teamId, I /** * List Team Members * Provides a paginated list of members (and their roles) that belong to a given team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamMembersExample.java * @param teamId The id of the team that a member list is being requested from. (required) * @param page Which page number of the team member list to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -606,6 +620,7 @@ public ApiResponse teamMembersWithHttpInfo(String teamId, I /** * Remove User from Team * Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamRemoveMemberExample.java * @param teamRemoveMemberRequest (required) * @return TeamGetResponse * @throws ApiException if fails to make API call @@ -625,6 +640,7 @@ public TeamGetResponse teamRemoveMember(TeamRemoveMemberRequest teamRemoveMember /** * Remove User from Team * Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamRemoveMemberExample.java * @param teamRemoveMemberRequest (required) * @return ApiResponse<TeamGetResponse> * @throws ApiException if fails to make API call @@ -669,6 +685,7 @@ public ApiResponse teamRemoveMemberWithHttpInfo(TeamRemoveMembe /** * List Sub Teams * Provides a paginated list of sub teams that belong to a given team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamSubTeamsExample.java * @param teamId The id of the parent Team. (required) * @param page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -729,6 +746,7 @@ public ApiResponse teamSubTeamsWithHttpInfo(String teamId, /** * List Sub Teams * Provides a paginated list of sub teams that belong to a given team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamSubTeamsExample.java * @param teamId The id of the parent Team. (required) * @param page Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -791,6 +809,7 @@ public ApiResponse teamSubTeamsWithHttpInfo(String teamId, /** * Update Team * Updates the name of your Team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamUpdateExample.java * @param teamUpdateRequest (required) * @return TeamGetResponse * @throws ApiException if fails to make API call @@ -810,6 +829,7 @@ public TeamGetResponse teamUpdate(TeamUpdateRequest teamUpdateRequest) throws Ap /** * Update Team * Updates the name of your Team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TeamUpdateExample.java * @param teamUpdateRequest (required) * @return ApiResponse<TeamGetResponse> * @throws ApiException if fails to make API call diff --git a/src/main/java/com/dropbox/sign/api/TemplateApi.java b/src/main/java/com/dropbox/sign/api/TemplateApi.java index f6f6d25..b26de1c 100644 --- a/src/main/java/com/dropbox/sign/api/TemplateApi.java +++ b/src/main/java/com/dropbox/sign/api/TemplateApi.java @@ -62,6 +62,7 @@ public void setApiClient(ApiClient apiClient) { /** * Add User to Template * Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateAddUserExample.java * @param templateId The id of the Template to give the Account access to. (required) * @param templateAddUserRequest (required) * @return TemplateGetResponse @@ -82,6 +83,7 @@ public TemplateGetResponse templateAddUser(String templateId, TemplateAddUserReq /** * Add User to Template * Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateAddUserExample.java * @param templateId The id of the Template to give the Account access to. (required) * @param templateAddUserRequest (required) * @return ApiResponse<TemplateGetResponse> @@ -134,6 +136,7 @@ public ApiResponse templateAddUserWithHttpInfo(String templ /** * Create Template * Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateCreateExample.java * @param templateCreateRequest (required) * @return TemplateCreateResponse * @throws ApiException if fails to make API call @@ -153,6 +156,7 @@ public TemplateCreateResponse templateCreate(TemplateCreateRequest templateCreat /** * Create Template * Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateCreateExample.java * @param templateCreateRequest (required) * @return ApiResponse<TemplateCreateResponse> * @throws ApiException if fails to make API call @@ -197,6 +201,7 @@ public ApiResponse templateCreateWithHttpInfo(TemplateCr /** * Create Embedded Template Draft * The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateCreateEmbeddedDraftExample.java * @param templateCreateEmbeddedDraftRequest (required) * @return TemplateCreateEmbeddedDraftResponse * @throws ApiException if fails to make API call @@ -216,6 +221,7 @@ public TemplateCreateEmbeddedDraftResponse templateCreateEmbeddedDraft(TemplateC /** * Create Embedded Template Draft * The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateCreateEmbeddedDraftExample.java * @param templateCreateEmbeddedDraftRequest (required) * @return ApiResponse<TemplateCreateEmbeddedDraftResponse> * @throws ApiException if fails to make API call @@ -260,6 +266,7 @@ public ApiResponse templateCreateEmbeddedDr /** * Delete Template * Completely deletes the template specified from the account. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateDeleteExample.java * @param templateId The id of the Template to delete. (required) * @throws ApiException if fails to make API call * @http.response.details @@ -278,6 +285,7 @@ public void templateDelete(String templateId) throws ApiException { /** * Delete Template * Completely deletes the template specified from the account. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateDeleteExample.java * @param templateId The id of the Template to delete. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -325,6 +333,7 @@ public ApiResponse templateDeleteWithHttpInfo(String templateId) throws Ap /** * Get Template Files * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesExample.java * @param templateId The id of the template files to retrieve. (required) * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * @return File @@ -364,6 +373,7 @@ public ApiResponse templateFilesWithHttpInfo(String templateId) throws Api /** * Get Template Files * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesExample.java * @param templateId The id of the template files to retrieve. (required) * @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional) * @return ApiResponse<File> @@ -418,6 +428,7 @@ public ApiResponse templateFilesWithHttpInfo(String templateId, String fil /** * Get Template Files as Data Uri * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesAsDataUriExample.java * @param templateId The id of the template files to retrieve. (required) * @return FileResponseDataUri * @throws ApiException if fails to make API call @@ -437,6 +448,7 @@ public FileResponseDataUri templateFilesAsDataUri(String templateId) throws ApiE /** * Get Template Files as Data Uri * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesAsDataUriExample.java * @param templateId The id of the template files to retrieve. (required) * @return ApiResponse<FileResponseDataUri> * @throws ApiException if fails to make API call @@ -485,6 +497,7 @@ public ApiResponse templateFilesAsDataUriWithHttpInfo(Strin /** * Get Template Files as File Url * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesAsFileUrlExample.java * @param templateId The id of the template files to retrieve. (required) * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @return FileResponse @@ -524,6 +537,7 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo(String templ /** * Get Template Files as File Url * Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateFilesAsFileUrlExample.java * @param templateId The id of the template files to retrieve. (required) * @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1) * @return ApiResponse<FileResponse> @@ -581,6 +595,7 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo(String templ /** * Get Template * Returns the Template specified by the `template_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateGetExample.java * @param templateId The id of the Template to retrieve. (required) * @return TemplateGetResponse * @throws ApiException if fails to make API call @@ -600,6 +615,7 @@ public TemplateGetResponse templateGet(String templateId) throws ApiException { /** * Get Template * Returns the Template specified by the `template_id` parameter. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateGetExample.java * @param templateId The id of the Template to retrieve. (required) * @return ApiResponse<TemplateGetResponse> * @throws ApiException if fails to make API call @@ -648,6 +664,7 @@ public ApiResponse templateGetWithHttpInfo(String templateI /** * List Templates * Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateListExample.java * @param accountId Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -755,6 +772,7 @@ public ApiResponse templateListWithHttpInfo(String account /** * List Templates * Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateListExample.java * @param accountId Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional) * @param page Which page number of the Template List to return. Defaults to `1`. (optional, default to 1) * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) @@ -811,6 +829,7 @@ public ApiResponse templateListWithHttpInfo(String account /** * Remove User from Template * Removes the specified Account's access to the specified Template. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateRemoveUserExample.java * @param templateId The id of the Template to remove the Account's access to. (required) * @param templateRemoveUserRequest (required) * @return TemplateGetResponse @@ -831,6 +850,7 @@ public TemplateGetResponse templateRemoveUser(String templateId, TemplateRemoveU /** * Remove User from Template * Removes the specified Account's access to the specified Template. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateRemoveUserExample.java * @param templateId The id of the Template to remove the Account's access to. (required) * @param templateRemoveUserRequest (required) * @return ApiResponse<TemplateGetResponse> @@ -883,6 +903,7 @@ public ApiResponse templateRemoveUserWithHttpInfo(String te /** * Update Template Files * Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateUpdateFilesExample.java * @param templateId The ID of the template whose files to update. (required) * @param templateUpdateFilesRequest (required) * @return TemplateUpdateFilesResponse @@ -903,6 +924,7 @@ public TemplateUpdateFilesResponse templateUpdateFiles(String templateId, Templa /** * Update Template Files * Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/TemplateUpdateFilesExample.java * @param templateId The ID of the template whose files to update. (required) * @param templateUpdateFilesRequest (required) * @return ApiResponse<TemplateUpdateFilesResponse> diff --git a/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java b/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java index 8416bd8..f2ce337 100644 --- a/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java +++ b/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java @@ -54,6 +54,7 @@ public void setApiClient(ApiClient apiClient) { /** * Create Unclaimed Draft * Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateExample.java * @param unclaimedDraftCreateRequest (required) * @return UnclaimedDraftCreateResponse * @throws ApiException if fails to make API call @@ -73,6 +74,7 @@ public UnclaimedDraftCreateResponse unclaimedDraftCreate(UnclaimedDraftCreateReq /** * Create Unclaimed Draft * Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateExample.java * @param unclaimedDraftCreateRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @throws ApiException if fails to make API call @@ -117,6 +119,7 @@ public ApiResponse unclaimedDraftCreateWithHttpInf /** * Create Embedded Unclaimed Draft * Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.java * @param unclaimedDraftCreateEmbeddedRequest (required) * @return UnclaimedDraftCreateResponse * @throws ApiException if fails to make API call @@ -136,6 +139,7 @@ public UnclaimedDraftCreateResponse unclaimedDraftCreateEmbedded(UnclaimedDraftC /** * Create Embedded Unclaimed Draft * Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateEmbeddedExample.java * @param unclaimedDraftCreateEmbeddedRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @throws ApiException if fails to make API call @@ -180,6 +184,7 @@ public ApiResponse unclaimedDraftCreateEmbeddedWit /** * Create Embedded Unclaimed Draft with Template * Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java * @param unclaimedDraftCreateEmbeddedWithTemplateRequest (required) * @return UnclaimedDraftCreateResponse * @throws ApiException if fails to make API call @@ -199,6 +204,7 @@ public UnclaimedDraftCreateResponse unclaimedDraftCreateEmbeddedWithTemplate(Unc /** * Create Embedded Unclaimed Draft with Template * Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java * @param unclaimedDraftCreateEmbeddedWithTemplateRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @throws ApiException if fails to make API call @@ -243,6 +249,7 @@ public ApiResponse unclaimedDraftCreateEmbeddedWit /** * Edit and Resend Unclaimed Draft * Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftEditAndResendExample.java * @param signatureRequestId The ID of the signature request to edit and resend. (required) * @param unclaimedDraftEditAndResendRequest (required) * @return UnclaimedDraftCreateResponse @@ -263,6 +270,7 @@ public UnclaimedDraftCreateResponse unclaimedDraftEditAndResend(String signature /** * Edit and Resend Unclaimed Draft * Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/UnclaimedDraftEditAndResendExample.java * @param signatureRequestId The ID of the signature request to edit and resend. (required) * @param unclaimedDraftEditAndResendRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> diff --git a/src/main/java/com/dropbox/sign/model/DocumentFieldDetectionRequest.java b/src/main/java/com/dropbox/sign/model/DocumentFieldDetectionRequest.java new file mode 100644 index 0000000..75d2600 --- /dev/null +++ b/src/main/java/com/dropbox/sign/model/DocumentFieldDetectionRequest.java @@ -0,0 +1,334 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.io.File; +import java.net.URI; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * DocumentFieldDetectionRequest + */ +@JsonPropertyOrder({ + DocumentFieldDetectionRequest.JSON_PROPERTY_DETECTION_MODE, + DocumentFieldDetectionRequest.JSON_PROPERTY_FILE, + DocumentFieldDetectionRequest.JSON_PROPERTY_FILE_URL, + DocumentFieldDetectionRequest.JSON_PROPERTY_PAGE_RANGE +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class DocumentFieldDetectionRequest { + public static final String JSON_PROPERTY_DETECTION_MODE = "detection_mode"; + @jakarta.annotation.Nonnull + private String detectionMode; + + public static final String JSON_PROPERTY_FILE = "file"; + @jakarta.annotation.Nullable + private File _file; + + public static final String JSON_PROPERTY_FILE_URL = "file_url"; + @jakarta.annotation.Nullable + private URI fileUrl; + + public static final String JSON_PROPERTY_PAGE_RANGE = "page_range"; + @jakarta.annotation.Nullable + private String pageRange; + + public DocumentFieldDetectionRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public DocumentFieldDetectionRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, DocumentFieldDetectionRequest.class); + } + + static public DocumentFieldDetectionRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + DocumentFieldDetectionRequest.class + ); + } + + public DocumentFieldDetectionRequest detectionMode(@jakarta.annotation.Nonnull String detectionMode) { + this.detectionMode = detectionMode; + return this; + } + + /** + * The field detection method to use. Set to `annotations` to detect PDF form annotations or `text_tags` to detect Dropbox Sign text tags. + * @return detectionMode + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DETECTION_MODE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getDetectionMode() { + return detectionMode; + } + + + @JsonProperty(JSON_PROPERTY_DETECTION_MODE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDetectionMode(@jakarta.annotation.Nonnull String detectionMode) { + this.detectionMode = detectionMode; + } + + + public DocumentFieldDetectionRequest _file(@jakarta.annotation.Nullable File _file) { + this._file = _file; + return this; + } + + /** + * The PDF file to analyze. This endpoint requires either `file` or `file_url`, but not both. + * @return _file + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public File getFile() { + return _file; + } + + + @JsonProperty(JSON_PROPERTY_FILE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFile(@jakarta.annotation.Nullable File _file) { + this._file = _file; + } + + + public DocumentFieldDetectionRequest fileUrl(@jakarta.annotation.Nullable URI fileUrl) { + this.fileUrl = fileUrl; + return this; + } + + /** + * The URL of the PDF file to analyze. This endpoint requires either `file` or `file_url`, but not both. + * @return fileUrl + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public URI getFileUrl() { + return fileUrl; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrl(@jakarta.annotation.Nullable URI fileUrl) { + this.fileUrl = fileUrl; + } + + + public DocumentFieldDetectionRequest pageRange(@jakarta.annotation.Nullable String pageRange) { + this.pageRange = pageRange; + return this; + } + + /** + * 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`. + * @return pageRange + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_PAGE_RANGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getPageRange() { + return pageRange; + } + + + @JsonProperty(JSON_PROPERTY_PAGE_RANGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPageRange(@jakarta.annotation.Nullable String pageRange) { + this.pageRange = pageRange; + } + + + /** + * Return true if this DocumentFieldDetectionRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DocumentFieldDetectionRequest documentFieldDetectionRequest = (DocumentFieldDetectionRequest) o; + return Objects.equals(this.detectionMode, documentFieldDetectionRequest.detectionMode) && + Objects.equals(this._file, documentFieldDetectionRequest._file) && + Objects.equals(this.fileUrl, documentFieldDetectionRequest.fileUrl) && + Objects.equals(this.pageRange, documentFieldDetectionRequest.pageRange); + } + + @Override + public int hashCode() { + return Objects.hash(detectionMode, _file, fileUrl, pageRange); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DocumentFieldDetectionRequest {\n"); + sb.append(" detectionMode: ").append(toIndentedString(detectionMode)).append("\n"); + sb.append(" _file: ").append(toIndentedString(_file)).append("\n"); + sb.append(" fileUrl: ").append(toIndentedString(fileUrl)).append("\n"); + sb.append(" pageRange: ").append(toIndentedString(pageRange)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (detectionMode != null) { + if (isFileTypeOrListOfFiles(detectionMode)) { + fileTypeFound = true; + } + + if (detectionMode.getClass().equals(java.io.File.class) || + detectionMode.getClass().equals(Integer.class) || + detectionMode.getClass().equals(String.class) || + detectionMode.getClass().isEnum()) { + map.put("detection_mode", detectionMode); + } else if (isListOfFile(detectionMode)) { + for(int i = 0; i< getListSize(detectionMode); i++) { + map.put("detection_mode[" + i + "]", getFromList(detectionMode, i)); + } + } + else { + map.put("detection_mode", JSON.getDefault().getMapper().writeValueAsString(detectionMode)); + } + } + if (_file != null) { + if (isFileTypeOrListOfFiles(_file)) { + fileTypeFound = true; + } + + if (_file.getClass().equals(java.io.File.class) || + _file.getClass().equals(Integer.class) || + _file.getClass().equals(String.class) || + _file.getClass().isEnum()) { + map.put("file", _file); + } else if (isListOfFile(_file)) { + for(int i = 0; i< getListSize(_file); i++) { + map.put("file[" + i + "]", getFromList(_file, i)); + } + } + else { + map.put("file", JSON.getDefault().getMapper().writeValueAsString(_file)); + } + } + if (fileUrl != null) { + if (isFileTypeOrListOfFiles(fileUrl)) { + fileTypeFound = true; + } + + if (fileUrl.getClass().equals(java.io.File.class) || + fileUrl.getClass().equals(Integer.class) || + fileUrl.getClass().equals(String.class) || + fileUrl.getClass().isEnum()) { + map.put("file_url", fileUrl); + } else if (isListOfFile(fileUrl)) { + for(int i = 0; i< getListSize(fileUrl); i++) { + map.put("file_url[" + i + "]", getFromList(fileUrl, i)); + } + } + else { + map.put("file_url", JSON.getDefault().getMapper().writeValueAsString(fileUrl)); + } + } + if (pageRange != null) { + if (isFileTypeOrListOfFiles(pageRange)) { + fileTypeFound = true; + } + + if (pageRange.getClass().equals(java.io.File.class) || + pageRange.getClass().equals(Integer.class) || + pageRange.getClass().equals(String.class) || + pageRange.getClass().isEnum()) { + map.put("page_range", pageRange); + } else if (isListOfFile(pageRange)) { + for(int i = 0; i< getListSize(pageRange); i++) { + map.put("page_range[" + i + "]", getFromList(pageRange, i)); + } + } + else { + map.put("page_range", JSON.getDefault().getMapper().writeValueAsString(pageRange)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/dropbox/sign/model/DocumentFieldDetectionResponse.java b/src/main/java/com/dropbox/sign/model/DocumentFieldDetectionResponse.java new file mode 100644 index 0000000..d1cdd7b --- /dev/null +++ b/src/main/java/com/dropbox/sign/model/DocumentFieldDetectionResponse.java @@ -0,0 +1,242 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.dropbox.sign.model.DocumentFieldDetectionResponseDetectionResult; +import com.dropbox.sign.model.WarningResponse; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * DocumentFieldDetectionResponse + */ +@JsonPropertyOrder({ + DocumentFieldDetectionResponse.JSON_PROPERTY_DETECTION_RESULT, + DocumentFieldDetectionResponse.JSON_PROPERTY_WARNINGS +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class DocumentFieldDetectionResponse { + public static final String JSON_PROPERTY_DETECTION_RESULT = "detection_result"; + @jakarta.annotation.Nonnull + private DocumentFieldDetectionResponseDetectionResult detectionResult; + + public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable + private List warnings = null; + + public DocumentFieldDetectionResponse() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public DocumentFieldDetectionResponse init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, DocumentFieldDetectionResponse.class); + } + + static public DocumentFieldDetectionResponse init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + DocumentFieldDetectionResponse.class + ); + } + + public DocumentFieldDetectionResponse detectionResult(@jakarta.annotation.Nonnull DocumentFieldDetectionResponseDetectionResult detectionResult) { + this.detectionResult = detectionResult; + return this; + } + + /** + * Get detectionResult + * @return detectionResult + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DETECTION_RESULT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public DocumentFieldDetectionResponseDetectionResult getDetectionResult() { + return detectionResult; + } + + + @JsonProperty(JSON_PROPERTY_DETECTION_RESULT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDetectionResult(@jakarta.annotation.Nonnull DocumentFieldDetectionResponseDetectionResult detectionResult) { + this.detectionResult = detectionResult; + } + + + public DocumentFieldDetectionResponse warnings(@jakarta.annotation.Nullable List warnings) { + this.warnings = warnings; + return this; + } + + public DocumentFieldDetectionResponse addWarningsItem(WarningResponse warningsItem) { + if (this.warnings == null) { + this.warnings = new ArrayList<>(); + } + this.warnings.add(warningsItem); + return this; + } + + /** + * A list of warnings. + * @return warnings + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_WARNINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getWarnings() { + return warnings; + } + + + @JsonProperty(JSON_PROPERTY_WARNINGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setWarnings(@jakarta.annotation.Nullable List warnings) { + this.warnings = warnings; + } + + + /** + * Return true if this DocumentFieldDetectionResponse object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DocumentFieldDetectionResponse documentFieldDetectionResponse = (DocumentFieldDetectionResponse) o; + return Objects.equals(this.detectionResult, documentFieldDetectionResponse.detectionResult) && + Objects.equals(this.warnings, documentFieldDetectionResponse.warnings); + } + + @Override + public int hashCode() { + return Objects.hash(detectionResult, warnings); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DocumentFieldDetectionResponse {\n"); + sb.append(" detectionResult: ").append(toIndentedString(detectionResult)).append("\n"); + sb.append(" warnings: ").append(toIndentedString(warnings)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (detectionResult != null) { + if (isFileTypeOrListOfFiles(detectionResult)) { + fileTypeFound = true; + } + + if (detectionResult.getClass().equals(java.io.File.class) || + detectionResult.getClass().equals(Integer.class) || + detectionResult.getClass().equals(String.class) || + detectionResult.getClass().isEnum()) { + map.put("detection_result", detectionResult); + } else if (isListOfFile(detectionResult)) { + for(int i = 0; i< getListSize(detectionResult); i++) { + map.put("detection_result[" + i + "]", getFromList(detectionResult, i)); + } + } + else { + map.put("detection_result", JSON.getDefault().getMapper().writeValueAsString(detectionResult)); + } + } + if (warnings != null) { + if (isFileTypeOrListOfFiles(warnings)) { + fileTypeFound = true; + } + + if (warnings.getClass().equals(java.io.File.class) || + warnings.getClass().equals(Integer.class) || + warnings.getClass().equals(String.class) || + warnings.getClass().isEnum()) { + map.put("warnings", warnings); + } else if (isListOfFile(warnings)) { + for(int i = 0; i< getListSize(warnings); i++) { + map.put("warnings[" + i + "]", getFromList(warnings, i)); + } + } + else { + map.put("warnings", JSON.getDefault().getMapper().writeValueAsString(warnings)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/dropbox/sign/model/DocumentFieldDetectionResponseDetectionResult.java b/src/main/java/com/dropbox/sign/model/DocumentFieldDetectionResponseDetectionResult.java new file mode 100644 index 0000000..a5f46f3 --- /dev/null +++ b/src/main/java/com/dropbox/sign/model/DocumentFieldDetectionResponseDetectionResult.java @@ -0,0 +1,685 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.dropbox.sign.model.ErrorResponseError; +import com.dropbox.sign.model.SubFormFieldGroup; +import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; +import com.dropbox.sign.model.WarningResponse; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * DocumentFieldDetectionResponseDetectionResult + */ +@JsonPropertyOrder({ + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_DOCUMENT_HASH, + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_DETECTION_MODE, + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_PAGE_COUNT, + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_PAGES_ANALYZED, + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_DETECTED_AT, + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT, + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_FORM_FIELD_GROUPS, + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_WARNINGS, + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_ERRORS, + DocumentFieldDetectionResponseDetectionResult.JSON_PROPERTY_SUGGESTIONS +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class DocumentFieldDetectionResponseDetectionResult { + public static final String JSON_PROPERTY_DOCUMENT_HASH = "document_hash"; + @jakarta.annotation.Nonnull + private String documentHash; + + public static final String JSON_PROPERTY_DETECTION_MODE = "detection_mode"; + @jakarta.annotation.Nonnull + private String detectionMode; + + public static final String JSON_PROPERTY_PAGE_COUNT = "page_count"; + @jakarta.annotation.Nonnull + private Integer pageCount; + + public static final String JSON_PROPERTY_PAGES_ANALYZED = "pages_analyzed"; + @jakarta.annotation.Nonnull + private String pagesAnalyzed; + + public static final String JSON_PROPERTY_DETECTED_AT = "detected_at"; + @jakarta.annotation.Nonnull + private Long detectedAt; + + public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + @jakarta.annotation.Nonnull + private List formFieldsPerDocument = new ArrayList<>(); + + public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + @jakarta.annotation.Nonnull + private List formFieldGroups = new ArrayList<>(); + + public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nonnull + private List warnings = new ArrayList<>(); + + public static final String JSON_PROPERTY_ERRORS = "errors"; + @jakarta.annotation.Nonnull + private List errors = new ArrayList<>(); + + public static final String JSON_PROPERTY_SUGGESTIONS = "suggestions"; + @jakarta.annotation.Nonnull + private List suggestions = new ArrayList<>(); + + public DocumentFieldDetectionResponseDetectionResult() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public DocumentFieldDetectionResponseDetectionResult init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, DocumentFieldDetectionResponseDetectionResult.class); + } + + static public DocumentFieldDetectionResponseDetectionResult init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + DocumentFieldDetectionResponseDetectionResult.class + ); + } + + public DocumentFieldDetectionResponseDetectionResult documentHash(@jakarta.annotation.Nonnull String documentHash) { + this.documentHash = documentHash; + return this; + } + + /** + * The SHA-256 hash of the analyzed document. + * @return documentHash + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DOCUMENT_HASH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getDocumentHash() { + return documentHash; + } + + + @JsonProperty(JSON_PROPERTY_DOCUMENT_HASH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDocumentHash(@jakarta.annotation.Nonnull String documentHash) { + this.documentHash = documentHash; + } + + + public DocumentFieldDetectionResponseDetectionResult detectionMode(@jakarta.annotation.Nonnull String detectionMode) { + this.detectionMode = detectionMode; + return this; + } + + /** + * The field detection method used to analyze the document: `annotations` or `text_tags`. + * @return detectionMode + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DETECTION_MODE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getDetectionMode() { + return detectionMode; + } + + + @JsonProperty(JSON_PROPERTY_DETECTION_MODE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDetectionMode(@jakarta.annotation.Nonnull String detectionMode) { + this.detectionMode = detectionMode; + } + + + public DocumentFieldDetectionResponseDetectionResult pageCount(@jakarta.annotation.Nonnull Integer pageCount) { + this.pageCount = pageCount; + return this; + } + + /** + * The total number of pages in the document. + * minimum: 0 + * @return pageCount + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_PAGE_COUNT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public Integer getPageCount() { + return pageCount; + } + + + @JsonProperty(JSON_PROPERTY_PAGE_COUNT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setPageCount(@jakarta.annotation.Nonnull Integer pageCount) { + this.pageCount = pageCount; + } + + + public DocumentFieldDetectionResponseDetectionResult pagesAnalyzed(@jakarta.annotation.Nonnull String pagesAnalyzed) { + this.pagesAnalyzed = pagesAnalyzed; + return this; + } + + /** + * The zero-based page indexes analyzed, represented by the requested `page_range`, or `all` when every page was analyzed. + * @return pagesAnalyzed + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_PAGES_ANALYZED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getPagesAnalyzed() { + return pagesAnalyzed; + } + + + @JsonProperty(JSON_PROPERTY_PAGES_ANALYZED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setPagesAnalyzed(@jakarta.annotation.Nonnull String pagesAnalyzed) { + this.pagesAnalyzed = pagesAnalyzed; + } + + + public DocumentFieldDetectionResponseDetectionResult detectedAt(@jakarta.annotation.Nonnull Long detectedAt) { + this.detectedAt = detectedAt; + return this; + } + + /** + * The Unix timestamp when the field detection result was generated. + * @return detectedAt + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DETECTED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public Long getDetectedAt() { + return detectedAt; + } + + + @JsonProperty(JSON_PROPERTY_DETECTED_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDetectedAt(@jakarta.annotation.Nonnull Long detectedAt) { + this.detectedAt = detectedAt; + } + + + public DocumentFieldDetectionResponseDetectionResult formFieldsPerDocument(@jakarta.annotation.Nonnull List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + return this; + } + + public DocumentFieldDetectionResponseDetectionResult addFormFieldsPerDocumentItem(SubFormFieldsPerDocumentBase formFieldsPerDocumentItem) { + if (this.formFieldsPerDocument == null) { + this.formFieldsPerDocument = new ArrayList<>(); + } + this.formFieldsPerDocument.add(formFieldsPerDocumentItem); + return this; + } + + /** + * 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` + * @return formFieldsPerDocument + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getFormFieldsPerDocument() { + return formFieldsPerDocument; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFormFieldsPerDocument(@jakarta.annotation.Nonnull List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + } + + + public DocumentFieldDetectionResponseDetectionResult formFieldGroups(@jakarta.annotation.Nonnull List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + return this; + } + + public DocumentFieldDetectionResponseDetectionResult addFormFieldGroupsItem(SubFormFieldGroup formFieldGroupsItem) { + if (this.formFieldGroups == null) { + this.formFieldGroups = new ArrayList<>(); + } + this.formFieldGroups.add(formFieldGroupsItem); + return this; + } + + /** + * 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`. + * @return formFieldGroups + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getFormFieldGroups() { + return formFieldGroups; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFormFieldGroups(@jakarta.annotation.Nonnull List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + } + + + public DocumentFieldDetectionResponseDetectionResult warnings(@jakarta.annotation.Nonnull List warnings) { + this.warnings = warnings; + return this; + } + + public DocumentFieldDetectionResponseDetectionResult addWarningsItem(WarningResponse warningsItem) { + if (this.warnings == null) { + this.warnings = new ArrayList<>(); + } + this.warnings.add(warningsItem); + return this; + } + + /** + * Non-fatal issues encountered during field detection. + * @return warnings + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_WARNINGS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getWarnings() { + return warnings; + } + + + @JsonProperty(JSON_PROPERTY_WARNINGS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setWarnings(@jakarta.annotation.Nonnull List warnings) { + this.warnings = warnings; + } + + + public DocumentFieldDetectionResponseDetectionResult errors(@jakarta.annotation.Nonnull List errors) { + this.errors = errors; + return this; + } + + public DocumentFieldDetectionResponseDetectionResult addErrorsItem(ErrorResponseError errorsItem) { + if (this.errors == null) { + this.errors = new ArrayList<>(); + } + this.errors.add(errorsItem); + return this; + } + + /** + * Errors encountered during field detection. Successfully detected fields may still be included in the response. + * @return errors + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ERRORS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getErrors() { + return errors; + } + + + @JsonProperty(JSON_PROPERTY_ERRORS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setErrors(@jakarta.annotation.Nonnull List errors) { + this.errors = errors; + } + + + public DocumentFieldDetectionResponseDetectionResult suggestions(@jakarta.annotation.Nonnull List suggestions) { + this.suggestions = suggestions; + return this; + } + + public DocumentFieldDetectionResponseDetectionResult addSuggestionsItem(String suggestionsItem) { + if (this.suggestions == null) { + this.suggestions = new ArrayList<>(); + } + this.suggestions.add(suggestionsItem); + return this; + } + + /** + * Suggestions for improving the field detection results. + * @return suggestions + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SUGGESTIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getSuggestions() { + return suggestions; + } + + + @JsonProperty(JSON_PROPERTY_SUGGESTIONS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSuggestions(@jakarta.annotation.Nonnull List suggestions) { + this.suggestions = suggestions; + } + + + /** + * Return true if this DocumentFieldDetectionResponseDetectionResult object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + DocumentFieldDetectionResponseDetectionResult documentFieldDetectionResponseDetectionResult = (DocumentFieldDetectionResponseDetectionResult) o; + return Objects.equals(this.documentHash, documentFieldDetectionResponseDetectionResult.documentHash) && + Objects.equals(this.detectionMode, documentFieldDetectionResponseDetectionResult.detectionMode) && + Objects.equals(this.pageCount, documentFieldDetectionResponseDetectionResult.pageCount) && + Objects.equals(this.pagesAnalyzed, documentFieldDetectionResponseDetectionResult.pagesAnalyzed) && + Objects.equals(this.detectedAt, documentFieldDetectionResponseDetectionResult.detectedAt) && + Objects.equals(this.formFieldsPerDocument, documentFieldDetectionResponseDetectionResult.formFieldsPerDocument) && + Objects.equals(this.formFieldGroups, documentFieldDetectionResponseDetectionResult.formFieldGroups) && + Objects.equals(this.warnings, documentFieldDetectionResponseDetectionResult.warnings) && + Objects.equals(this.errors, documentFieldDetectionResponseDetectionResult.errors) && + Objects.equals(this.suggestions, documentFieldDetectionResponseDetectionResult.suggestions); + } + + @Override + public int hashCode() { + return Objects.hash(documentHash, detectionMode, pageCount, pagesAnalyzed, detectedAt, formFieldsPerDocument, formFieldGroups, warnings, errors, suggestions); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class DocumentFieldDetectionResponseDetectionResult {\n"); + sb.append(" documentHash: ").append(toIndentedString(documentHash)).append("\n"); + sb.append(" detectionMode: ").append(toIndentedString(detectionMode)).append("\n"); + sb.append(" pageCount: ").append(toIndentedString(pageCount)).append("\n"); + sb.append(" pagesAnalyzed: ").append(toIndentedString(pagesAnalyzed)).append("\n"); + sb.append(" detectedAt: ").append(toIndentedString(detectedAt)).append("\n"); + sb.append(" formFieldsPerDocument: ").append(toIndentedString(formFieldsPerDocument)).append("\n"); + sb.append(" formFieldGroups: ").append(toIndentedString(formFieldGroups)).append("\n"); + sb.append(" warnings: ").append(toIndentedString(warnings)).append("\n"); + sb.append(" errors: ").append(toIndentedString(errors)).append("\n"); + sb.append(" suggestions: ").append(toIndentedString(suggestions)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (documentHash != null) { + if (isFileTypeOrListOfFiles(documentHash)) { + fileTypeFound = true; + } + + if (documentHash.getClass().equals(java.io.File.class) || + documentHash.getClass().equals(Integer.class) || + documentHash.getClass().equals(String.class) || + documentHash.getClass().isEnum()) { + map.put("document_hash", documentHash); + } else if (isListOfFile(documentHash)) { + for(int i = 0; i< getListSize(documentHash); i++) { + map.put("document_hash[" + i + "]", getFromList(documentHash, i)); + } + } + else { + map.put("document_hash", JSON.getDefault().getMapper().writeValueAsString(documentHash)); + } + } + if (detectionMode != null) { + if (isFileTypeOrListOfFiles(detectionMode)) { + fileTypeFound = true; + } + + if (detectionMode.getClass().equals(java.io.File.class) || + detectionMode.getClass().equals(Integer.class) || + detectionMode.getClass().equals(String.class) || + detectionMode.getClass().isEnum()) { + map.put("detection_mode", detectionMode); + } else if (isListOfFile(detectionMode)) { + for(int i = 0; i< getListSize(detectionMode); i++) { + map.put("detection_mode[" + i + "]", getFromList(detectionMode, i)); + } + } + else { + map.put("detection_mode", JSON.getDefault().getMapper().writeValueAsString(detectionMode)); + } + } + if (pageCount != null) { + if (isFileTypeOrListOfFiles(pageCount)) { + fileTypeFound = true; + } + + if (pageCount.getClass().equals(java.io.File.class) || + pageCount.getClass().equals(Integer.class) || + pageCount.getClass().equals(String.class) || + pageCount.getClass().isEnum()) { + map.put("page_count", pageCount); + } else if (isListOfFile(pageCount)) { + for(int i = 0; i< getListSize(pageCount); i++) { + map.put("page_count[" + i + "]", getFromList(pageCount, i)); + } + } + else { + map.put("page_count", JSON.getDefault().getMapper().writeValueAsString(pageCount)); + } + } + if (pagesAnalyzed != null) { + if (isFileTypeOrListOfFiles(pagesAnalyzed)) { + fileTypeFound = true; + } + + if (pagesAnalyzed.getClass().equals(java.io.File.class) || + pagesAnalyzed.getClass().equals(Integer.class) || + pagesAnalyzed.getClass().equals(String.class) || + pagesAnalyzed.getClass().isEnum()) { + map.put("pages_analyzed", pagesAnalyzed); + } else if (isListOfFile(pagesAnalyzed)) { + for(int i = 0; i< getListSize(pagesAnalyzed); i++) { + map.put("pages_analyzed[" + i + "]", getFromList(pagesAnalyzed, i)); + } + } + else { + map.put("pages_analyzed", JSON.getDefault().getMapper().writeValueAsString(pagesAnalyzed)); + } + } + if (detectedAt != null) { + if (isFileTypeOrListOfFiles(detectedAt)) { + fileTypeFound = true; + } + + if (detectedAt.getClass().equals(java.io.File.class) || + detectedAt.getClass().equals(Integer.class) || + detectedAt.getClass().equals(String.class) || + detectedAt.getClass().isEnum()) { + map.put("detected_at", detectedAt); + } else if (isListOfFile(detectedAt)) { + for(int i = 0; i< getListSize(detectedAt); i++) { + map.put("detected_at[" + i + "]", getFromList(detectedAt, i)); + } + } + else { + map.put("detected_at", JSON.getDefault().getMapper().writeValueAsString(detectedAt)); + } + } + if (formFieldsPerDocument != null) { + if (isFileTypeOrListOfFiles(formFieldsPerDocument)) { + fileTypeFound = true; + } + + if (formFieldsPerDocument.getClass().equals(java.io.File.class) || + formFieldsPerDocument.getClass().equals(Integer.class) || + formFieldsPerDocument.getClass().equals(String.class) || + formFieldsPerDocument.getClass().isEnum()) { + map.put("form_fields_per_document", formFieldsPerDocument); + } else if (isListOfFile(formFieldsPerDocument)) { + for(int i = 0; i< getListSize(formFieldsPerDocument); i++) { + map.put("form_fields_per_document[" + i + "]", getFromList(formFieldsPerDocument, i)); + } + } + else { + map.put("form_fields_per_document", JSON.getDefault().getMapper().writeValueAsString(formFieldsPerDocument)); + } + } + if (formFieldGroups != null) { + if (isFileTypeOrListOfFiles(formFieldGroups)) { + fileTypeFound = true; + } + + if (formFieldGroups.getClass().equals(java.io.File.class) || + formFieldGroups.getClass().equals(Integer.class) || + formFieldGroups.getClass().equals(String.class) || + formFieldGroups.getClass().isEnum()) { + map.put("form_field_groups", formFieldGroups); + } else if (isListOfFile(formFieldGroups)) { + for(int i = 0; i< getListSize(formFieldGroups); i++) { + map.put("form_field_groups[" + i + "]", getFromList(formFieldGroups, i)); + } + } + else { + map.put("form_field_groups", JSON.getDefault().getMapper().writeValueAsString(formFieldGroups)); + } + } + if (warnings != null) { + if (isFileTypeOrListOfFiles(warnings)) { + fileTypeFound = true; + } + + if (warnings.getClass().equals(java.io.File.class) || + warnings.getClass().equals(Integer.class) || + warnings.getClass().equals(String.class) || + warnings.getClass().isEnum()) { + map.put("warnings", warnings); + } else if (isListOfFile(warnings)) { + for(int i = 0; i< getListSize(warnings); i++) { + map.put("warnings[" + i + "]", getFromList(warnings, i)); + } + } + else { + map.put("warnings", JSON.getDefault().getMapper().writeValueAsString(warnings)); + } + } + if (errors != null) { + if (isFileTypeOrListOfFiles(errors)) { + fileTypeFound = true; + } + + if (errors.getClass().equals(java.io.File.class) || + errors.getClass().equals(Integer.class) || + errors.getClass().equals(String.class) || + errors.getClass().isEnum()) { + map.put("errors", errors); + } else if (isListOfFile(errors)) { + for(int i = 0; i< getListSize(errors); i++) { + map.put("errors[" + i + "]", getFromList(errors, i)); + } + } + else { + map.put("errors", JSON.getDefault().getMapper().writeValueAsString(errors)); + } + } + if (suggestions != null) { + if (isFileTypeOrListOfFiles(suggestions)) { + fileTypeFound = true; + } + + if (suggestions.getClass().equals(java.io.File.class) || + suggestions.getClass().equals(Integer.class) || + suggestions.getClass().equals(String.class) || + suggestions.getClass().isEnum()) { + map.put("suggestions", suggestions); + } else if (isListOfFile(suggestions)) { + for(int i = 0; i< getListSize(suggestions); i++) { + map.put("suggestions[" + i + "]", getFromList(suggestions, i)); + } + } + else { + map.put("suggestions", JSON.getDefault().getMapper().writeValueAsString(suggestions)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/com/dropbox/sign/model/ErrorResponseError.java b/src/main/java/com/dropbox/sign/model/ErrorResponseError.java index af87ec4..9398b04 100644 --- a/src/main/java/com/dropbox/sign/model/ErrorResponseError.java +++ b/src/main/java/com/dropbox/sign/model/ErrorResponseError.java @@ -101,7 +101,7 @@ public ErrorResponseError errorName(@jakarta.annotation.Nonnull String errorName } /** - * Name of the error. + * 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. * @return errorName */ @jakarta.annotation.Nonnull diff --git a/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java b/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java index 6004304..ac04a69 100644 --- a/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java +++ b/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java @@ -94,7 +94,21 @@ public enum EventTypeEnum { CALLBACK_TEST(String.valueOf("callback_test")), - SIGNATURE_REQUEST_SIGNER_REMOVED(String.valueOf("signature_request_signer_removed")); + SIGNATURE_REQUEST_SIGNER_REMOVED(String.valueOf("signature_request_signer_removed")), + + FAX_RECEIVED(String.valueOf("fax_received")), + + FAX_SENT(String.valueOf("fax_sent")), + + FAX_ON_HOLD(String.valueOf("fax_on_hold")), + + FAX_BUSY(String.valueOf("fax_busy")), + + FAX_NO_ANSWER(String.valueOf("fax_no_answer")), + + FAX_DISCONNECTED(String.valueOf("fax_disconnected")), + + FAX_BLACKLISTED(String.valueOf("fax_blacklisted")); private String value; diff --git a/src/main/java/com/dropbox/sign/model/FaxResponse.java b/src/main/java/com/dropbox/sign/model/FaxResponse.java index 156435e..8b49f52 100644 --- a/src/main/java/com/dropbox/sign/model/FaxResponse.java +++ b/src/main/java/com/dropbox/sign/model/FaxResponse.java @@ -46,6 +46,7 @@ FaxResponse.JSON_PROPERTY_SENDER, FaxResponse.JSON_PROPERTY_FILES_URL, FaxResponse.JSON_PROPERTY_TRANSMISSIONS, + FaxResponse.JSON_PROPERTY_TEST_MODE, FaxResponse.JSON_PROPERTY_SUBJECT, FaxResponse.JSON_PROPERTY_MESSAGE, FaxResponse.JSON_PROPERTY_FINAL_COPY_URI @@ -85,6 +86,10 @@ public class FaxResponse { @jakarta.annotation.Nonnull private List transmissions = new ArrayList<>(); + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nonnull + private Boolean testMode = false; + public static final String JSON_PROPERTY_SUBJECT = "subject"; @jakarta.annotation.Nullable private String subject; @@ -331,6 +336,31 @@ public void setTransmissions(@jakarta.annotation.Nonnull List createFormData() throws ApiException { map.put("transmissions", JSON.getDefault().getMapper().writeValueAsString(transmissions)); } } + if (testMode != null) { + if (isFileTypeOrListOfFiles(testMode)) { + fileTypeFound = true; + } + + if (testMode.getClass().equals(java.io.File.class) || + testMode.getClass().equals(Integer.class) || + testMode.getClass().equals(String.class) || + testMode.getClass().isEnum()) { + map.put("test_mode", testMode); + } else if (isListOfFile(testMode)) { + for(int i = 0; i< getListSize(testMode); i++) { + map.put("test_mode[" + i + "]", getFromList(testMode, i)); + } + } + else { + map.put("test_mode", JSON.getDefault().getMapper().writeValueAsString(testMode)); + } + } if (subject != null) { if (isFileTypeOrListOfFiles(subject)) { fileTypeFound = true; diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java index 949ddb4..6086d75 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java @@ -53,7 +53,8 @@ SignatureRequestBulkCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, SignatureRequestBulkCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestBulkCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, - SignatureRequestBulkCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE + SignatureRequestBulkCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestBulkCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_EXPIRES_AT }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -110,6 +111,10 @@ public class SignatureRequestBulkCreateEmbeddedWithTemplateRequest { @jakarta.annotation.Nullable private String title; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable + private Integer expiresAt; + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest() { } @@ -493,6 +498,31 @@ public void setTitle(@jakarta.annotation.Nullable String title) { } + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { + this.expiresAt = expiresAt; + return this; + } + + /** + * 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. + * @return expiresAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getExpiresAt() { + return expiresAt; + } + + + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { + this.expiresAt = expiresAt; + } + + /** * Return true if this SignatureRequestBulkCreateEmbeddedWithTemplateRequest object is equal to o. */ @@ -517,12 +547,13 @@ public boolean equals(Object o) { Objects.equals(this.signingRedirectUrl, signatureRequestBulkCreateEmbeddedWithTemplateRequest.signingRedirectUrl) && Objects.equals(this.subject, signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode) && - Objects.equals(this.title, signatureRequestBulkCreateEmbeddedWithTemplateRequest.title); + Objects.equals(this.title, signatureRequestBulkCreateEmbeddedWithTemplateRequest.title) && + Objects.equals(this.expiresAt, signatureRequestBulkCreateEmbeddedWithTemplateRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(templateIds, clientId, signerFile, signerList, allowDecline, ccs, customFields, message, metadata, signingRedirectUrl, subject, testMode, title); + return Objects.hash(templateIds, clientId, signerFile, signerList, allowDecline, ccs, customFields, message, metadata, signingRedirectUrl, subject, testMode, title, expiresAt); } @Override @@ -542,6 +573,7 @@ public String toString() { sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); } @@ -797,6 +829,25 @@ public Map createFormData() throws ApiException { map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); } } + if (expiresAt != null) { + if (isFileTypeOrListOfFiles(expiresAt)) { + fileTypeFound = true; + } + + if (expiresAt.getClass().equals(java.io.File.class) || + expiresAt.getClass().equals(Integer.class) || + expiresAt.getClass().equals(String.class) || + expiresAt.getClass().isEnum()) { + map.put("expires_at", expiresAt); + } else if (isListOfFile(expiresAt)) { + for(int i = 0; i< getListSize(expiresAt); i++) { + map.put("expires_at[" + i + "]", getFromList(expiresAt, i)); + } + } + else { + map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java index 1efde34..000984a 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java @@ -53,7 +53,8 @@ SignatureRequestBulkSendWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, SignatureRequestBulkSendWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestBulkSendWithTemplateRequest.JSON_PROPERTY_TEST_MODE, - SignatureRequestBulkSendWithTemplateRequest.JSON_PROPERTY_TITLE + SignatureRequestBulkSendWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestBulkSendWithTemplateRequest.JSON_PROPERTY_EXPIRES_AT }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -110,6 +111,10 @@ public class SignatureRequestBulkSendWithTemplateRequest { @jakarta.annotation.Nullable private String title; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable + private Integer expiresAt; + public SignatureRequestBulkSendWithTemplateRequest() { } @@ -493,6 +498,31 @@ public void setTitle(@jakarta.annotation.Nullable String title) { } + public SignatureRequestBulkSendWithTemplateRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { + this.expiresAt = expiresAt; + return this; + } + + /** + * 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. + * @return expiresAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getExpiresAt() { + return expiresAt; + } + + + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { + this.expiresAt = expiresAt; + } + + /** * Return true if this SignatureRequestBulkSendWithTemplateRequest object is equal to o. */ @@ -517,12 +547,13 @@ public boolean equals(Object o) { Objects.equals(this.signingRedirectUrl, signatureRequestBulkSendWithTemplateRequest.signingRedirectUrl) && Objects.equals(this.subject, signatureRequestBulkSendWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestBulkSendWithTemplateRequest.testMode) && - Objects.equals(this.title, signatureRequestBulkSendWithTemplateRequest.title); + Objects.equals(this.title, signatureRequestBulkSendWithTemplateRequest.title) && + Objects.equals(this.expiresAt, signatureRequestBulkSendWithTemplateRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(templateIds, signerFile, signerList, allowDecline, ccs, clientId, customFields, message, metadata, signingRedirectUrl, subject, testMode, title); + return Objects.hash(templateIds, signerFile, signerList, allowDecline, ccs, clientId, customFields, message, metadata, signingRedirectUrl, subject, testMode, title, expiresAt); } @Override @@ -542,6 +573,7 @@ public String toString() { sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); } @@ -797,6 +829,25 @@ public Map createFormData() throws ApiException { map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); } } + if (expiresAt != null) { + if (isFileTypeOrListOfFiles(expiresAt)) { + fileTypeFound = true; + } + + if (expiresAt.getClass().equals(java.io.File.class) || + expiresAt.getClass().equals(Integer.class) || + expiresAt.getClass().equals(String.class) || + expiresAt.getClass().isEnum()) { + map.put("expires_at", expiresAt); + } else if (isListOfFile(expiresAt)) { + for(int i = 0; i< getListSize(expiresAt); i++) { + map.put("expires_at[" + i + "]", getFromList(expiresAt, i)); + } + } + else { + map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java index 6dc29fb..f42766a 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java @@ -56,7 +56,8 @@ SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, - SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS + SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_EXPIRES_AT }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -121,6 +122,10 @@ public class SignatureRequestCreateEmbeddedWithTemplateRequest { @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable + private Integer expiresAt; + public SignatureRequestCreateEmbeddedWithTemplateRequest() { } @@ -570,6 +575,31 @@ public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean popul } + public SignatureRequestCreateEmbeddedWithTemplateRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { + this.expiresAt = expiresAt; + return this; + } + + /** + * 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. + * @return expiresAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getExpiresAt() { + return expiresAt; + } + + + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { + this.expiresAt = expiresAt; + } + + /** * Return true if this SignatureRequestCreateEmbeddedWithTemplateRequest object is equal to o. */ @@ -596,12 +626,13 @@ public boolean equals(Object o) { Objects.equals(this.subject, signatureRequestCreateEmbeddedWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestCreateEmbeddedWithTemplateRequest.testMode) && Objects.equals(this.title, signatureRequestCreateEmbeddedWithTemplateRequest.title) && - Objects.equals(this.populateAutoFillFields, signatureRequestCreateEmbeddedWithTemplateRequest.populateAutoFillFields); + Objects.equals(this.populateAutoFillFields, signatureRequestCreateEmbeddedWithTemplateRequest.populateAutoFillFields) && + Objects.equals(this.expiresAt, signatureRequestCreateEmbeddedWithTemplateRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(templateIds, clientId, signers, allowDecline, ccs, customFields, files, fileUrls, message, metadata, signingOptions, subject, testMode, title, populateAutoFillFields); + return Objects.hash(templateIds, clientId, signers, allowDecline, ccs, customFields, files, fileUrls, message, metadata, signingOptions, subject, testMode, title, populateAutoFillFields, expiresAt); } @Override @@ -623,6 +654,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); } @@ -916,6 +948,25 @@ public Map createFormData() throws ApiException { map.put("populate_auto_fill_fields", JSON.getDefault().getMapper().writeValueAsString(populateAutoFillFields)); } } + if (expiresAt != null) { + if (isFileTypeOrListOfFiles(expiresAt)) { + fileTypeFound = true; + } + + if (expiresAt.getClass().equals(java.io.File.class) || + expiresAt.getClass().equals(Integer.class) || + expiresAt.getClass().equals(String.class) || + expiresAt.getClass().isEnum()) { + map.put("expires_at", expiresAt); + } else if (isListOfFile(expiresAt)) { + for(int i = 0; i< getListSize(expiresAt); i++) { + map.put("expires_at[" + i + "]", getFromList(expiresAt, i)); + } + } + else { + map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java index f007ed7..ea93607 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java @@ -58,7 +58,8 @@ SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TEST_MODE, - SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TITLE + SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_EXPIRES_AT }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -132,6 +133,10 @@ public class SignatureRequestSendWithTemplateRequest { @jakarta.annotation.Nullable private String title; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable + private Integer expiresAt; + public SignatureRequestSendWithTemplateRequest() { } @@ -635,6 +640,31 @@ public void setTitle(@jakarta.annotation.Nullable String title) { } + public SignatureRequestSendWithTemplateRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { + this.expiresAt = expiresAt; + return this; + } + + /** + * 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. + * @return expiresAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getExpiresAt() { + return expiresAt; + } + + + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { + this.expiresAt = expiresAt; + } + + /** * Return true if this SignatureRequestSendWithTemplateRequest object is equal to o. */ @@ -663,12 +693,13 @@ public boolean equals(Object o) { Objects.equals(this.signingRedirectUrl, signatureRequestSendWithTemplateRequest.signingRedirectUrl) && Objects.equals(this.subject, signatureRequestSendWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestSendWithTemplateRequest.testMode) && - Objects.equals(this.title, signatureRequestSendWithTemplateRequest.title); + Objects.equals(this.title, signatureRequestSendWithTemplateRequest.title) && + Objects.equals(this.expiresAt, signatureRequestSendWithTemplateRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title); + return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, expiresAt); } @Override @@ -692,6 +723,7 @@ public String toString() { sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1023,6 +1055,25 @@ public Map createFormData() throws ApiException { map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); } } + if (expiresAt != null) { + if (isFileTypeOrListOfFiles(expiresAt)) { + fileTypeFound = true; + } + + if (expiresAt.getClass().equals(java.io.File.class) || + expiresAt.getClass().equals(Integer.class) || + expiresAt.getClass().equals(String.class) || + expiresAt.getClass().isEnum()) { + map.put("expires_at", expiresAt); + } else if (isListOfFile(expiresAt)) { + for(int i = 0; i< getListSize(expiresAt); i++) { + map.put("expires_at[" + i + "]", getFromList(expiresAt, i)); + } + } + else { + map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/templates/libraries/jersey3/api.mustache b/templates/libraries/jersey3/api.mustache index 0c0e2c8..85a1af4 100644 --- a/templates/libraries/jersey3/api.mustache +++ b/templates/libraries/jersey3/api.mustache @@ -58,6 +58,7 @@ public class {{classname}} { /** * {{summary}} * {{notes}} + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java {{#allParams}} * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}} @@ -99,6 +100,7 @@ public class {{classname}} { /** * {{summary}} * {{notes}} + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java {{#allParams}} * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}} @@ -269,6 +271,7 @@ public class {{classname}} { /** * Execute {{operationId}} request + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java {{#returnType}}* @return {{.}}{{/returnType}} * @throws ApiException if fails to make API call {{#responses.0}} @@ -290,6 +293,7 @@ public class {{classname}} { /** * Execute {{operationId}} request with HTTP info returned + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java * @return ApiResponse<{{returnType}}{{^returnType}}Void{{/returnType}}> * @throws ApiException if fails to make API call {{#responses.0}} @@ -316,6 +320,7 @@ public class {{classname}} { /** * {{summary}} * {{notes}}{{#pathParams}} + * Example: https://github.com/hellosign/dropbox-sign-java/blob/main/examples/{{operationIdCamelCase}}Example.java * @param {{paramName}} {{description}} (required){{/pathParams}} * @return {{operationId}}Request * @throws ApiException if fails to make API call diff --git a/test_fixtures/FaxGetResponse.json b/test_fixtures/FaxGetResponse.json index 0d668e0..f4bf435 100644 --- a/test_fixtures/FaxGetResponse.json +++ b/test_fixtures/FaxGetResponse.json @@ -24,7 +24,8 @@ "status_code": "success" } ], - "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + "test_mode": false } } } diff --git a/test_fixtures/FaxListResponse.json b/test_fixtures/FaxListResponse.json index d0ce7fe..9dbdb96 100644 --- a/test_fixtures/FaxListResponse.json +++ b/test_fixtures/FaxListResponse.json @@ -31,7 +31,8 @@ "status_code": "success" } ], - "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" + "files_url": "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2", + "test_mode": false } ] }